前言
log4j2是 log4j 的进化版本，并提供了许多 logback 可用的改进，同时解决了 Logback 体系结构中的一些固有问题。本文将从slf4j+log4j2的快速使用开始，然后介绍log4j2的优异性能以及log4j2配置文件相关的详细说明。
log4j2 官网文档：https://logging.apache.org/log4j/2.x/
快速使用
引入依赖
- 如果是
SpringBoot项目，可以引入下面的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
- 如果是普通的
Maven项目则需引入如下依赖
<properties>
<log4j2.version>2.13.3</log4j2.version>
</properties>
<!-- 日志框架 slf4j+log4j2-->
<!-- slf4j依赖 -->
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.30</version>
</dependency>
<!-- log4j2和slf4j桥接依赖-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>${log4j2.version}</version>
<scope>test</scope>
</dependency>
<!-- log4j2依赖-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>${log4j2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>${log4j2.version}</version>
</dependency>
</dependencies>
排除依赖冲突
如Spring Boot 2.x默认使用Logback日志框架，要使用 log4j2必须先排除 logback。
例子
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<exclusions>
<!--排除logback-->
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
如果还有其他的依赖冲突，看控制台报错信息和pom.xml文件的依赖图(右键点击Show Dependencies…), 进行排除(Exclude), 依赖图里面有红线的，就是存在依赖冲突的，但运行不一定会报错，报错的冲突是一定要解决的。排除后，需要进行 Reimport 重新导入依赖。
依赖图里查找依赖的方法
快捷键 ctrl+F，弹出图元素框后，虽然没有搜索框，但是可以继续输入查找的内容，输入之后，查找的内容就会出现了，如下图所示。
配置文件
log4j2 配置文件名称和加载顺序
使用log4j2之前需要在classpath下新建一个配置文件。如果没有任何配置，log4j2将使用缺省配置。需要注意的是 log4j 2.x 版本不再支持像 1.x 中的.properties后缀的文件配置方式，2.x 版本配置文件后缀名只能为".xml",".json“或者”.jsn"。
系统选择配置文件的优先级(从先到后)如下：
classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件
classpath下的名为log4j2-test.xml的文件
classpath下名为log4j2.json 或者log4j2.jsn的文件
classpath下名为log4j2.xml的文件
我们一般默认使用log4j2.xml进行命名。如果本地要测试，可以把log4j2-test.xml放到classpath，而正式环境使用log4j2.xml，则在打包部署的时候不要打包log4j2-test.xml即可。
log4j2配置文件的位置
默认情况下，只要把log4j2配置文件放在 classpath 环境变量所指定的目录即可，即IDEA中的resources根目录下(不是它里面的子文件夹)。如果想放在其他位置，比如resources/config文件夹下，则需要在application.yml增加自定义的配置：
# 日志
logging:
config: classpath:config/log4j2.xml
配置文件例子
<?xml version="1.0" encoding="UTF-8"?>
<configuration status="debug" monitorInterval="30">
<!-- 先定义所有的appender(附加器)-->
<appenders>
<!-- 输出控制台的配置 -->
<Console name="Console" target="SYSTEM_OUT">
<!-- 控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<!-- 输出日志的格式 -->
<PatternLayout pattern="[%d{HH:mm:ss.SSS}] [%-5p] %l - %m%n"/>
</Console>
<!-- 文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用 -->
<!-- append为TRUE表示消息增加到指定文件中，false表示消息覆盖指定的文件内容，默认值是true -->
<File name="log" fileName="log/test.log" append="false">
<PatternLayout pattern="[%d{HH:mm:ss.SSS}] [%-5p] %l - %m%n"/>
</File>
<!-- 添加过滤器ThresholdFilter,可以有选择的输出某个级别以上的类别 onMatch="ACCEPT" onMismatch="DENY"意思是匹配就接受,否则直接拒绝 -->
<File name="ERROR" fileName="logs/error.log">
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{yyyy.MM.dd 'at' HH:mm:ss z}] [%-5p] %l - %m%n"/>
</File>
<!-- 这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
<RollingFile name="RollingFile" fileName="logs/web.log"
filePattern="logs/$${date:yyyy-MM}/web-%d{MM-dd-yyyy}-%i.log.gz">
<PatternLayout pattern="[%d{yyyy-MM-dd 'at' HH:mm:ss z}] [%-5p] %l - %m%n"/>
<SizeBasedTriggeringPolicy size="2MB"/>
</RollingFile>
</appenders>
<!-- 然后定义logger，只有定义了logger并引入的appender，appender才会生效 -->
<loggers>
<!-- 过滤掉spring和mybatis的一些无用的DEBUG信息-->
<logger name="org.springframework" level="INFO"></logger>
<logger name="org.mybatis" level="INFO"></logger>
<!-- 建立一个默认的root的logger -->
<root level="trace">
<appender-ref ref="RollingFile"/>
<appender-ref ref="Console"/>
<appender-ref ref="ERROR"/>
<appender-ref ref="log"/>
</root>
</loggers>
</configuration>
日志打印代码
使用lombok插件中的@Slf4j 注解可以很方便的使用 org.slf4j.Logger 对象。日常开发尽量使用Slf4j门面来处理日志，尽量避免使用具体的日志框架。
@Slf4j
@SpringBootTest
public class LogTests {
@Test
public void m1() {
log.trace("trace");
log.debug("debug");
log.info("info");
log.warn("warn");
log.error("error");
log.error("error {}", "param");
}
}
控制台输出：
[17:54:58.712] [INFO ] com.chenqunhui.blog.LogTests.m1(LogTests.java:20) - info
[17:54:58.712] [WARN ] com.chenqunhui.blog.LogTests.m1(LogTests.java:21) - warn
[17:54:58.712] [ERROR] com.chenqunhui.blog.LogTests.m1(LogTests.java:22) - error
[17:54:58.713] [ERROR] com.chenqunhui.blog.LogTests.m1(LogTests.java:23) - error param
使用Slf4j的占位符 {}
slf4j提供了一个名为参数化日志的高级特性，可以显著提高在配置为关闭日志的情况下的日志语句性能
//slf4j
log.debug("Found {} records matching filter: '{}'", records, filter);
//log4j
log.debug("Found " + records + " records matching filter: '" + filter + "'");
可以看出slf4j的方式一方面更简略易读，另一方面少了字符串拼接的开销,并且在日志级别达不到时（这里例子即为设置级别为debug以上），不会调用对象的toString方法。
log4j2的优点
市面上的日志框架多种多样：log4j、log4j2、slf4j、JDKLog、logback等等。log4j目前已经停止更新了。Apache推出了新的log4j2来代替log4j，log4j2是对log4j的升级，与其前身log4j相比有了显着的改进，并提供了许多logback可用的改进，同时解决了logback体系结构中的一些固有问题。因此，log4j2 + slf4j应该是未来的大势所趋。
log4j2的性能
log4j2最牛逼的地方在于异步输出日志时的性能表现，log4j2在多线程的环境下吞吐量与log4j和logback的比较如下图。下图比较中log4j2有三种模式：
1）全局使用异步模式；
2）部分Logger采用异步模式；
3）异步Appender。
可以看出在前两种模式下，log4j2的性能较之log4j和logback有很大的优势。
完整的官方性能文档：https://logging.apache.org/log4j/2.x/performance.html
log4j2.xml配置文件说明
<configuration status="debug" monitorInterval="30">
-
根节点
Configuration有两个属性:status和monitorinterval, 两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger)。
其中，status用来指定log4j本身的打印日志的级别。
monitorinterval用于指定log4j自动重新配置的监测间隔时间, 是用来设置配置文件的动态加载时间的，单位是s, 最小是5s。monitorInterval="30"表示每30秒配置文件会动态加载一次。在程序运行过程中，如果修改配置文件，程序会随之改变。 -
Appenders节点，常见的有三种子节点:Console、RollingFile、File。●
Console节点用来定义输出到控制台的Appender。
(1)name:指定Appender的名字.
(2)target:SYSTEM_OUT或SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
(3)PatternLayout:输出格式，不设置默认为:%m%n.●
File节点用来定义输出到指定位置的文件的Appender.
(1)name:指定Appender的名字.
(2)fileName:指定输出日志的目的文件带全路径的文件名.
(3)PatternLayout:输出格式，不设置默认为:%m%n.●
RollingFile节点用来定义日志文件超过指定大小自动删除旧的创建新的的Appender.
自动追加日志信息到文件中，直至文件达到预定的大小，然后自动重新生成另外一个文件来记录之后的日志。
(1)name:指定Appender的名字.
(2)fileName:指定输出日志的目的文件带全路径的文件名.
(3)PatternLayout:输出格式，不设置默认为:%m%n.
(4)filePattern:指定新建日志文件的名称格式.
(5)Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
(6)TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am…而不是7am.
(7)SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
(8)DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。 -
Loggers节点，常见的有两种子节点:Root和Logger.●
Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
○level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
○appender-ref：Root的子节点，用来指定该日志输出到哪个Appender.●
Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。
○level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
○name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
○appender-ref：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。
扫一扫
6712
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
