slf4j+log4j2使用及log4j2配置文件解析

最新推荐文章于 2024-08-24 02:28:15 发布
最新推荐文章于 2024-08-24 02:28:15 发布
阅读量1.5k 收藏 4
点赞数
分类专栏： Java基础增强 文章标签： slf4j log4j2 slf4j+log4j2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34294121/article/details/100111995
版权

文章目录

零、一些问题的修改与更新

0.1 将日志自动保存到不同的日志文件（19-10-03更新）

·　　自己在做项目的时候遇到了一个问题：重新运行项目，如何把日志保存到不同的log文件？
·　　我之前写的那个模板有一个重大的问题：每次运行程序，只要日志文件没超过maxSize，log都只会记录到这个文件。但是调试的时候，这种操作令人十分不爽，因此，在查询了官网之后，给模板进行了修改。
修改如下：
·　　因为在普通的字符串里无法使用pattern的语法，因此使用fileName="$${date:MM-dd-HH-ss}" 作为保存的日志名称，这样每次运行程序，日志必然会保存在不同的文件下。
·　　实际上，我们完全可以构造两个FileAppender，这样就可以根据我们的需要来使用不同的日志文件记录方式了：本文的模板已更新，不喜可删。

一、什么是slf4j和log4j2

·　　目前开源的日志框架有很多，如logback，log4j等，这面临了一个问题：当使用不同的日志框架或者这些日志框架面临了重大更新的时候，如果其实现函数有所改变，那么旧版本的框架就会崩溃，这很不利于项目的维护和新框架的推广。因此才诞生了例如slf4j这样的日志门面。
·　　日志门面，顾名思义就是日志框架对外的表现形式，理论上只要日志框架实现了日志门面的接口，不管其怎么更新，开发者都不需要对项目的依赖，或者项目的代码做出过多的改变。目前还在坚持更新且性能良好的日志门面非slf4j莫属，因此强烈建议使用slf4j作为我们书写日志的接口。
·　　日志框架方面，logback是log4j的升级版，这两个框架与slf4j是一个开发者开发出来的，因此其整合十分之稳定。但是log4j2作为apache最新推出的日志框架，在异步记录日志的方面性能比logback要更加的优异，因此本着要用就用最好的的原则 ，使用lo4gj2作为日志记录的框架。
注：log4j2只是假借了log4j之名而已，log4j的真正升级版是logback。

二、 依赖

·　　日志的环境依赖总共有4部分，分别是slf4j接口部分，log4j2的日志框架实现部分，log4j2异步日志插件部分以及slf4j与log4j2的桥接部分。

包名作用
slf4j-api目前的版本1.7就可。slf4j的接口包，我们对日志进行的所有操作都用的是这个包的API
log4j-core版本必须在2.1以上，是log4j2的核心包
log4j-api版本与核心包一致，log4j2的接口包，用来直接调用log4j2框架的，必须导入，不然无法与slf4j对接
log4j-web版本与核心包一致，用于web项目的log4j2，阻止web项目出现警告
com.lmax.disruptor版本随意，开启log4j2的异步日志记录的功能
log4j-slf4j-impl版本与核心包一致，用于slf4j与log4j对接，即用slf4j的接口实现操作日志

这里给出一份Maven完整依赖：

    <properties>
        <log4j2.version>2.11.2</log4j2.version>
        <slf4j.version>1.7.28</slf4j.version>
    </properties>

    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>${log4j2.version}</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-api -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>${log4j2.version}</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-web -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-web</artifactId>
            <version>${log4j2.version}</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.lmax/disruptor -->
        <dependency>
            <groupId>com.lmax</groupId>
            <artifactId>disruptor</artifactId>
            <version>3.4.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-slf4j-impl -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>${log4j2.version}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

三、配置

·　　看多很多的博客，都没有官网的配置全面，因此给出官网传送门：log4j2官网详细配置说明
·　　本博客给出一种粘贴复制即可用的配置，并给出一些个人认为比较重要的说明。

3.1 配置文件

·　　基本上所有的配置都写在了Properties里，因此，只需要改Properties就可以用了（建议自定义Logger，不建议修改Appenders）。
Apperders里定义了两种日志记录的格式：1. 在控制台输出name=“Console”，2. 在文件输出name=“File”。使用RollingRandomAccessFileAppender是因为其性能最好，且支持日志自动归档。

