SpringBoot的日志框架

Spring Boot的日志框架：

简介

在项目的开发中，日志是必不可少的一个记录事件的组件，所以也会相应的在项目中实现和构建我们所需要的日志框架。

而市面上常见的日志框架有很多，比如：JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等，我们该如何选择呢？

通常情况下，日志是由一个抽象层+实现层的组合来搭建的。

日志门面（日志的抽象层）	日志实现
~~JCL（Jakarta Commons Logging）~~ SLF4j（Simple Logging Facade for Java） ~~jboss-logging~~	Log4j JUL（java.util.logging） Log4j2 Logback

SpringBoot：底层是Spring框架，Spring框架默认是用JCL；

SpringBoot选用 SLF4j和logback；

SLF4j使用

使用SLF4j https://www.slf4j.org

在开法过程中,日志记录方法的调用不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；

@Test  public static void main(String[] args) {      Logger logger = LoggerFactory.getLogger(HelloWorld.class);      logger.info("Hello World");  }

1	20:33:41.673 [main] INFO com.hph.springboot.HelloWorld - Hello World

每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件；

遗留问题

a（slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、其他框架

统一日志记录，即使是别的框架和如何和我一起统一使用slf4j进行输出呢?

如何让系统中所有的日志都统一到slf4j；

将系统中其他日志框架先排除出去。

用中间包来替换原有的日志框架。

我们导入slf4j其他的实现。

日志关系

引入springboot-logging

1234	<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId></dependency>

引入maven以来后

由上图我们可以知道在SpringBoot底层也是使用slf4j+logback的方式进行日志记录、SpringBoot也把其他的日志都替换成了slf4j；在者中间发生了什么呢？

原来是包被替换掉了

如果我们要引入其他框架？一定要把这个框架的默认日志依赖移除掉，Spring框架用的是commons-logging；

12345678910

<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的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

12345678910111213141516

@Testpublic  void contextLoads() {    //System.out.println();    Logger logger = LoggerFactory.getLogger(getClass());

    //日志的级别；    //由低到高   trace<debug<info<warn<error    //可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效    logger.trace("这是trace日志...");    logger.debug("这是debug日志...");    //SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；root级别    logger.info("这是info日志...");    logger.warn("这是warn日志...");    logger.error("这是error日志...");}

2019-03-28 21:15:40.771  INFO 6056 --- [           main] c.h.s.SpringBootLoggingApplicationTests  : 这是info日志...2019-03-28 21:15:40.771  WARN 6056 --- [           main] c.h.s.SpringBootLoggingApplicationTests  : 这是warn日志...2019-03-28 21:15:40.772 ERROR 6056 --- [           main] c.h.s.SpringBootLoggingApplicationTests  : 这是error日志...

logging.file	logging.path	Example	Description
(none)	(none)		只在控制台输出
指定文件名	(none)	my.log	输出日志到my.log文件
(none)	指定目录	/var/log	输出到指定目录的 spring.log 文件中

给类路径下放上每个日志框架自己的配置文件即可；SpringBoot就不使用他默认配置的了

Logging System	Customization
Logback	logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)	logging.properties

输出格式

123456789

  日志输出格式：%d表示日期时间，%thread表示线程名，%-5level：级别从左显示5个字符宽度%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg：日志消息，%n是换行符  -->  %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

配置格式

1234567891011

logging.level.com.hph.springboot=trace

#loging.path=#不指定路径在当前目录下生成springboot.log日志#可以指定完整的路径logging.file=D:/spring-boot.log

#在控制台输入的日志的格式logging.pattern.console=    %d{yyyy-MM-dd} =====> [%thread] %-5level %logger{50} =====> %msg%n#指定文件中日志我输入的格式logging.pattern.file=  %d{yyyy-MM-dd} ----------> [%thread] ---------->%-5level ----------> %logger{50} ----------> %msg%n

控制台

文件

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

指定配置

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

1234	<springProfile name="staging"> <!-- configuration to be enabled when the "staging" profile is active --> 可以指定某段配置只在某个环境下生效</springProfile>

如：

如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误

no applicable action for [springProfile]因此我们可以把logback.xml重命名为logback-spring.xml

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788

<?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="D:/log" />    <!-- 定义日志文件名称 -->    <property name="appName" value="hph-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 < ERROR       additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，       false：表示只用当前logger的appender-ref，true：        表示当前logger的appender-ref和rootLogger的appender-ref都有效    -->    <!-- hibernate logger -->    <logger name="com.hph" level="debug" />    <!-- Spring framework logger -->    <logger name="org.springframework" level="debug" additivity="false"></logger>

    <!--     root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。     -->    <root level="info">        <appender-ref ref="stdout" />        <appender-ref ref="appLogAppender" />    </root></configuration>

切换日志框架

1234567891011121314151617181920

<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>        </dependency>

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

123456789101112131415161718192021222324

### set log levels ###log4j.rootLogger = debug ,stdout ,  D ,  E

### 输出到控制台 ###log4j.appender.stdout = org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.Target = System.outlog4j.appender.stdout.layout = org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} ======> %5p ==> %c{ 1 }:%L  --- %m%n

#### 输出到日志文件 ###log4j.appender.D = org.apache.log4j.DailyRollingFileAppenderlog4j.appender.D.File = D:/log/springboot-log4j.loglog4j.appender.D.Append = truelog4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志log4j.appender.D.layout = org.apache.log4j.PatternLayoutlog4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n##### 保存异常信息到单独文件 ####log4j.appender.D = org.apache.log4j.DailyRollingFileAppender#log4j.appender.D.File = logs/error.log ## 异常日志文件名#log4j.appender.D.Append = true#log4j.appender.D.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!#log4j.appender.D.layout = org.apache.log4j.PatternLayout#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

控制台

日志

切换为log4j2

123456789101112131415

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

<dependency>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-log4j2</artifactId></dependency>

配置

123456789101112131415161718192021222324252627282930313233343536373839

<?xml version="1.0" encoding="UTF-8"?><!--    Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出。--><!--    monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数。--><configuration status="error" monitorInterval="30">    <!--先定义所有的appender-->    <appenders>        <!--这个输出控制台的配置-->        <Console name="Console" target="SYSTEM_OUT">            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->            <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>            <!--这个都知道是输出日志的格式-->            <PatternLayout pattern="%d{HH:mm:ss.SSS}  ==> %-5level %class{36} %L %M ===> %msg%xEx%n"/>        </Console>        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->        <File name="log" fileName="D:/log/log4j2-spring.log" append="false">            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>        </File>        <!-- 这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->        <RollingFile name="RollingFile" fileName="D:/logs/app.log"                     filePattern="log/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">            <PatternLayout pattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>            <SizeBasedTriggeringPolicy size="50MB"/>            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->            <DefaultRolloverStrategy max="20"/>        </RollingFile>    </appenders>    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->    <loggers>        <!--建立一个默认的root的logger-->        <root level="trace">            <appender-ref ref="RollingFile"/>            <appender-ref ref="Console"/>        </root>    </loggers></configuration>