Java日志技术之由浅入深（下）

雨点打透心脏的1/2处 2023-03-13 02:35 6阅读 0赞

### 文章目录 ###

*  日志技术 （下）
 *   *  0. 学习目标
     *  1. 日志门面
     *  2. SLF4J的使用
     *   *  2.1 SLF4J入门
         *  2.2 绑定日志的实现（Binding）
     *  2.3 桥接旧的日志框架（Bridging）
     *   *  2.4 SLF4J原理解析
     *  3. Logback的使用
     *   *  3.1 logback入门
         *  3.2 logback配置
         *   *  1. logback组件之间的关系
             *  2. 基本配置信息
             *  3. FileAppender配置
             *  4. RollingFileAppender配置
             *  5. Filter和异步日志配置

# 日志技术 （下） #

## 0. 学习目标 ##

1.  日志门面和日志体系
2.  SLF4J
3.  logback的使用
4.  log4j2的使用
5.  SpringBoot中的日志使用

## 1. 日志门面 ##

当我们的系统变的更加复杂的时候，我们的日志就容易发生混乱。随着系统开发的进行，可能会更新不同的日志框架，造成当前系统中存在不同的日志依赖，让我们难以统一的管理和控制。就算我们强制要求所有的模块使用相同的日志框架，系统中也难以避免使用其他类似spring,mybatis等其他的第三方框架，它们依赖于我们规定不同的日志框架，而且他们自身的日志系统就有着不一致性，依然会出来日志体系的混乱。

所以我们需要借鉴JDBC的思想，为日志系统也提供一套门面，那么我们就可以面向这些接口规范来开发，避免了直接依赖具体的日志框架。这样我们的系统在日志中，就存在了日志的门面和日志的实现。  
**常见的日志门面 ：**  
JCL、slf4j  
**常见的日志实现：**  
JUL、log4j、logback、log4j2  
**日志门面和日志实现的关系：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDA1NjY2_size_16_color_FFFFFF_t_70]  
日志框架出现的历史顺序：  
**log4j -->JUL–>JCL–> slf4j --> logback --> log4j2**

## 2. SLF4J的使用 ##

简单日志门面(Simple Logging Facade For Java) SLF4J主要是为了给Java日志访问提供一套标准、规范的API框架，其主要意义在于提供接口，具体的实现可以交由其他日志框架，例如log4j和logback等。

当然slf4j自己也提供了功能较为简单的实现，但是一般很少用到。对于一般的Java项目而言，日志框架会选择slf4j-api作为门面，配上具体的实现框架（log4j、logback等），中间使用桥接器完成桥接。