<?xml version="1.0" encoding="UTF-8"?>
<!-- https://www.cnblogs.com/hafiz/p/6170701.html-->
<Configuration status="WARN" name="MyApp">
	<Properties>
		<!--日志文件保存的路径-->
		<property name="filePath" value="src/logs/$${date:MM-dd-HH-mm-ss}-untitled.log"/>
		<property name="filePath_onlyOne" value="src/logs/untitled.log"/>
		<!--日志文件归档后保存的压缩文件路径-->
		<property name="filePattern" value="src/logs/$${date:yyyy-MM}/untitled-%d{yyyy-MM-dd-HH}-%i.log.zip"/>
		<!--日志文档超过多大时执行翻转（即：将旧文件压缩，并用新日志文件记录）-->
		<property name="maxSize" value="250 MB"/>
		<!--记录的日志文件超过多少时，旧文件会被删除-->
		<property name="maxFile" value="50"/>
		<!--打印日志的时候是否标注日志在项目的位置信息-->
		<property name="useLocation" value="true"/>
		<!--日志输出格式-->
		<property name="layoutPattern" value="%date %p %c{1.} [%thread] %location %message %exception%n"/>
	</Properties>
	<Appenders>
		<Console name="Console" target="SYSTEM_OUT">
			<PatternLayout pattern="${layoutPattern}"/>
		</Console>
<!--		-->
		<RollingRandomAccessFile name="File" fileName="${filePath}" filePattern="${filePattern}">
			<PatternLayout pattern="${layoutPattern}"/>
			<Policies>
				<!--基于时间的归档，一般不使用-->
				<!--这个6基于filePattern归档文件的时间，本文件归档的filePattern最后的HH表示小时，因此此文件每6个小时进行一次归档-->
				<!-- <TimeBasedTriggeringPolicy interval="6" modulate="true"/>-->
				<!--基于文件大小的归档-->
				<SizeBasedTriggeringPolicy size="${maxSize}"/>
			</Policies>
			<DefaultRolloverStrategy max="${maxFile}"/>
		</RollingRandomAccessFile>
		
		<RollingRandomAccessFile name="OneFile" fileName="${filePath_onlyOne}" filePattern="${filePattern}">
			<PatternLayout pattern="${layoutPattern}"/>
			<Policies>
				<!--基于文件大小的归档-->
				<SizeBasedTriggeringPolicy size="${maxSize}"/>
			</Policies>
			<DefaultRolloverStrategy max="${maxFile}"/>
		</RollingRandomAccessFile>
	</Appenders>
	<!--这个只能自行配置了-->
	<Loggers>
		<!--异步日志Root（与同步Root之间只能存在一个）-->
<!--		<AsyncRoot level="DEBUG" includeLocation="${useLocation}">-->
<!--			<AppenderRef ref="Console"/>-->
<!--			<AppenderRef ref="File"/>-->
<!--		</AsyncRoot>-->
<!--		        同步Root-->
		<Root level="INFO" >
			<AppenderRef ref="File"/>
			<AppenderRef ref="Console"/>
		</Root>
		<!--异步日志(与同步日志可同时存在)-->
		<!--name属性值请自定义-->
<!--		<AsyncLogger name="AsyncLogger" level="DEBUG" includeLocation="${useLocation}" additivity="false">-->
<!--			<AppenderRef ref="File"/>-->
<!--		</AsyncLogger>-->
<!--		同步日志-->
<!--		<Logger name="com.memoforward.dao" level="DEBUG" includeLocation="${useLocation}" additivity="false">-->
<!--			<AppenderRef ref="Console"/>-->
<!--		</Logger>-->
	</Loggers>
</Configuration>

3.2 配置的简单说明：

