本文深入解析Log4j2日志框架的特性和配置方法，对比log4j和logback，介绍如何在Spring Boot项目中使用Log4j2进行日志记录，包括配置文件详解和常见应用场景。
以下大部分内容转载整理自 https://blog.youkuaiyun.com/vbirdbest/article/details/71751835 ，感谢 vbirdbest 的相关知识分享
首先，认识一下三胞胎
- log4j是apache实现的一个开源日志组件
- logback同样是由log4j的作者设计完成的，拥有更好的特性，用来取代log4j的一个日志框架，是slf4j的原生实现
- Log4j2是log4j 1.x和logback的改进版，据说采用了一些新技术（无锁异步、等等），使得日志的吞吐量、性能比log4j 1.x提高10倍，并解决了一些死锁的bug，而且配置更加简单灵活
然后，了解一下，使用slf4j+log4j和直接用log4j的区别
slf4j是对所有日志框架制定的一种规范、标准、接口，并不是一个框架的具体的实现，因为接口并不能独立使用，需要和具体的日志框架实现配合使用（如log4j、logback），使用接口的好处是当项目需要更换日志框架的时候，只需要更换jar和配置，不需要更改相关java代码
-
import org.slf4j.Logger;
-
import org.slf4j.LoggerFactory;
-
-
public
class TestSlf4j {
-
-
// Logger和LoggerFactory导入的是org.slf4j包
-
private
final
static Logger logger = LoggerFactory.getLogger(TestSlf4j .class);
-
}
log4j、logback、log4j2都是一种日志具体实现框架，所以既可以单独使用也可以结合slf4j一起搭配使用
-
import org.apache.logging.log4j.LogManager;
-
import org.apache.logging.log4j.Logger;
-
-
public
class TestLog4j {
-
// Logger和LogManager导入的是org.apache.logging包
-
private
static
final Logger LOG = LogManager.getLogger(TestLog4j.class);
-
}
一、导入需要使用的jar包(slf4j+log4j2)
springboot项目中需导入
绕坑：如项目中有导入spring-boot-starter-web依赖包记得去掉spring自带的日志依赖spring-boot-starter-logging，如下：
二、开始配置
springboot方式：
application.properties中添加配置 logging.config=classpath:log4j2_dev.xml， log4j2_dev.xml是你创建的log4j2的配置文件名，放在resources下，如放在其他路径则对应修改
Web工程方式：
-
<context-param>
-
<param-name>log4jConfiguration</param-name>
-
<param-value>/WEB-INF/conf/log4j2.xml</param-value>
-
</context-param>
-
-
<listener>
-
<listener-
class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>
-
</listener>
纯Java方式：
-
public static void main(String[] args) throws IOException {
-
File file =
new File(
"D:/log4j2.xml");
-
BufferedInputStream in =
new BufferedInputStream(
new FileInputStream(file));
-
final ConfigurationSource source =
new ConfigurationSource(in);
-
Configurator.initialize(
null, source);
-
-
Logger logger = LogManager.getLogger(
"myLogger");
-
}
配置文件的格式：log2j配置文件可以是xml格式的，也可以是json格式的，
配置文件的位置：log4j2默认会在classpath目录下寻找log4j2.xml、log4j.json、log4j.jsn等名称的文件，如果都没有找到，则会按默认配置输出，也就是输出到控制台，也可以对配置文件自定义位置（需要在web.xml中配置），一般放置在src/main/resources根目录下即可
贴上log4j2_dev.properties的配置再来讲解
-
<?xml version="1.0" encoding="UTF-8"?>
-
<Configuration status="WARN">
-
<properties>
-
<property name="LOG_HOME">D:/logs
</property>
-
<property name="FILE_NAME">mylog
</property>
-
<property name="log.sql.level">info
</property>
-
</properties>
-
-
-
<Appenders>
-
<Console name="Console" target="SYSTEM_OUT">
-
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %l - %msg%n" />
-
</Console>
-
-
<RollingRandomAccessFile name="RollingRandomAccessFile" fileName="${LOG_HOME}/${FILE_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">
-
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %l - %msg%n"/>
-
<Policies>
-
<TimeBasedTriggeringPolicy interval="1"/>
-
<SizeBasedTriggeringPolicy size="10 MB"/>
-
</Policies>
-
<DefaultRolloverStrategy max="20"/>
-
</RollingRandomAccessFile>
-
</Appenders>
-
-
<Loggers>
-
<Root level="info">
-
<AppenderRef ref="Console" />
-
<AppenderRef ref="RollingRandomAccessFile" />
-
</Root>
-
-
<Logger name="com.mengdee.dao" level="${log.sql.level}" additivity="false">
-
<AppenderRef ref="Console" />
-
</Logger>
-
</Loggers>
-
</Configuration>
log4j2.xml文件的配置大致如下：
- Configuration
<ul><li><span style="color:#f33b45;">properties</span></li> <li><span style="color:#f33b45;">Appenders </span> <ul><li><span style="color:#7c79e5;">Console </span> <ul><li><span style="color:#86ca5e;">PatternLayout</span></li> </ul></li> <li><span style="color:#7c79e5;">File</span></li> <li><span style="color:#7c79e5;">RollingRandomAccessFile</span></li> <li><span style="color:#7c79e5;">Async</span></li> </ul></li> <li><span style="color:#f33b45;">Loggers </span> <ul><li><span style="color:#7c79e5;">Logger</span></li> <li><span style="color:#7c79e5;">Root </span> <ul><li><span style="color:#86ca5e;">AppenderRef</span></li> </ul></li> </ul></li> </ul></li>
-
Configuration：为根节点，有status和monitorInterval等多个属性
<ul><li>status的值有 “trace”, “debug”, “info”, “warn”, “error” and “fatal”，用于控制log4j2日志框架本身的日志级别，如果将stratus设置为较低的级别就会看到很多关于log4j2本身的日志，如加载log4j2配置文件的路径等信息</li> <li>monitorInterval，含义是每隔多少秒重新读取配置文件，可以不重启应用的情况下修改配置</li> </ul></li> <li> <p><span style="color:#f33b45;"><strong>Appenders：</strong></span>输出源，用于定义日志输出的地方 <br> log4j2支持的输出源有很多，有控制台Console、文件File、RollingRandomAccessFile、MongoDB、Flume 等</p> <ul><li> <p><span style="color:#7c79e5;"><strong>Console：</strong></span>控制台输出源是将日志打印到控制台上，开发的时候一般都会配置，以便调试</p> </li> <li> <p><span style="color:#7c79e5;"><strong>File：</strong></span>文件输出源，用于将日志写入到指定的文件，需要配置输入到哪个位置（例如：D:/logs/mylog.log）</p> </li> <li> <p><strong><span style="color:#7c79e5;">RollingRandomAccessFile:</span> </strong>该输出源也是写入到文件，不同的是比File更加强大，可以指定当文件达到一定大小（如20MB）时，另起一个文件继续写入日志，另起一个文件就涉及到新文件的名字命名规则，因此需要配置文件命名规则 <br> 这种方式更加实用，因为你不可能一直往一个文件中写，如果一直写，文件过大，打开就会卡死，也不便于查找日志。</p> <ul><li>fileName 指定当前日志文件的位置和文件名称</li> <li>filePattern 指定当发生Rolling时，文件的转移和重命名规则</li> <li>SizeBasedTriggeringPolicy 指定当文件体积大于size指定的值时，触发Rolling</li> <li>DefaultRolloverStrategy 指定最多保存的文件个数</li> <li>TimeBasedTriggeringPolicy 这个配置需要和filePattern结合使用，注意filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i，最小的时间粒度是mm，即分钟</li> <li>TimeBasedTriggeringPolicy指定的size是1，结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH}，最小粒度为小时，则每一个小时生成一个文件</li> </ul></li> <li> <p><span style="color:#7c79e5;"><strong>NoSql：</strong></span>MongoDb, 输出到MongDb数据库中</p> </li> <li> <p><span style="color:#7c79e5;"><strong>Flume：</strong></span>输出到Apache Flume（Flume是Cloudera提供的一个高可用的，高可靠的，分布式的海量日志采集、聚合和传输的系统，Flume支持在日志系统中定制各类数据发送方，用于收集数据；同时，Flume提供对数据进行简单处理，并写到各种数据接受方（可定制）的能力。）</p> </li> <li> <p><span style="color:#7c79e5;"><strong>Async：</strong></span>异步，需要通过AppenderRef来指定要对哪种输出源进行异步（一般用于配置RollingRandomAccessFile）</p> </li> </ul><p><span style="color:#86ca5e;"><strong>PatternLayout：</strong></span>控制台或文件输出源（Console、File、RollingRandomAccessFile）都必须包含一个PatternLayout节点，用于指定输出文件的格式（如 日志输出的时间 文件 方法 行数 等格式），例如 pattern=”%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n”</p> <pre class="has" name="code" onclick="hljs.copyCode(event)"><code class="language-java hljs"><ol class="hljs-ln"><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="1"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%d{HH:mm:ss.SSS} 表示输出到毫秒的时间</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="2"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%t 输出当前线程名称</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="3"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%-<span class="hljs-number">5l</span>evel 输出日志级别，-<span class="hljs-number">5</span>表示左对齐并且固定输出<span class="hljs-number">5</span>个字符，如果不足在右边补<span class="hljs-number">0</span></div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="4"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%logger 输出logger名称，因为Root Logger没有名称，所以没有输出</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="5"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%msg 日志文本</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="6"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%n 换行</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="7"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line"> </div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="8"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">其他常用的占位符有：</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="9"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%F 输出所在的类文件名，如Log4j2Test.java</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="10"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%L 输出行号</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="11"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%M 输出所在方法名</div></div></li><li><div class="hljs-ln-numbers"><div class="hljs-ln-line hljs-ln-n" data-line-number="12"></div></div><div class="hljs-ln-code"><div class="hljs-ln-line">%l 输出语句所在的行数, 包括类名、方法名、文件名、行数</div></div></li></ol></code><div class="hljs-button" data-title="复制"></div></pre> </li> <li> <p><span style="color:#f33b45;"><strong>Loggers：</strong></span>日志器 <br> 日志器分根日志器Root和自定义日志器，当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器，自定义时需要指定每个Logger的名称name（对于命名可以以包名作为日志的名字，不同的包配置不同的级别等），日志级别level，相加性additivity（是否继承下面配置的日志器）， 对于一般的日志器（如Console、File、RollingRandomAccessFile）一般需要配置一个或多个输出源AppenderRef；</p> <p>每个logger可以指定一个level（TRACE, DEBUG, INFO, WARN, ERROR, ALL or OFF），不指定时level默认为ERROR</p> <p>additivity指定是否同时输出log到父类的appender，缺省为true。</p> </li>
-
<Logger name="rollingRandomAccessFileLogger" level="trace" additivity="true">
-
<AppenderRef ref="RollingRandomAccessFile" />
-
</Logger>
- properties: 属性
使用来定义常量，以便在其他配置的时候引用，该配置是可选的，例如定义日志的存放位置
D:/logs
三、验证日志内容
以下为练习写的excel数据存入数据库的controller层代码，其中加入Log4j2
-
import cn.tbj.service.ExcelService;
-
import org.slf4j.Logger;
-
import org.slf4j.LoggerFactory;
-
import org.springframework.beans.factory.annotation.Autowired;
-
import org.springframework.web.bind.annotation.PostMapping;
-
import org.springframework.web.bind.annotation.RequestMapping;
-
import org.springframework.web.bind.annotation.RequestParam;
-
import org.springframework.web.bind.annotation.RestController;
-
import org.springframework.web.multipart.MultipartFile;
-
-
-
@RestController
-
@RequestMapping(
"/user")
-
public
class UserController {
-
-
public
final
static Logger logger = LoggerFactory.getLogger(UserController.class);
-
-
@Autowired
-
private ExcelService excelService;
-
-
@PostMapping(
"/import")
-
public boolean addUser(@RequestParam("file") MultipartFile file) {
-
boolean a =
false;
-
String filename = file.getOriginalFilename();
-
System.out.println(
"++++++++++++文件名++++++++"+filename);
-
-
logger.trace(
"trace level");
-
logger.debug(
"debug level");
-
logger.info(
"info level");
-
logger.warn(
"warn level");
-
logger.error(
"error level");
-
-
long beginTime = System.currentTimeMillis();
-
logger.info(
"请求处理结束，耗时：{}毫秒", (System.currentTimeMillis() - beginTime));
//第一种用法
-
logger.info(
"请求处理结束，耗时：" + (System.currentTimeMillis() - beginTime) +
"毫秒");
//第二种用法
-
-
try {
-
a = excelService.batchImport(filename, file);
-
}
catch (Exception e) {
-
e.printStackTrace();
-
}
-
return a ;
-
}
-
}
尝试一些正常和错误的操作，以下为反馈的日志信息
扫一扫
1274
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