官方网站： [https://www.slf4j.org/][https_www.slf4j.org]

SLF4J是目前市面上最流行的日志门面。现在的项目中，基本上都是使用SLF4J作为我们的日志系统。  
SLF4J日志门面主要提供两大功能：

> 1.  日志框架的绑定
> 2.  日志框架的桥接

### 2.1 SLF4J入门 ###

1.  添加依赖

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.27</version>
    </dependency>
    
    <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.27</version>
    </dependency>

1.  编写代码

public class Slf4jTest { 
    	// 声明日志对象
    	public final static Logger LOGGER = LoggerFactory.getLogger(Slf4jTest.class);
    
    	@Test
    	public void testQuick() throws Exception { 
    		// 打印日志信息
    		LOGGER.error("error");
    		LOGGER.warn("warn");
    		LOGGER.info("info");
    		LOGGER.debug("debug");
    		LOGGER.trace("trace");
    		// 使用占位符输出日志信息
    		String name = "jack";
    		Integer age = 18;
    		LOGGER.info("用户：{},{}", name, age);
    		// 将系统异常信息写入日志
    		try { 
    			int i = 1 / 0;
    		} catch (Exception e) { 
    			// e.printStackTrace();
    			LOGGER.info("出现异常：", e);
    		}
    	}
    }

**为什么要使用SLF4J作为日志门面？**

* 1. 使用SLF4J框架，可以在部署时迁移到所需的日志记录框架。
    * 2. SLF4J提供了对所有流行的日志框架的绑定，例如log4j，JUL，Simple logging和NOP。因此可以
    在部署时切换到任何这些流行的框架。
    * 3. 无论使用哪种绑定，SLF4J都支持参数化日志记录消息。由于SLF4J将应用程序和日志记录框架分离，
    因此可以轻松编写独立于日志记录框架的应用程序。而无需担心用于编写应用程序的日志记录框架。
    * 4. SLF4J提供了一个简单的Java工具，称为迁移器。使用此工具，可以迁移现有项目，这些项目使用日志
    框架(如Jakarta Commons Logging(JCL)或log4j或Java.util.logging(JUL))到SLF4J。

### 2.2 绑定日志的实现（Binding） ###

如前所述，SLF4J支持各种日志框架。SLF4J发行版附带了几个称为“SLF4J绑定”的jar文件，每个绑定对应一个受支持的框架。

**使用slf4j的日志绑定流程:**

1.  添加slf4j-api的依赖
2.  使用slf4j的API在项目中进行统一的日志记录
3.  绑定具体的日志实现框架
    
    1.  绑定已经实现了slf4j的日志框架,直接添加对应依赖
    2.  绑定没有实现slf4j的日志框架,先添加日志的适配器,再添加实现类的依赖
4.  slf4j有且仅有一个日志实现框架的绑定（如果出现多个默认使用第一个依赖日志实现）

**通过maven引入常见的日志实现框架：**

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.27</version>
    </dependency>
    
    
    <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.27</version>
    </dependency>
    <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
    </dependency>
    
    
    <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-jdk14</artifactId>
    <version>1.7.27</version>
    </dependency>
    
    
    <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-jcl</artifactId>
    <version>1.7.27</version>
    </dependency>
    
    
    <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-nop</artifactId>
    <version>1.7.27</version>
    </dependency>

要切换日志框架，只需替换类路径上的slf4j绑定。例如，要从java.util.logging切换到log4j，只需将slf4j-jdk14-1.7.27.jar替换为slf4j-log4j12-1.7.27.jar即可。

SLF4J不依赖于任何特殊的类装载。实际上，每个SLF4J绑定在编译时都是硬连线的， 以使用**一个且只有一个**特定的日志记录框架。例如，slf4j-log4j12-1.7.27.jar绑定在编译时绑定以使用log4j。在您的代码中，除了slf4j-api-1.7.27.jar之外，您只需将您选择的一个且只有一个绑定放到相应的类路径位置。不要在类路径上放置多个绑定。以下是一般概念的图解说明。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDA1NjY2_size_16_color_FFFFFF_t_70 1]

## 2.3 桥接旧的日志框架（Bridging） ##

**通常，您依赖的某些组件依赖于SLF4J以外的日志记录API**。您也可以假设这些组件在不久的将来不会切换到SLF4J。为了解决这种情况，SLF4J附带了几个桥接模块，这些模块将对log4j，JCL和java.util.logging API的调用重定向，就好像它们是对SLF4J API一样。

桥接解决的是项目中日志的遗留问题，当系统中存在之前的日志API，可以通过桥接转换到slf4j的实现

1.  先去除之前老的日志框架的依赖
2.  添加SLF4J提供的桥接组件
3.  为项目添加SLF4J的具体实现  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDA1NjY2_size_16_color_FFFFFF_t_70 2]  
    **迁移的方式：**  
    如果我们要使用SLF4J的桥接器，替换原有的日志框架，那么我们需要做的第一件事情，就是删除掉原有项目中的日志框架的依赖。然后替换成SLF4J提供的桥接器。

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>1.7.27</version>
    </dependency>
    
    <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jul-to-slf4j</artifactId>
    <version>1.7.27</version>
    </dependency>
    
    <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.27</version>
    </dependency>

注意问题：

1.  jcl-over-slf4j.jar和 slf4j-jcl.jar不能同时部署。前一个jar文件将导致JCL将日志系统的选择委托给SLF4J，后一个jar文件将导致SLF4J将日志系统的选择委托给JCL，从而导致**无限循环。**
2.  log4j-over-slf4j.jar和slf4j-log4j12.jar**不能同时出现**
3.  jul-to-slf4j.jar和slf4j-jdk14.jar**不能同时出现**
4.  所有的桥接都只对Logger日志记录器对象有效，如果程序中调用了内部的配置类或者是Appender,Filter等对象，将无法产生效果。

### 2.4 SLF4J原理解析 ###

1.  SLF4J通过LoggerFactory加载日志具体的实现对象。
2.  LoggerFactory在初始化的过程中，会通过performInitialization()方法绑定具体的日志实现。
3.  在绑定具体实现的时候，通过类加载器，加载org/slf4j/impl/StaticLoggerBinder.class
4.  所以，只要是一个日志实现框架，在org.slf4j.impl包中提供一个自己的StaticLoggerBinder类，在其中提供具体日志实现的LoggerFactory就可以被SLF4J所加载

## 3. Logback的使用 ##

