【Log】（三）Java 中的日志框架 logback、log4j2

短命女 2023-10-01 08:31 16阅读 0赞

[【Log】（一）Java 中的日志框架 JUL、Log4j][Log_Java _ JUL_Log4j]  
[【Log】（二）Java 中的日志框架 JCL、SLF][Log_Java _ JCL_SLF]  
[【Log】（三）Java 中的日志框架 logback、log4j2][Log_Java _ logback_log4j2]

### 1. logback 学习 ###

#### 1.1 logback 介绍 ####

`logback` 是由 log4j 创始人设计的另一个开源日志组件，性能比 `log4j` 好

`logback` 主要分为 3 个模块：

*  `logback-core`：其它两个模块的基础模块
 *  `logback-classic`：它是 `log4j` 的一个改良版本，同时它完整实现了 `slf4j` API
 *  `logback-access`：访问模块与 `Servlet` 容器集成提供通过 http 来访问日志的功能

#### 1.2 快速入门 ####

新建一个 Maven 工程，引入依赖，POM 文件：

<dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.26</version>
    </dependency>
    
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
    </dependency>

1. 入门案例：

public class LogbackTest {
        
    
        public static final Logger LOGGER = LoggerFactory.getLogger(LogbackTest.class);
    
        @Test
        public void testQuick() {
        
            LOGGER.error("error");
            LOGGER.warn("warn");
            LOGGER.info("info");
            LOGGER.debug("debug");
            LOGGER.trace("trace");
        }
    
    }

运行结果如下：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16]  
表明：`logback` 的默认级别是 `debug`。

#### 1.3 配置文件 ####

`logback` 依次读取以下类型的配置文件：

*  logback.groovy
 *  logback-test.xml
 *  logback.xml

如果均不存在，则采用默认配置

1. logback 组件之间的关系

1.  **Logger**：日志记录器。把它关联到应用的对应的 context 上后，主要用于存放日志对象，也可以定义日志类型、级别
2.  **Appender**：用于指定日志输出的目的地。目的地可以是控制台、文件、数据库等
3.  **Layout**：负责把事件转换成字符串，格式化日志信息输出。在 logback 中，Layout 对象被封装成 encoder 中

2. 控制台 Appender

控制台 Appender：将日志信息输出到控制台，并且可以设置一些日志信息。

在 resources 下新建一个 `logback.xml` 配置文件

<?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        
        <property name="pattern" value="[%-5level] %d{yyyy-mm-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"></property>
    
        
        <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
            
            <target>System.err</target>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${pattern}</pattern>
            </encoder>
        </appender>
    
        
        <root level="ALL">
            <appender-ref ref="console"></appender-ref>
        </root>
    </configuration>

> %-5level：日志级别。向左对齐  
> %d\{yyyy-mm-dd HH:mm:ss.SSS\}：日期（格式化）  
> %c：方法名称  
> %M：类名  
> %thread：线程名  
> %m：日志信息  
> %n：换行

配置了配置文件后，运行结果如下：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 1]  
3. 文件 Appender

文件 Appender：将日志信息存放到日志文件中

<?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        
        <property name="pattern" value="[%-5level] %d{yyyy-mm-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"></property>
        <property name="log_dir" value="E:/temp/logs"></property>
    
        
        <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
            
            <target>System.err</target>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${pattern}</pattern>
            </encoder>
        </appender>
    
        
        <appender name="file" class="ch.qos.logback.core.FileAppender">
            
            <file>${log_dir}/logback.log</file>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${pattern}</pattern>
            </encoder>
        </appender>
    
        
        <root level="ALL">
            <appender-ref ref="console"></appender-ref>
            <appender-ref ref="file" />
        </root>
    </configuration>

当然，如果更想直观地看日志，可将日志文件设置成 html 格式：

<appender name="htmlFile" class="ch.qos.logback.core.FileAppender">
        
        <file>${log_dir}/logback.html</file>
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="ch.qos.logback.classic.html.HTMLLayout">
                <pattern>%level%d{yyyy-mm-dd HH:mm:ss.SSS}%c%M%L%thread%m</pattern>
            </layout>
        </encoder>
    </appender>

