SpringBoot - 日志选择与实现

【1】常见的日志门面与实现框架

日志门面	实现框架
JCL(Jakarta Commons logging),SLF4J,Jboss logging	Log4j,Log4j2,Logback,JUL(java.util.logging)

其中 SLF4j，Log4j，Logback均为一人所写，Logback是Log4j的升级版，而Log4j2则是Apache借用Log4j的名出的日志框架。

每一个日志的实现框架都有自己的配置文件。日志配置文件还是做成日志实现框架自己本身的配置文件。

Spring框架默认使用（commons-logging）即JCL，Hibernate框架默认使用（jboss-logging）。

【2】SpringBoot默认日志选择

查看SpringBoot依赖结构图：

其日志依赖如下：

如上图所示，SpringBoot默认使用的是SLF4J(日志门面)+logback日志实现框架。

其中jul-to-slf4j表示使用slf4j替换掉java.util.logging，log4j-over-slf4j表示使用slf4j替换掉log4j，jcl-over-slf4j表示使用slf4j替换掉java.commongs.logging。这里使用“替换”或许比较难理解，这是slf4j提供的一种桥接模式，对外统一使用slf4j门面。

具体参考： SLF4J详解

如果引入其他日志框架，一定要把这个框架的默认日志实现依赖移除掉。如Spring默认使用java.commons.logging。

spring-boot-starter-1.5.9.RELEASE.pom文件如下：

 <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-core</artifactId><exclusions><exclusion><groupId>commons-logging</groupId><artifactId>commons-logging</artifactId></exclusion></exclusions></dependency>

SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可。

【3】默认日志配置与实现

SpringBoot中日志等级如下：

日志使用示例如下：

//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {//System.out.println();//日志的级别；//由低到高 trace<debug<info<warn<error//可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效logger.trace("这是trace日志...");logger.debug("这是debug日志...");//SpringBoot默认给我们使用的是info级别的，//没有指定级别的就用SpringBoot默认规定的级别；root级别logger.info("这是info日志...");logger.warn("这是warn日志...");logger.error("这是error日志...");
}

修改默认日志输出：

SpringBoot默认将日志输出到控制台，可以在全局配置文件中通过logging.path或logging.file来指定日志输出位置。

示例如下：

# 不指定路径在当前项目下生成springboot.log日志
# 可以指定完整的路径；
#logging.file=G:/springboot.log# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；
#使用?spring.log 作为默认文件
logging.path=/spring/log

添加自定义日志配置文件

根据具体底层日志实现框架不同，在类路径下添加对应的日志配置文件，如下图所示。

具体示例如下：

【4】logback-spring.xml示例

配置文件实例如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false"><!-- 定义日志的根目录 --><property name="LOG_HOME" value="/app/log" /><!-- 定义日志文件名称 --><property name="appName" value="springboot"></property><!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 --><appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"><!--日志输出格式：%d表示日期时间，%thread表示线程名，%-5level：级别从左显示5个字符宽度%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg：日志消息，%n是换行符--><layout class="ch.qos.logback.classic.PatternLayout"><springProfile name="dev"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern></springProfile><springProfile name="!dev"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern></springProfile></layout></appender><!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 指定日志文件的名称 --><file>${LOG_HOME}/${appName}.log</file><!--当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。--><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!--滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 %i：当文件大小超过maxFileSize时，按照i进行文件滚动--><fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern><!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。--><MaxHistory>365</MaxHistory><!-- 当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy--><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>100MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy></rollingPolicy><!-- 日志输出格式： -->     <layout class="ch.qos.logback.classic.PatternLayout"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern></layout></appender><!-- logger主要用于存放日志对象，也可以定义日志类型、级别name：表示匹配的logger类型前缀，也就是包的前半部分level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERRORadditivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，false：表示只用当前logger的appender-ref，true：表示当前logger的appender-ref和rootLogger的appender-ref都有效--><!-- hibernate logger --><logger name="org.hibernate" level="debug" /><!-- Spring framework logger --><logger name="org.springframework" level="debug" additivity="false"></logger><!-- root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，要么是定义的logger，要么是root（有logger则根据logger否则根据root）判断的关键在于找到这个logger，然后判断这个logger的appender和level。 --><root level="info"><appender-ref ref="stdout" /><appender-ref ref="appLogAppender" /></root>
</configuration>

【5】logback与logback-spring区别

首先呢，二者都可以作为日志框架配置文件正常使用。

其次二者不同如下：

logback.xml：直接就被日志框架识别了；

logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能。