3.2.1 RollingRandomAccessFile标签

  • RollingRandomAccessFile的三个属性的含义：

    1. name：这个Appender的引用名
    2. fileName：日志文件的路径及名称（文件夹或文件不存在就自动创建）
    3. filePattern：日志归档后的文件的保存路径和名称（如果加了.zip就自动压缩）

  • RollingRandomAccessFile必须配置的两个字标签：

    1. TriggerPolicy：文件翻转触发机制。翻转的意思就是旧文件保存（归档），另起新文件进行记录。
      在上述配置文件中，其触发机制是SizeBasedTriggeringPolicy，即：当文件大小超过一定阈值后，进行自动保存
    2. RolloverStrategy：文件翻转策略。
      在上述配置文件中，其策略是默认策略，当归档的文件数量达到一定数值后，就自动删除旧文件（如果不配置，则默认为7）

  • 测试代码如下：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.testng.annotations.Test;

public class Log4j2Test {
//    private static final Logger logger = LoggerFactory.getLogger(Log4j2Test.class);
    private static final Logger logger = LoggerFactory.getLogger("AsyncLogger");
    @Test
    public void testLog(){
        for(int i = 0; i < 500; i++){
            logger.error(Integer.toString(i));
        }
    }
}
  • 测试结果如下
    设置了保存的文件最大为1KB，最大保存文件数量为10，保存500条日志。每篇日志能保存9条语句。
    在这里插入图片描述
  • untitled.log输出如下：
2019-08-28 19:16:52,248 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 491 
2019-08-28 19:16:52,248 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 492 
2019-08-28 19:16:52,248 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 493 
2019-08-28 19:16:52,248 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 494 
2019-08-28 19:16:52,248 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 495 
2019-08-28 19:16:52,248 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 496 
2019-08-28 19:16:52,249 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 497 
2019-08-28 19:16:52,250 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 498 
2019-08-28 19:16:52,250 ERROR AsyncLogger [main] Log4j2Test.testLog(Log4j2Test.java:11) 499

·　　可见，如果不设置翻转的机制，要么会在一个日志文件内记录所有的数据，要么仅会保存7条归档的日志。一般情况下，希望能把所有的归档日志文件都保存下来，因此RolloverStragety的值要设置的大一点。

3.2.2 Logger的配置

·　　Logger分为同步和异步，只有一个RootLogger。异步的实现就是我们之前引入的那个com.lmax.disruptor包，当我们启用异步日志记录的时候，就会新建一个Disruptor对象，具体的日志记录流程建议参考这位大佬的文章:Log4j2中的同步日志与异步日志。

  • Logger中属性的含义：

    1. name：在代码getLogger的名字，root没有此属性。
    2. level：日志的打印级别为"OFF>FATAL>ERROR>WARN>INFO>DEBUG>TRACE"。logger在记录日志的时候，只会记录level界别及以上的日志内容(OFF永远不会打印)。如设置了ERROR，只会打印FATAL和ERROR。
    3. includeLoacation：日志打印的时候是否会输出位置（打印位置会降低性能）。
    4. additivity：root没有，配置此属性值为true来避免重复打印（如果为false，root会重复打印一次相同级别的日志），至于为什么会重复打印，还是建议大家看一下官方文档，这里不赘述了。

  • Logger的子标签
    1.< AppenderRef ref=“xxx” > 表示这个logger将用到何种Appender，ref内写Appender的name属性值。

3.2.3 PatternLayout解释

·　　本配置文件默认的layoutPattern为：%date %p %c{1.} [%thread] %location %message %exception%n
·　　官网有特别特别详细的说明文档，我这个都是对着官网写出来的，特别好理解，强烈建议大家对看文档。传送门：log4j2的LayoutPattern；本博客就只介绍一下上面的这行配置。

格式说明
%date输出日期和时间：yyyy-MM-dd HH:mm:ss,SSS（年-月-日 时：分：秒，毫秒）
%p输出日志的打印级别
%c{1.}输出该日志所处的缩略类路径
%[thread]打印执行该日志记录的线程名
%location打印日志语句在项目代码中的位置
%message日志内容
%exception如果出现了异常，则打印异常
%n类似于/n，是换行符

四、总结

·　　日志记录一直是一个很尴尬的点，感觉不难，但一直理解不是很深刻，其实我们最常用的就是把日志输出到控制台或者输出到文件，私以为只要把这两个方面搞明白了就行。以后做项目，尽量就用slf4j+log4j2来记录日志啦。