4. 日志拆分和归档压缩的 Appender

当日志文件较大时，我们不能让日志信息都存储在同一个日志文件里面，所以，我们要将日志信息进行拆分。

<appender name="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        
        <file>${log_dir}/roll_logback.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
        
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            
            <fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd-HH-mm-ss}.log%i.gz</fileNamePattern>
            
            <maxFileSize>1MB</maxFileSize>
        </rollingPolicy>
    </appender>

测试代码：运行一万次

@Test
    public void testQuick() {
        
        for (int i = 0; i < 10000; i++) {
        
            LOGGER.error("error");
            LOGGER.warn("warn");
            LOGGER.info("info");
            LOGGER.debug("debug");
            LOGGER.trace("trace");
        }
    }

运行结果如下：  
![在这里插入图片描述][83284e7b587c49dcb633f6e1a1a51baf.png]  
日志文件拆分规则：日志压缩文件按照秒拆分（精确到秒），当日志文件超过 1 MB 时，日志文件会再次进行拆分，且日志文件名中的 `.log%i.gz` 中的 `i` 就会自加。

5. 日志级别过滤器

其中，

<filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>ERROR</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>

表示：只记录 `ERROR` 级别的日志信息

6. 异步日志

默认情况下，程序运行时，程序和日志记录是同步的。使用异步日志的话，就可以使程序和日志记录不是同步。

<appender name="asyc" class="ch.qos.logback.classic.AsyncAppender">
        
        <appender-ref ref="rollFile"></appender-ref>
    </appender>
    
    
    <root level="ALL">
        <appender-ref ref="console"></appender-ref>
        <appender-ref ref="asyc" />
    </root>

7. 自定义 logger

<root level="ALL">
        <appender-ref ref="console" />
        <appender-ref ref="async" />
    </root>
    
    
    <logger name="com.zzc.log.logback" level="info" additivity="false">
        <appender-ref ref="console" />
    </logger>

上述标签含义：自定义 Logger 对象没有继承 rootLogger 对象，但它用到了 console appender，并且只输出 info 级别以上的日志信息。

logger 标签的属性说明：

*  name：测试类 `LogbackTest` 所在的类名
 *  level：控制日志级别
 *  additivity：自定义 logger 对象是否继承 rootLogger 对象的功能。为 false，表示不继承 root logger 的功能

### 2. log4j2 学习 ###

#### 2.1 log4j2 介绍 ####

`log4j2` 是 `log4j` 的升级版，参考了 `logback` 的优秀的设计，修复了一些问题，因此，带来了一些重大的提升

#### 2.2 快速入门 ####

目前市面上主流的日志门面是 `slf4j`。虽然 `log4j2` 也是日志门面，但它的实现功能非常强大，性能优越。所以，大家一般还是将 `log4j2` 看做是日志的实现。`slf4j + log4j2` 是未来趋势。

新建一个 Maven 工程，引入依赖，POM 文件：

<dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-api</artifactId>
      <version>2.11.1</version>
    </dependency>
    
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.10.0</version>
    </dependency>

入门案例：

public class Log4j2Test {
        
    
        public static final Logger LOGGER = LogManager.getLogger(Log4j2Test.class);
    
        @Test
        public void testQuick() {
        
            LOGGER.fatal("fatal");
            LOGGER.error("error");
            LOGGER.warn("warn");
            LOGGER.info("info");
            LOGGER.debug("debug");
            LOGGER.trace("trace");
        }
    
    }

运行结果后：  
![在这里插入图片描述][d922e816284a49fbbaca343e06cce9f4.png]  
表明：`log4j2` 的日志默认级别为 `error`。

`slf4j + log4j2`：

<dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.26</version>
    </dependency>
    
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-slf4j-impl</artifactId>
      <version>2.10.0</version>
    </dependency>
    
    
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-api</artifactId>
      <version>2.11.1</version>
    </dependency>
    
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.10.0</version>
    </dependency>

测试代码：

public class SlfTest {
        
    
        public static final Logger LOGGER = LoggerFactory.getLogger(SlfTest.class);
    
