日志框架介绍
在开发过程中，我们经常使用到日志来进行排查问题，我们使用的日志框架都是由2部分组成（日志API + 日志实现）
日志API（及日志抽象层）有：SLF4j(Simple Logging Facade for Java)、JCL(Jakarta Commons Logging) 、jboss-logging
日志实现有：Log4j JUL(java.util.logging) Log4j2 Logback
其中slf4j 和 log4j 与 logback 是由同一个人开发。logback是log4j的升级扩展版本
SpringBoot：底层是Spring框架，Spring框架默认是用JCL;
当是SpringBoot选用 slf4j和 logback; logback的使用可以参考：【Log】logback实现每个类和包自定义级别输出
SLF4j使用
可以参考官网：http://www.slf4j.org
使用方法很简单，引入相关jar包，代码调用即可，参考：【Log】SLF4J简单入门
SLF4j + 日志实现
SLF4j + 日志实现 使用结构图如下：
绿色代表自己自己的应用，浅蓝色代表SLF4j接口，蓝色就是具体实现，灰色是jar包
第一列，应用使用slf4j接口，没有日志实现，那么是没有输出内容的
第二列，应用调用slf4j接口，slf4j接口具体实现是logback，实际工作就是有logback进行日志输出
第三列，应用调用slf4j接口，slf4j接口与log4j具体实现之间，多了一层适配层，实际工作是有log4j通过适配层实现的
SLF4j 实现统一日志记录
在实际开发中，我们可能会引用到很多jar包，某些组件依赖于SLF4J以外的日志API，可以通过SLF4j来实现统一日志记录
实现统一日志记录图例如下：
绿色代表自己自己的应用，浅蓝色代表SLF4j接口，蓝色就是具体实现，灰色是jar包
左上图1，应用调用slf4j接口，slf4j接口具体实现是logback，实际工作就是有logback进行日志输出，应用某些组件依赖于SLF4J以外的日志API（Commons loggin、log4j、java.util.loggin）
可以通过一个转换包（桥接包）将SLF4J以外的日志API转换成SLF4JAPI进行日志记录即可。
其他几图分别是slf4j与其他实现jar包的统一日志记录方法
SpringBoot日志
SpringBoot日志关系
SpringBoot启动依赖spring‐boot‐starter
1 <dependency> 2 <groupId>org.springframework.boot</groupId> 3 <artifactId>spring‐boot‐starter</artifactId> 4 </dependency>
启动依赖spring‐boot‐starter又依赖了spring-boot-starter-logging
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也把其他的日志都替换成了slf4j
3、中间替换包（桥接包），通过查看其中代码可以发现LogFactory使用的是SLF4JLogFactory
1 LogFactory logFactory = new SLF4JLogFactory();
4、如果要引入其他框架?一定要把这个框架的默认日志依赖移除掉
<dependency> <groupId>org.springframework</groupId> <artifactId>spring‐core</artifactId> <exclusions> <exclusion> <groupId>commons‐logging</groupId> <artifactId>commons‐logging</artifactId> </exclusion> </exclusions> </dependency>
SpringBoot日志使用
1、简单测试示例
1 package com.test.springboot; 2 3 import org.junit.Test; 4 import org.junit.runner.RunWith; 5 import org.slf4j.Logger; 6 import org.slf4j.LoggerFactory; 7 import org.springframework.beans.factory.annotation.Autowired; 8 import org.springframework.boot.test.context.SpringBootTest; 9 import org.springframework.context.ApplicationContext; 10 import org.springframework.test.context.junit4.SpringRunner; 11 12 /** 13 * SpringBoot单元测试 14 * <p> 15 * 可以在测试期间很方便的类似编码一样的自动注入 16 */ 17 @RunWith(SpringRunner.class) 18 @SpringBootTest 19 public class TestSpringbootApplicationTest { 20 21 22 @Autowired 23 ApplicationContext context; 24 25 //记录器 26 Logger logger = LoggerFactory.getLogger(getClass()); 27 28 @Test 29 public void contextLoads() { 30 //System.out.println(); 31 //日志的级别; 32 //由低到高 trace<debug<info<warn<error //可以调整输出的日志级别;日志就只会在这个级别以以后的高级别生效 logger.trace("这是trace日志..."); 33 logger.debug("这是debug日志..."); //SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别;root 34 logger.info("这是info日志..."); 35 logger.warn("这是warn日志..."); 36 logger.error("这是error日志..."); 37 } 38 39 40 }
运行：
2019-12-08 11:00:17.722 INFO 44381 --- [ main] c.t.s.TestSpringbootApplicationTest : Started TestSpringbootApplicationTest in 4.076 seconds (JVM running for 7.197)
2019-12-08 11:00:18.033 INFO 44381 --- [ main] c.t.s.TestSpringbootApplicationTest : 这是info日志...
2019-12-08 11:00:18.033 WARN 44381 --- [ main] c.t.s.TestSpringbootApplicationTest : 这是warn日志...
2019-12-08 11:00:18.033 ERROR 44381 --- [ main] c.t.s.TestSpringbootApplicationTest : 这是error日志...
2019-12-08 11:00:18.050 INFO 44381 --- [ Thread-2] o.s.s.concurrent.ThreadPoolTaskExecutor : Shutting down ExecutorService 'applicationTaskExecutor' 输出以下项目：
- 日期和时间：毫秒精度，易于排序。
- 日志级别：
ERROR，WARN，INFO，DEBUG，或TRACE。 - 进程ID。
- 一个
---分离器来区分实际日志消息的开始。 - 线程名称：用方括号括起来（对于控制台输出可能会被截断）。
- 记录器名称：这通常是源类名称（通常缩写）。
- 日志消息。
2、日志级别
通过使用TRACE，DEBUG，INFO，WARN，ERROR，FATAL或OFF中的其中之一，可以在Spring中设置所有记录器级别Environment（例如，在中application.properties）。该记录器可以通过使用被配置。logging.level.<logger-name>=<level>levelrootlogging.level.root
以下示例显示了中的潜在日志记录设置application.properties：
1 logging.level.root=warn 2 logging.level.org.springframework.web=debug 3 logging.level.org.hibernate=error
3、文件输出
默认情况下，Spring Boot仅记录到控制台，不写日志文件。如果除了控制台输出外还想写日志文件，则需要设置一个logging.file或logging.path属性（例如，在中application.properties）。
下表显示了如何logging.*一起使用这些属性：
（没有） | （没有） | 仅控制台记录。 | |
指定文件名 | （没有）/有 |
| 写入指定的日志文件。名称可以是确切位置，也可以是相对于当前目录的位置。 |
（没有） | 具体目录 |
| 写入 |
ERROR-level，WARN-level和INFO-level消息。可以使用该logging.file.max-size属性更改大小限制。除非logging.file.max-history已设置属性，否则以前旋转的文件将无限期存档。1 logging.level.com.test=debug 2 3 #logging.path= 4 # 不指定路径在当前项目下生成springboot.log日志 5 # 可以指定完整的路径; 6 # logging.file=G:/springboot.log 7 8 # 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹;使用 spring.log 作为默认文件 9 # logging.path=/Users/h__d/Desktop 10 11 # 时间日志格式 12 logging.pattern.dateformat=yyyy‐MM 13 14 # 在控制台输出的日志的格式 15 logging.pattern.console=%d{yyyy‐MM‐dd} [%thread] %level %logger{50} ‐ %msg%n 16 # 指定文件中日志输出的格式 17 logging.pattern.file=%d === [%thread] === %level === %logger{50} ==== %msg%n
Logback |
|
Log4j2 |
|
JDK (Java Util Logging) |
|
logback.xml:直接就被日志框架识别了;
logback-spring.xml:日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot 的高级Profile功能
高级Profile功能
1 <springProfilename="staging"> 2 <!‐‐ configuration to be enabled when the "staging" profile is active ‐‐> 可以指定某段配置只在某个环境下生效 3 </springProfile>
使用方法，如在logback.xml中如下配置：
1 <appender name="stdout"class="ch.qos.logback.core.ConsoleAppender"> 2 <!‐‐ 3 日志输出格式: %d表示日期时间， 4 %thread表示线程名， 5 %level:级别 6 %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg:日志消息， 7 %n是换行符 8 ‐‐> 9 <layout class="ch.qos.logback.classic.PatternLayout"> 10 <springProfile name="dev"> 11 <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %level %logger{50} ‐ %msg%n</pattern> 12 </springProfile> 13 <springProfile name="!dev"> 14 <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %level %logger{50} ‐ %msg%n</pattern> 15 </springProfile> 16 </layout> 17 </appender>
4、切换日志框架
可以按照slf4j的日志适配图，进行相关的切换; slf4j+log4j的方式;
1 <dependency> 2 <groupId>org.springframework.boot</groupId> 3 <artifactId>spring‐boot‐starter‐web</artifactId> 4 <exclusions> 5 <exclusion> 6 <artifactId>logback‐classic</artifactId> 7 <groupId>ch.qos.logback</groupId> 8 </exclusion> 9 <exclusion> 10 <artifactId>log4j‐over‐slf4j</artifactId> 11 <groupId>org.slf4j</groupId> 12 </exclusion> 13 </exclusions> 14 </dependency> 15 <dependency> 16 <groupId>org.slf4j</groupId> 17 <artifactId>slf4j‐log4j12</artifactId> 18 </dependency>