如下所示，在不同环境下使用不同的日志输出格式：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"><layout class="ch.qos.logback.classic.PatternLayout"><springProfile name="dev"><pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level%logger{50} ‐ %msg%n</pattern></springProfile><springProfile name="!dev"><pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level%logger{50} ‐ %msg%n</pattern></springProfile>
</layout>
</appender>

【6】切换日志框架

① 使用slf4j+log4j

默认日志依赖图如下：

如果想要使用slf4j+log4j替换slf4j+logback日志实现，则需要根据slf4j+log4j的日志适配图在pom文件中进行调整。

slf4j+log4j的日志适配图如下：

调整如下：去掉红色框的依赖，还要添加slfj-log412适配层。

配置适配层依赖

   <dependency><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId></dependency>

其中slf4j-log4j12版本由SpringBoot控制，且自动导入了具体实现log4j。

slf4j-log4j12-1.7.25.pom如下：

  <dependencies><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId></dependency><dependency><groupId>log4j</groupId><artifactId>log4j</artifactId></dependency><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><type>test-jar</type><version>${project.version}</version><scope>test</scope></dependency></dependencies>

此时pom日志依赖树如下图：

在类路径下添加log4j的配置文件即可：

② 使用Log4j2

SpringBoot默认使用spring-boot-starter-logging，也可以使用spring-boot-starter-log4j2进行替换。

官网如下：官网地址

修改pom文件：

     <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><!--<exclusions>--><!--<exclusion>--><!--<artifactId>logback-classic</artifactId>--><!--<groupId>ch.qos.logback</groupId>--><!--</exclusion>--><!--<exclusion>--><!--<artifactId>log4j-over-slf4j</artifactId>--><!--<groupId>org.slf4j</groupId>--><!--</exclusion>--><!--</exclusions>--><exclusions><exclusion><artifactId>spring-boot-starter-logging</artifactId><groupId>org.springframework.boot</groupId></exclusion></exclusions></dependency><!--<dependency>--><!--<groupId>org.slf4j</groupId>--><!--<artifactId>slf4j-log4j12</artifactId>--><!--</dependency>--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId></dependency>

此时系统日志依赖树如下：

同样，在类路径下添加自定义的日志配置文件即可。

SpringBoot - 日志选择与实现相关推荐

Spring Boot与日志 ——日志框架、日志配置||SLF4j使用||SpringBoot日志关系||切换日志框架
1.日志框架 SLF4j使用 1.如何在系统中使用SLF4j 以后开发的时候,日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象层里面的方法: 给系统里面导入slf4j的jar和 lo ...
springboot日志配置
SpringBoot日志使用 1. 在springboot中测试打印日志 package com.leon.springboot_log;import org.apache.logging.log4j ...
springboot 日志设计结构
SpringBoot中的日志使用 springboot框架在企业中的使用越来越普遍,springboot日志也是开发中常用的日志系统.springboot默认就是使用SLF4J作为日志门面,logba ...
springboot 日志_Springboot与日志
1.日志框架 JUL.JCL.Jboss-logging.logback.log4j.log4j2.slf4j.... 日志门面(日志的抽象层) 日志实现 JCL(Jakarta Commons Lo ...
SpringBoot 日志配置
SpringBoot 日志的配置如果不配置日志,默认配置是 base.xml 配置日志在 resource 目录下新建 logback.xml <?xml version="1.0 ...
ELK日志分析系统搭建以及springboot日志发送到ELK中
前言安装之前服务器必须装了Java环境,我们这里安装的是7.7.0版本,而且7.7.0版本还必须要求jdk11以上.,最好跟我安装的路径保持一致/usr/local/elk,千万不要在root 安装 ...
springboot日志配置logback-spring.xml
springboot日志配置logback-spring.xml 日志配置文件logback-spring.xml 放在项目src/main/resources目录下 <?xml version ...
SpringBoot日志级别设置
SpringBoot日志级别设置在application.properties配置文件中设置: #设置时区: spring.jackson.date-format=yyyy-MM-dd HH:mm: ...
SLF4j的介绍与使用+SpringBoot日志配置
关于日志日志级别 error > warn > info > debug > trace > fatal trace:级别最低 debug:需要调试时候的关键信息 in ...

SpringBoot - 日志选择与实现

SpringBoot - 日志选择与实现

【1】常见的日志门面与实现框架

【2】SpringBoot默认日志选择

【3】默认日志配置与实现

【4】logback-spring.xml示例

【5】logback与logback-spring区别

【6】切换日志框架

SpringBoot - 日志选择与实现相关推荐

最新文章

热门文章