        @Test
        public void testQuick() {
        
            LOGGER.error("error");
            LOGGER.warn("warn");
            LOGGER.info("info");
            LOGGER.debug("debug");
            LOGGER.trace("trace");
        }
    
    }

#### 2.3 配置文件 ####

`log4j2` 默认加载 classpath 下的 `log4j2.xml` 文件中的配置

<?xml version="1.0" encoding="utf-8" ?>
    
    <Configuration status="warn" monitorInterval="5">
        
        <properties>
            <property name="LOG_HOME" value="E:/temp/logs"></property>
        </properties>
    
        <Appenders>
            <Console name="console" target="SYSTEM_OUT">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n"></PatternLayout>
            </Console>
    
            <File name="file" fileName="${LOG_HOME}/myfile.log">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n"></PatternLayout>
            </File>
            
            <RandomAccessFile name="accessFile" fileName="${LOG_HOME}/myAcclog.log">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n"></PatternLayout>
            </RandomAccessFile>
            
            <RollingFile name="rollingFile" fileName="${LOG_HOME}/myRolllog.log"
                         filePattern="${LOG_HOME}/$${date:yyyy-MM-dd}/myRolllog-%d{yyyy-MM-dd-HH-mm}-%i.log">
                <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n"></PatternLayout>
                
                <Policies>
                    
                    <OnStartupTriggeringPolicy />
                    
                    <SizeBasedTriggeringPolicy size="10 MB" />
                    
                    <TimeBasedTriggeringPolicy />
                </Policies>
                
                <DefaultRolloverStrategy max="30" />
            </RollingFile>
        </Appenders>
    
        <Loggers>
            <Root level="info">
                <AppenderRef ref="console" />
            </Root>
        </Loggers>
    
    </Configuration>

#### 2.4 异步日志 ####

`log4j2` 最大的特点就是 **异步日志**，其性能的提升主要也是从异步日志中受益。

`log4j2` 提供了两种异步方式：`AsyncAppender`、`AsyncLogger`（常用）

【注意】：配置异步日志，需要引入依赖：

<dependency>
      <groupId>com.lmax</groupId>
      <artifactId>disruptor</artifactId>
      <version>3.3.4</version>
    </dependency>

1. AsyncAppender

运行代码后，结果如下：  
![在这里插入图片描述][cc10cf0548674213a1ccd92125719882.png]

2. AsyncAppender  
`AsyncAppender` 才是 `log4j2` 的重头戏，也是官方推荐的方式。有两种方式：全局异步、混合异步。

全局异步

全局异步：所有的日志都是异步地记录，在配置文件上不做任何修改。只需要添加一个 `log4j2.component.properties` 配置文件。

Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector

混合异步

混合异步：可以在应用中同时使用同步日志和异步日志，这使得日志的配置更加灵活

修改 `log4j2.xml`：

运行代码，结果如下：  
![在这里插入图片描述][24439c4520b54057928cadd97e9cb9cc.png]  
表明：没有显示行号。

### 3. SpringBoot 中的日志 ###

SpringBoot 日志也是开发中常用的日志系统。SpringBoot 默认就是使用 `SLF4J` 作为日志门面，`logback` 作为日志实现来记录日志。

#### 3.1 SpringBoot 中的日志设计 ####

SpringBoot 中的日志：

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

依赖结构图：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 2]  
总结：

1.  SpringBoot 底层使用 `logback` 作为日志实现
2.  使用了 `SLF4J` 作为日志门面
3.  将 `JUL` 也转换为了 `SLF4J`
4.  也可以使用 `Log4j2` 作为日志门面，但是最终也是通过 `SLF4J` 调用 `logback`

#### 3.2 SpringBoot 中使用日志 ####

1.入门案例：

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class ApplicationTests {
        
    
    	private static final Logger LOGGER = LoggerFactory.getLogger(ApplicationTests.class);
    
    	@Test
    	public void contextLoads() {
        
    		LOGGER.error("error");
    		LOGGER.warn("warn");
    		LOGGER.info("info");
    		LOGGER.debug("debug");
    		LOGGER.trace("trace");
    	}
    
    }

运行结果：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 3]  
SpringBoot 中的默认日志级别：`info`

