【Log】（三）Java 中的日志框架 logback、log4j2
【Log】（一）Java 中的日志框架 JUL、Log4j
【Log】（二）Java 中的日志框架 JCL、SLF
【Log】（三）Java 中的日志框架 logback、log4j2
1. logback 学习
1.1 logback 介绍
logback 是由 log4j 创始人设计的另一个开源日志组件，性能比 log4j 好
logback 主要分为 3 个模块：
logback-core：其它两个模块的基础模块logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4jAPIlogback-access：访问模块与Servlet容器集成提供通过 http 来访问日志的功能
1.2 快速入门
新建一个 Maven 工程，引入依赖，POM 文件：
<!--slf日志门面-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.26</version>
</dependency>
<!--logback-->
<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");
}
}
运行结果如下：
表明：logback 的默认级别是 debug。
1.3 配置文件
logback 依次读取以下类型的配置文件：
- logback.groovy
- logback-test.xml
- logback.xml
如果均不存在，则采用默认配置
1. logback 组件之间的关系
- Logger：日志记录器。把它关联到应用的对应的 context 上后，主要用于存放日志对象，也可以定义日志类型、级别
- Appender：用于指定日志输出的目的地。目的地可以是控制台、文件、数据库等
- 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-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!--控制输出流对象，默认为 System.out，可修改为 System.err-->
<target>System.err</target>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
</appender>
<!--root logger 配置-->
<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：换行
配置了配置文件后，运行结果如下：
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-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!--控制输出流对象，默认为 System.out，可修改为 System.err-->
<target>System.err</target>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
</appender>
<!--文件日志输出的 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 logger 配置-->
<root level="ALL">
<appender-ref ref="console"></appender-ref>
<appender-ref ref="file" />
</root>
</configuration>
当然，如果更想直观地看日志，可将日志文件设置成 html 格式：
<!--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-->
<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");
}
}
运行结果如下：
日志文件拆分规则：日志压缩文件按照秒拆分（精确到秒），当日志文件超过 1 MB 时，日志文件会再次进行拆分，且日志文件名中的 .log%i.gz 中的 i 就会自加。
5. 日志级别过滤器
<!--日志拆分和归档压缩的 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>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
其中，
<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-->
<appender-ref ref="rollFile"></appender-ref>
</appender>
<!--root logger 配置-->
<root level="ALL">
<appender-ref ref="console"></appender-ref>
<appender-ref ref="asyc" />
</root>
7. 自定义 logger
<!--root logger 配置-->
<root level="ALL">
<appender-ref ref="console" />
<appender-ref ref="async" />
</root>
<!--自定义Logger对象-->
<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 文件：
<!--log4j2的日志门面-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.11.1</version>
</dependency>
<!--log4j2的日志实现-->
<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");
}
}
运行结果后：
表明：log4j2 的日志默认级别为 error。
slf4j + log4j2：
<!--slf日志门面-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.26</version>
</dependency>
<!--使用log4j2的适配器进行绑定-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>2.10.0</version>
</dependency>
<!--log4j2的日志门面-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.11.1</version>
</dependency>
<!--log4j2的日志实现-->
<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" ?>
<!--
status=warn：日志框架本身的输出日志级别
monitorInterval="5"：自动加载配置文件的间隔时间，不低于5秒
-->
<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" />
<!--按照时间节点拆分，规则由filePattern定义-->
<TimeBasedTriggeringPolicy />
</Policies>
<!--在同一个目录下，文件的个数限定30个，超过后覆盖旧的日志信息-->
<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
<Configuration>
...
<File name="file" fileName="${LOG_HOME}/myfile.log">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n"></PatternLayout>
</File>
<!--异步日志配置-->
<Async name="Async">
<AppenderRef ref="file" />
</Async>
<Loggers>
<Root level="info">
<AppenderRef ref="console" />
<AppenderRef ref="Async" />
</Root>
</Loggers>
</Configuration>
运行代码后，结果如下：
2. AsyncAppender
AsyncAppender 才是 log4j2 的重头戏，也是官方推荐的方式。有两种方式：全局异步、混合异步。
全局异步
全局异步：所有的日志都是异步地记录，在配置文件上不做任何修改。只需要添加一个 log4j2.component.properties 配置文件。
Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector
混合异步
混合异步：可以在应用中同时使用同步日志和异步日志，这使得日志的配置更加灵活
修改 log4j2.xml：
<Configuration>
...
<Loggers>
<!--自定义Logger对象 includeLocation="false" 关闭行号信息-->
<AsyncLogger name="com.zzc.log.log4j2" level="info" includeLocation="false" additivity="false">
<AppenderRef ref="console" />
</AsyncLogger>
<Root level="info">
<AppenderRef ref="console" />
<AppenderRef ref="Async" />
</Root>
</Loggers>
</Configuration>
运行代码，结果如下：
表明：没有显示行号。
3. SpringBoot 中的日志
SpringBoot 日志也是开发中常用的日志系统。SpringBoot 默认就是使用 SLF4J 作为日志门面，logback 作为日志实现来记录日志。
3.1 SpringBoot 中的日志设计
SpringBoot 中的日志：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
依赖结构图：
总结：
- SpringBoot 底层使用
logback作为日志实现 - 使用了
SLF4J作为日志门面 - 将
JUL也转换为了SLF4J - 也可以使用
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");
}
}
运行结果：
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
运行结果如下：
3.指定日志配置文件：
给类路径下放上每个日志框架自己的配置文件；SpringBoot 就不使用默认配置的了。
| 日志框架 | 配置文件 |
|---|---|
| logback | logback.xml、logback-spring.xml |
| log4j2 | log4j2.xml、log4j2-spring.xml |
| jul | logging.properties |
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-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!--控制输出流对象，默认为 System.out，可修改为 System.err-->
<target>System.err</target>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
</appender>
<!--自定义Logger对象-->
<logger name="com.zzc.sbexp" level="info" additivity="false">
<appender-ref ref="console" />
</logger>
</configuration>
运行代码后：
4.切换日志配置文件：
将日志框架切换为 log4j2
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<!--排除logback-->
<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>