MemoForward
关注
专栏目录
slf4j+log4j2基础教程（拿来即用教程）
lianjunzongsiling的博客
12-20 6722
log4j2是apache著名日志框架log4j的升级，参考logback架构，并且修复了logback固有的一些问题。是一个很好的日志框架。我看了网上一些关于log4j2的教程，要么是光讲概念，要么是只贴代码，适合新手入门的教程比较少。本篇教程的目标是给那些初次使用log4j2的人一个快速入门、配置代码拿来就可用的指导。 log4j2官方文档大而全、有很多概念，往往给一个问题提供多种不同的解决
slf4j+logback - logback.xml配置文件解析
江南烟雨却痴缠丶
01-09 1675
前言 以前写代码，不注重书写log日志，都是通过system.out.println来当做日志使用。后来看了别人的代码，才知道日志的重要性。一般来说，在调用其他地方接口之前一定要打印日志，将传参打印一下，便于排查问题。 即使我们不配置logback.xml，其实控制台依然会输出日志(有默认的输出方案)。我们可以通过logback.xml做一些个性化的日志输出，也可以定义一些输出到文件的日志输出方式等等。 写这个博客，主要是方便以后需要用到logback能一下找到。在此之前，搜到很多一模一样的关于logbac
log4j，log4j2，slf4j，Java日志全部示例
09-03
Java日志全面示例，可以下载运行，简洁易懂，能说明问题。 用maven构建，Java中普通加载log4j，普通web项目加载log4j，Spring项目加载log4j，让你彻底清除Java日志的配置和集成
【log4j2】springboot使用log4j2详细配置
最新发布
weixin_41378047的博客
08-24 342
本文主要讲解：1、一个日志配置文件如何拆分2、不同服务的日志如何划分3、日志如何滚动4、日志过期策略5、异步日志1、日志拆分日志配置文件拆分,例如以下完整的日志配置文件 登录后复制 <?xml version="1.0" encoding="UTF-8"?> <configuration status...
SLF4J结合Log4j2
meteorshower2013的博客
11-30 1115
学习如何搭日志框架 一、下载slf4j和log4j2的包 (一）下载log4j2 官网：http://logging.apache.org/log4j/2.x/ 首页：点击左侧Download 随便点一个开始下载 下载结果： 解压目录： （二）下载slf4j 官网：https://www.slf4j.org/ 首页：点击左侧Download链接 点击下载最新版 下载结果： 解压目录...
slf4j + log4j2
L, there!
09-08 1126
SLF4J，即简单日志门面（Simple Logging Facade for Java），不是具体的日志解决方案，它只服务于各种各样的日志系统，如：log4j，logback。按照官方的说法，SLF4J是一个用于日志系统的简单Facade，允许最终用户在部署其应用时使用其所希望的日志System。 pom.xml中只加入slf4j-api，会报下面的错，说明没有日志实现绑定。 SLF4...
slf4j与log4j、log4j2
热门推荐
程序员Monkey的专栏
05-23 2万+
    最近公司项目系统需要将日志从log4j+slf4j升级为log4j2，然后彻彻底底的把它们研究了一遍，在网上查找相关资源，发现并没有一篇文章能够很完整的把它们之间的关联和区别写出来，所以我在这里做一个总结。log4j    如果在我们系统中单独使用log4j的话，我们只需要引入log4j的核心包就可以了，我这里用的是：log4j-1.2.17.jar，然后在系统中使用如下代码输出日志：pu...
ZK 前端框架 继承 SpringMVC +maven + log4j2 + slf4j + durid 数据库加密
09-13
日志在软件开发中扮演着关键角色，log4j2是Apache提供的一款强大的日志框架，它提供了灵活的日志配置、高性能和丰富的日志处理功能。SLF4J（Simple Logging Facade for Java）则是一个日志门面，为各种日志框架提供...
slf4j+log4j需要的jar和配置文件
07-17
2. slf4j-log4j12.jar：这是SLF4J的Log4j绑定，它将SLF4J的调用桥接到Log4j。 3. log4j-api.jar：Log4j的API库，包含日志接口。 4. log4j-core.jar：Log4j的实现库，包含实际的日志处理代码。 配置文件通常是log4j....
log4j-2.11.2的jar包和日志门面slf4j的jar包
11-11
使用这两个库时，通常需要一个配置文件（如`log4j2.xml`或`log4j2.json`）来定义日志行为，包括日志输出级别（如DEBUG、INFO、WARN、ERROR）、输出目的地（控制台、文件、数据库等）、以及布局格式（如PatternLayout...
log4j-slf4j-impl.zip
07-11
2. 配置Log4j：创建log4j.properties或log4j.xml配置文件，指定日志级别、输出目的地、格式等。 3. 使用SLF4J API：在代码中通过LoggerFactory获取Logger实例，然后调用相应的方法记录日志。 五、最佳实践 1. **...
slf4j+log4j2配置使用
11-06
本资源主要介绍log4j2涉及到的一些知识内容。很多内容时对网络资源的整理，整体来说相对较全了，基本覆盖了常见场景
Java框架——日志整合slf4j+log4j2
qq_51936245的博客
05-28 3878
ApacheLog4j 2是对Log4j的升级，它比其前身Log4j 1.x提供了重大改进，并提供了Logback中可用的许多改进，同时修复了Logback架构中的一些问题。被誉为是目前最优秀的Java日志框架log4j是apache实现的一个开源日志组件logback同样是由log4j的作者设计完成的，拥有更好的特性，用来取代log4j的一个日志框架，是slf4j的原生实现Log4j2。
Java日志（slf4j+log4j2）
Luck_ZZ的博客
09-11 555
一、日志接口与实现 日志接口有：JCL、SLFJ 1.Apache Commons Logging (JCL) jcl为每一种日志实现采用了一个适配器，具体采用哪个是根据动态的根据指定顺序查找classpath是否存在相应的实现，如果一个应用当中有多个classLoader，限制了jcl的正常使用 2.Simple Logging Facade for Java (SLFJ 简单日志...
【日志框架】日志 ⇒ slf4j+log4j2（完全异步模式）
qq_47450919的博客
08-31 823
log4j2日志性能比较：全异步>混合异步>同步。所以建议在使用的时候使用全异步的方式。 通过注解使用：@Slf4j注解 会自动生成一个log对象
Springboot整合slf4j搭配log4j2
菜鸟逆袭之路
03-29 2642
一、啥是日志 其实像我们在前端用的alert、console.log()，后台就是System.out.print等都可以看作日志，可以通过这些方式打印出重要的信息 总而言之，日志是用来记录用户操作、系统运行状态等，是一个系统的重要组成部分。 二、选什么日志框架 首先列举一下日志门面和实现 日志门面（接口） 日志实现 JCL、SLF4J、Jboss logging、 L...
slf4j 与 log4j2 结合配置
hawk2014bj的博客
03-21 433
slf4j 与 log4j2 配置 添加maven依赖 <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-slf4j-impl</artifactId> <version>2.12.0</version> </dependency> log配置格式 Pattern官网配置说明
Java日志框架 -- log4j2（入门案例、Slf4j + Log4j2、log4j2异步日志、无垃圾记录）
天行健 君子以自强不息，地势坤 君子以厚德载物。
06-13 1835
是对的升级版，参考了的一些优秀的设计，并且修复了一些问题，因此带来了一些重大的提升，主要有：官网： https://logging.apache.org/log4j/2.x/首先创建一个普通的Maven工程： 然后添加log4j2相关的依赖 然后编写相应的测试代码： Log4j2Test.java 运行结果： log4j2默认加载classpath下的 文件中的配置。我们现在去创建这个配置文件，并配置基本的配置信息：log4j2.xml 再次运行上面的测试程序： 目前市面上最主流的日志门面就是SLF4J，
用Slf4j集成Log4j2构建项目日志系统的完美解决方案
myli92的博客
08-12 751
一、背景 　　最近因为公司项目性能需要，我们考虑把以前基于的log4j的日志系统重构成基于Slf4j和log4j2的日志系统，因为，使用slf4j可以很好的保证我们的日志系统具有良好的兼容性，兼容当前常见几种日志系统，而使用log4j2而不是log4j是因为Log4j 1.x 在高并发情况下出现死锁导致cpu使用率异常飙升，而Log4j2.0基于LMAX Disruptor的异步日志在多线程环境下性能会远远优于Log4j 1.x和logback（官方数据是10倍以上）。 　　关于slf4j的原理以及优点
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值