2.配置文件：

`application.properties`：

# 指定自定义 Logger 对象日志级别
    logging.level.com.zzc.sbexp=debug
    # 指定控制台输出信息格式
    logging.pattern.console=[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c [%thread] === %m%n
    # 指定日志文件存放的目录，文件名默认为 spring.log
    logging.file=E://temp/springboot.log
    # 指定日志文件消息格式
    logging.pattern.file=[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c [%thread] === %m%n

运行结果如下：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 4]  
3.指定日志配置文件：

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

<table> 
 <thead> 
  <tr> 
   <th>日志框架</th> 
   <th>配置文件</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>logback</td> 
   <td>logback.xml、logback-spring.xml</td> 
  </tr> 
  <tr> 
   <td>log4j2</td> 
   <td>log4j2.xml、log4j2-spring.xml</td> 
  </tr> 
  <tr> 
   <td>jul</td> 
   <td>logging.properties</td> 
  </tr> 
 </tbody> 
</table>

`logback.xml` 直接就被 SpringBoot 识别了。

`logback.xml`：

<?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        
        <property name="pattern" value="[%-5level] %d{yyyy-mm-dd HH:mm:ss.SSS} %c %M %L [%thread] --- %m%n"></property>
        <property name="log_dir" value="E:/temp/logs"></property>
    
        
        <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
            
            <target>System.err</target>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${pattern}</pattern>
            </encoder>
        </appender>
    
        
        <logger name="com.zzc.sbexp" level="info" additivity="false">
            <appender-ref ref="console" />
        </logger>
    </configuration>

运行代码后：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 5]  
4.切换日志配置文件：

将日志框架切换为 log4j2

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

`log4j2.xml`：

<?xml version="1.0" encoding="utf-8" ?>
    
    <Configuration status="warn" monitorInterval="5">
        
        <properties>
            <property name="LOG_HOME" value="E:/temp/logs"></property>
        </properties>
    
        <Appenders>
            <Console name="console" target="SYSTEM_OUT">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n"></PatternLayout>
            </Console>
        </Appenders>
    
        <Loggers>
            <Root level="info">
                <AppenderRef ref="console" />
            </Root>
        </Loggers>
    
    </Configuration>

[Log_Java _ JUL_Log4j]: https://blog.csdn.net/sco5282/article/details/121567359
[Log_Java _ JCL_SLF]: https://blog.csdn.net/sco5282/article/details/121665038
[Log_Java _ logback_log4j2]: https://blog.csdn.net/sco5282/article/details/121734058?spm=1001.2014.3001.5501
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/92b1d185b0b94862a2a23e960bf22192.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAc2NvNTI4Mg==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/1fba74abd5194225932fadb02eb977b0.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAc2NvNTI4Mg==,size_20,color_FFFFFF,t_70,g_se,x_16
[83284e7b587c49dcb633f6e1a1a51baf.png]: https://img-blog.csdnimg.cn/83284e7b587c49dcb633f6e1a1a51baf.png
[d922e816284a49fbbaca343e06cce9f4.png]: https://img-blog.csdnimg.cn/d922e816284a49fbbaca343e06cce9f4.png
[cc10cf0548674213a1ccd92125719882.png]: https://img-blog.csdnimg.cn/cc10cf0548674213a1ccd92125719882.png
[24439c4520b54057928cadd97e9cb9cc.png]: https://img-blog.csdnimg.cn/24439c4520b54057928cadd97e9cb9cc.png
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/2226c93f0e8a4d25856dd20041777f47.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAc2NvNTI4Mg==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/7eb2d7b0b7f94e799f51f454b5578c2d.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAc2NvNTI4Mg==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 4]: https://img-blog.csdnimg.cn/cd94dc0859414f2499b4df98e3b72d47.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAc2NvNTI4Mg==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAc2NvNTI4Mg_size_20_color_FFFFFF_t_70_g_se_x_16 5]: https://img-blog.csdnimg.cn/e4d0c720bce947fbaadd633e4178604f.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAc2NvNTI4Mg==,size_20,color_FFFFFF,t_70,g_se,x_16