Logback是由log4j创始人设计的另一个开源日志组件，性能比log4j要好。  
官方网站：[https://logback.qos.ch/index.html][https_logback.qos.ch_index.html]  
**Logback主要分为三个模块：**

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

后续的日志代码都是通过SLF4J日志门面搭建日志系统，所以在代码是没有区别，主要是通过修改配置文件和pom.xml依赖

### 3.1 logback入门 ###

1.  添加依赖

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

1.  java代码

public final static Logger LOGGER = LoggerFactory.getLogger(LogBackTest.class);
    
    	@Test
    	public void testSlf4j() { 
    		// 打印日志信息
    		LOGGER.error("error");
    		LOGGER.warn("warn");
    		LOGGER.info("info");
    		LOGGER.debug("debug");
    		LOGGER.trace("trace");
    	}

### 3.2 logback配置 ###

**logback会依次读取以下类型配置文件：**

*  logback.groovy
 *  logback-test.xml
 *  logback.xml 如果均不存在会采用默认配置

#### 1. logback组件之间的关系 ####

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

#### 2. 基本配置信息 ####

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
    	
    	
    	<property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %c [%thread] %-5level %msg%n" />
    	
    	<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" />
    	</root>
    </configuration>

#### 3. FileAppender配置 ####

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
    	
    	<property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c %M %L [%thread] %m %n" />
    	
    	
    	<property name="log_dir" value="d:/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">
    		
    		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    			<pattern>${pattern}</pattern>
    		</encoder>
    		
    		<file>${log_dir}/logback.log</file>
    	</appender>
    	
    	<appender name="htmlFile" class="ch.qos.logback.core.FileAppender">
    		
    		<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}%c%M%L%thread%m</pattern>
    			</layout>
    		</encoder>
    		
    		<file>${log_dir}/logback.html</file>
    	</appender>
    	
    	<root level="all">
    		<appender-ref ref="console" />
    		<appender-ref ref="file" />
    		<appender-ref ref="htmlFile" />
    	</root>
    </configuration>

#### 4. RollingFileAppender配置 ####

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
    	
    	<property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c %M %L [%thread] %m %n" />
    	
    	
    	<property name="log_dir" value="d:/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="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
    		
    		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    			<pattern>${pattern}</pattern>
    		</encoder>
    		
    		<file>${log_dir}/roll_logback.log</file>
    		
    		<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    			
    			<fileNamePattern>${log_dir}/rolling.%d{yyyy-MMdd}.log%i.gz</fileNamePattern>
    			
    			<maxFileSize>1MB</maxFileSize>
    		</rollingPolicy>
    	</appender>
    	
    	<root level="all">
    		<appender-ref ref="console" />
    		<appender-ref ref="rollFile" />
    	</root>
    </configuration>

#### 5. Filter和异步日志配置 ####

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
    	
    	<property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c %M %L [%thread] %m %n" />
    	
    	
    	<property name="log_dir" value="d:/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="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
    		
    		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    			<pattern>${pattern}</pattern>
    		</encoder>
    		
    		<file>${log_dir}roll_logback.log</file>
    		
    		<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    			
    			<fileNamePattern>${log_dir}rolling.%d{yyyy-MMdd}.log%i.gz
    			</fileNamePattern>
    			
    			<maxFileSize>1MB</maxFileSize>
    		</rollingPolicy>
    		
    		<filter class="ch.qos.logback.classic.filter.LevelFilter">
    			
    			<level>error</level>
    			<onMatch>ACCEPT</onMatch>
    			<onMismatch>DENY</onMismatch>
    		</filter>
    	</appender>
    	
    	<appender name="async" class="ch.qos.logback.classic.AsyncAppender">
    		<appender-ref ref="rollFile" />
    	</appender>
    	
    	<root level="all">
    		<appender-ref ref="console" />
    		<appender-ref ref="async" />
    	</root>
    	
    	<logger name="com.xxx" level="debug" additivity="false">
    		<appender-ref ref="console" />
    	</logger>
    </configuration>

官方提供的log4j.properties转换成logback.xml  
[https://logback.qos.ch/translator/][https_logback.qos.ch_translator]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDA1NjY2_size_16_color_FFFFFF_t_70]: /images/20230312/edeb2076354e4044b663dabeea6d36de.png
[https_www.slf4j.org]: https://www.slf4j.org/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDA1NjY2_size_16_color_FFFFFF_t_70 1]: /images/20230312/83d31d1e6a434612978b05a102281fbb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDA1NjY2_size_16_color_FFFFFF_t_70 2]: /images/20230312/e499285311af4413b6a751918d28cbba.png
[https_logback.qos.ch_index.html]: https://logback.qos.ch/index.html
[https_logback.qos.ch_translator]: https://logback.qos.ch/translator/