SpringBoot——日志及原理
一、SpringBoot日志
选用 SLF4j（接口）和 logback（实现类），除了上述日志框架，市场上还存在 JUL(java.util.logging)、JCL(Apache Commons Logging)、Log4j、Log4j2、SLF4j、jboss-logging 等。SpringBoot 在框架内部使用JCL，SpringBoot 的 spring-boot-starter-logging 采用了 SLF4j+logback 的形式，SpringBoot 也能自动适配（jul、log4j2、logback）并简化配置。其实 logback 是 log4j 的升级版，因为 log4j 在性能上有缺陷（因为log4j在多线程情况下，会竞争 Logger的锁），且 SLF4j 也是 logback 的开发者开发的一个日志接口（日志门面）。
| 日志门面 | 日志实现 |
|
JCL（Jakarta Commons Logging） SLF4J（Simple Logging Facade for Java） Jobss-logging |
Log4j JUL（Java Util Logging） Log4j2 Logback |
二、SLF4j 使用
【1】以后开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象类层里面的方法。
● 给系统里面导入 slf4j 的 jar和 logback 的实现 jar，Java 类中的使用如下所示：很常用
1 import org.slf4j.Logger; 2 import org.slf4j.LoggerFactory; 3 4 public class HelloWorld { 5 public static void main(String[] args) { 6 Logger logger = LoggerFactory.getLogger(HelloWorld.class);//记录器 7 logger.info("Hello World"); 8 } 9 }
● 根据 SLF4J抽象类，提供实现类的时候，SLF4j 官方提供的配置逻辑如下所示，有的需要加入整合的jar包。
【2】常见问题：同一个系统中，包涵多种框架可能就会使用多种日志记录（slf4j+logback）、Spring（commons-logging）、Hibernate（Jboss-logging）、MyBatis等，如果我们要统一使用slf4j记录日志，思想如下：
✔ 将系统中其他日志框架先排除出去；
✔ 用中间包替换原有的日志框架；
✔ 我们导入 slf4j唯一日志的实现；具体可见下方，官方给出的图解：
三、Spring Boot日志关系
测试 springBoot 的日志使用，首先引入日志的 starter启动器。
☞ 首先我们查看下 pom.xml中的依赖关系：右键——>Diagrams——>Show Dependencies... 
☞ 可以查看到我们我们使用最多的启动器：spring‐boot‐starter
1 <dependency> 2 <groupId>org.springframework.boot</groupId> 3 <artifactId>spring‐boot‐starter</artifactId> 4 </dependency>
☞ 而我们使用的日志启动器 spring‐boot‐starter‐logging 依赖于 spring‐boot‐starter，SpringBoot 使用它来做日志功能：
1 <dependency> 2 <groupId>org.springframework.boot</groupId> 3 <artifactId>spring‐boot‐starter‐logging</artifactId> 4 </dependency>
☞ 而spring‐boot‐starter‐logging 启动器的底层依赖实现关系如下：
总结：1）、SpringBoot 底层也是使用 slf4j+logback 的方式进行日志记录的。
2）、SpringBoot 也考虑到了其他日志，将他们都替换成了 slf4通过替换包。
3）、中间替换包？我们通过引入的jar包查看究竟：
4）、如果我们引入了其他框架？一定要把这个框架的默认日志依赖移除掉。我们点进 spring‐boot‐starter‐logging 会发现如下SpringBoot 引入 springframework 依赖时自动排除了 commons-logging 依赖，避免冲突，我们也应如此。
1 <dependency> 2 <groupId>org.springframework</groupId> 3 <artifactId>spring‐core</artifactId> 4 <exclusions> 5 <exclusion> 6 <groupId>commons‐logging</groupId> 7 <artifactId>commons‐logging</artifactId> 8 </exclusion> 9 </exclusions> 10 </dependency>
总结：SpringBoot 能够自动适配所有的日志，而且底层使用 slf4j+logback 的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉。
四、日志使用
【1】默认配置：SpringBoot 已经帮我们配置好了日志，日志级别=info。
1 //日志记录器 2 Logger logger = LoggerFactory.getLogger(getClass()); 3 4 @Test 5 public void contextLoads() { 6 //日志的级别：优先级trace<debug<info<warn<error 7 //可以调整输出的日志级别；日志就只会在这个级别及以后的高级别生效 8 logger.trace("这是跟踪日志"); 9 logger.debug("这是调试日志"); 10 //SpringBoot默认使用的是 info级别的;root级别 11 logger.info("这是自定义"); 12 logger.warn("这是警告日志"); 13 logger.error("这是错误日志"); 14 }
【2】修改日志级别，可以细化到给包分配级别，配置文件中配置如下：
1 #修改打印级别 == 可以细化到包级别 2 logging.level.com=trace 3 #下面path与file都不指定时，日志输出到控制台，两个都指定时，file生效 4 #指定目录，文件名默认spring.log中，如下是在当前磁盘根路径下创建var文件和里面的log文件。 5 logging.path=/var/log 6 #指定文件名 当前项目下生成springboot.log日志，也可以指定到本地文件中d:/springboot.log等 7 logging.file=springboot.log 8 #在控制台日志输入的格式 9 logging.pattern.console=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n 10 #在文件中日志输出的格式 11 #日志输出格式： 12 # %d表示日期时间， 13 # %thread表示线程名， 14 # %‐5level：级别从左显示5个字符宽度 15 # %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 16 # %msg：日志消息， 17 # %n是换行符 18 logging.pattern.file=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n
【3】SpringBoot 的默认日志配置位于 spring-boot-1.5.17.RELEASE.jar：org.springframework.boot：logging 文件，例如查看logback 文件夹中的 base.xml 和 defaults.xml。
1 <!-- base.xml部分内容 --> 2 <included> 3 <include resource="org/springframework/boot/logging/logback/defaults.xml" /> 4 <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/> 5 <include resource="org/springframework/boot/logging/logback/console-appender.xml" /> 6 <include resource="org/springframework/boot/logging/logback/file-appender.xml" /> 7 <!-- 默认级别 --> 8 <root level="INFO"> 9 <appender-ref ref="CONSOLE" /> 10 <appender-ref ref="FILE" /> 11 </root> 12 </included>
【4】如果觉得日志配置不够用，客户可以自己指定配置：给类路径下（resource）放每个日志框架自己定义的配置文件即可（如下名称的日志文件），这样 SpringBoot 就不适用默认配置。可以参考 SpringBoot 官网中的 logging模块。
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!-- 3 scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 4 scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。 5 debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 6 --> 7 <configuration scan="false" scanPeriod="60 seconds" debug="false"> 8 <!-- 定义日志的根目录 --> 9 <property name="LOG_HOME" value="/app/log" /> 10 <!-- 定义日志文件名称 --> 11 <property name="appName" value="atguigu-springboot"></property> 12 <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 --> 13 <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> 14 <!-- 15 日志输出格式： 16 %d表示日期时间， 17 %thread表示线程名， 18 %-5level：级别从左显示5个字符宽度 19 %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 20 %msg：日志消息， 21 %n是换行符 22 --> 23 <layout class="ch.qos.logback.classic.PatternLayout"> 24 <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> 25 </layout> 26 </appender> 27 28 <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 --> 29 <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"> 30 <!-- 指定日志文件的名称 --> 31 <file>${LOG_HOME}/${appName}.log</file> 32 <!-- 33 当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名 34 TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。 35 --> 36 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 37 <!-- 38 滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 39 %i：当文件大小超过maxFileSize时，按照i进行文件滚动 40 --> 41 <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern> 42 <!-- 43 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动， 44 且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是， 45 那些为了归档而创建的目录也会被删除。 46 --> 47 <MaxHistory>365</MaxHistory> 48 <!-- 49 当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy 50 --> 51 <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> 52 <maxFileSize>100MB</maxFileSize> 53 </timeBasedFileNamingAndTriggeringPolicy> 54 </rollingPolicy> 55 <!-- 日志输出格式： --> 56 <layout class="ch.qos.logback.classic.PatternLayout"> 57 <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern> 58 </layout> 59 </appender> 60 61 <!-- 62 logger主要用于存放日志对象，也可以定义日志类型、级别 63 name：表示匹配的logger类型前缀，也就是包的前半部分 64 level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR 65 additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出， 66 false：表示只用当前logger的appender-ref，true： 67 表示当前logger的appender-ref和rootLogger的appender-ref都有效 68 --> 69 <!-- hibernate logger --> 70 <logger name="com.atguigu" level="debug" /> 71 <!-- Spring framework logger --> 72 <logger name="org.springframework" level="debug" additivity="false"></logger> 73 74 <!-- 75 root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应， 76 要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 77 --> 78 <root level="info"> 79 <appender-ref ref="stdout" /> 80 <appender-ref ref="appLogAppender" /> 81 </root> 82 </configuration>
● 当命名中带有 spring 时，例如：logback-spring.xml：日志框架就不直接加载日志的配置项，由 SpringBoot解析日志配置，但可以使用 SpringBoot的高级 springProfile功能，如下配置。如果不带 spring使用 springProfile标签时就会出错。
1 <layout class="ch.qos.logback.classic.PatternLayout"> 2 <!-- 可以指定以哪种形式运行环境 --> 3 <springProfile name="dev"> 4 <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level%logger{50} ‐ %msg%n</pattern> 5 </springProfile> 6 <springProfile name="!dev"> 7 <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level%logger{50} ‐ %msg%n</pattern> 8 </springProfile> 9 </layout>
五、切换日志框架
根据官方文档如下配置：可以看出首先排除 logging启动器，依赖 log4j2的启动器即可。（排除：可以通过 pom.xml的依赖视图，右键Exclude）
1 <dependency> 2 <groupId>org.springframework.boot</groupId> 3 <artifactId>spring-boot-starter-web</artifactId> 4 </dependency> 5 <dependency> 6 <groupId>org.springframework.boot</groupId> 7 <artifactId>spring-boot-starter</artifactId> 8 <exclusions> 9 <exclusion> 10 <groupId>org.springframework.boot</groupId> 11 <artifactId>spring-boot-starter-logging</artifactId> 12 </exclusion> 13 </exclusions> 14 </dependency> 15 <dependency> 16 <groupId>org.springframework.boot</groupId> 17 <artifactId>spring-boot-starter-log4j2</artifactId> 18 </dependency>
六、按天分类日志
logback-spring.xml 配置如下：
1 <!--按天生成日志--> 2 <appender name="logFile" class="ch.qos.logback.core.rolling.RollingFileAppender"> 3 <Prudent>true</Prudent> 4 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 5 <FileNamePattern> applog/%d{yyyy-MM-dd}/%d{yyyy-MM-dd}.log </FileNamePattern> 6 </rollingPolicy> 7 <layout class="ch.qos.logback.classic.PatternLayout"> 8 <Pattern> %d{yyyy-MM-dd HH:mm:ss} -%msg%n </Pattern> 9 </layout> 10 </appender>
