目录
前言
上一篇文章我们比较了Log4j2和Logback的性能，Log4j2相比起来要性能要强很多。那么这篇文章我们来一起看下，如何在Springboot中整合Log4j2。
提示：以下是本篇文章正文内容，下面案例可供参考
一、引入Jar包
Springboot默认引入的是Logback日志实现包，需要排除掉，然后引入Log4j2的日志实现包。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<!-- 去掉springboot默认配置 -->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<!-- 引入log4j2依赖 -->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>二、修改应用配置文件
如果自定义了文件名，需要在application.yml中配置：
logging:
config: xxxx.xml 默认名log4j2-spring.xml，如果使用默认文件名，就不需要在application.yml中配置了。
三、修改日志配置文件
1. 配置模板
log4j2-spring.xml文件的配置模板如下：
<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出 -->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数 -->
<configuration status="WARN" monitorInterval="30">
<!-- 日志文件目录、压缩文件目录、日志格式配置 -->
<properties>
<Property name="filePath">/Users/userName/Logs/appName</Property>
<Property name="catalinaFilePath">${filePath}/catalina</Property>
<Property name="debugFilePath">${filePath}/debug</Property>
<Property name="infoFilePath">${filePath}/info</Property>
<Property name="warnFilePath">${filePath}/warn</Property>
<Property name="errorFilePath">${filePath}/error</Property>
<Property name="log_pattern">%-d{yyyy-MM-dd HH:mm:ss.SSS}-->[%t]--[%-5p]--[%c{1}:%L]-- %msg%n%xwEx</Property>
<property name="KEEP_LOG_DAY">7D</property> <!-- 保留日志天数 D H M S 分别对应天 小时 分钟 秒 -->
</properties>
<!--先定义所有的appender -->
<appenders>
<!--这个输出控制台的配置 -->
<console name="Console" target="SYSTEM_OUT">
<!--输出日志的格式 -->
<PatternLayout pattern="${log_pattern}" />
</console>
<RollingFile name="CATALINA"
fileName="${filePath}/catalina.out"
filePattern="${catalinaFilePath}/catalina-%d{yyyy-MM-dd}-%i.log" immediateFlush="false">
<PatternLayout pattern="${log_pattern}"/>
<Policies>
<TimeBasedTriggeringPolicy />
<SizeBasedTriggeringPolicy size="1 GB" />
</Policies>
<DefaultRolloverStrategy>
<Delete basePath="${catalinaFilePath}" maxDepth="1">
<IfFileName glob="*.log" />
<IfLastModified age="${KEEP_LOG_DAY}"/>
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
<!-- 这个会打印出所有的debug及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
<RollingFile name="RollingFileDebug" fileName="${filePath}/debug.log" filePattern="${debugFilePath}/debug-%d{yyyy-MM-dd}-%i.log" immediateFlush="false">
<!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
<ThresholdFilter level="debug" onMatch="ACCEPT"
onMismatch="DENY" />
<PatternLayout pattern="${log_pattern}" />
<Policies>
<TimeBasedTriggeringPolicy />
<SizeBasedTriggeringPolicy size="100 MB" />
</Policies>
<!--!Note: 这里的age必须和filePattern协调, 后者是精确到HH, 这里就要写成xH, xd就不起作用
另外, 数字最好>2, 否则可能造成删除的时候, 最近的文件还处于被占用状态,导致删除不成功!-->
<!--7天-->
<DefaultRolloverStrategy fileIndex="nomax"> <!-- 每次滚动保留的文件数，目前配置按小时滚动，那么同一个小时内最大日志数为20 -->
<Delete basePath="${debugFilePath}" maxDepth="2">
<IfFileName glob="*.log">
<IfAny>
<IfLastModified age="${KEEP_LOG_DAY}"/>
<!--限制基础目录下最大累计大小-->
<IfAccumulatedFileSize exceeds="30 GB"/>
</IfAny>
</IfFileName>
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
<!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
<RollingFile name="RollingFileInfo" fileName="${filePath}/info.log" filePattern="${infoFilePath}/info-%d{yyyy-MM-dd}-%i.log" immediateFlush="false">
<!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
<ThresholdFilter level="info" onMatch="ACCEPT"
onMismatch="DENY" />
<PatternLayout pattern="${log_pattern}" />
<Policies>
<TimeBasedTriggeringPolicy />
<SizeBasedTriggeringPolicy size="100 MB" />
</Policies>
<DefaultRolloverStrategy max="20"> <!-- 每次滚动保留的文件数，目前配置按小时滚动，那么同一个小时内最大日志数为20 -->
<Delete basePath="${infoFilePath}" maxDepth="2">
<IfFileName glob="*.log"/>
<IfLastModified age="${KEEP_LOG_DAY}"/>
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
<RollingFile name="RollingFileWarn" fileName="${filePath}/warn.log"
filePattern="${warnFilePath}/warn-%d{yyyy-MM-dd}-%i.log" immediateFlush="false">
<ThresholdFilter level="warn" onMatch="ACCEPT"
onMismatch="DENY" />
<PatternLayout pattern="${log_pattern}" />
<Policies>
<TimeBasedTriggeringPolicy />
<SizeBasedTriggeringPolicy size="1 GB" />
</Policies>
<DefaultRolloverStrategy max="20"> <!-- 每次滚动保留的文件数，目前配置按小时滚动，那么同一个小时内最大日志数为20 -->
<Delete basePath="${warnFilePath}" maxDepth="2">
<IfFileName glob="*.log"/>
<IfLastModified age="${KEEP_LOG_DAY}"/>
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
<RollingFile name="RollingFileError" fileName="${filePath}/error.log"
filePattern="${errorFilePath}/error-%d{yyyy-MM-dd}-%i.log" immediateFlush="false">
<ThresholdFilter level="error" onMatch="ACCEPT"
onMismatch="DENY" />
<PatternLayout pattern="${log_pattern}" />
<Policies>
<TimeBasedTriggeringPolicy />
<SizeBasedTriggeringPolicy size="1 GB" />
</Policies>
<DefaultRolloverStrategy max="20"> <!-- 每次滚动保留的文件数，目前配置按小时滚动，那么同一个小时内最大日志数为20 -->
<Delete basePath="${errorFilePath}" maxDepth="2">
<IfFileName glob="*.log"/>
<IfLastModified age="${KEEP_LOG_DAY}"/>
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
</appenders>
<!--然后定义logger，只有定义了logger并引入的appender，appender才会生效 -->
<loggers>
<root level="DEBUG">
<appender-ref ref="Console" />
<appender-ref ref="RollingFileDebug" />
<appender-ref ref="RollingFileInfo" />
<appender-ref ref="RollingFileWarn" />
<appender-ref ref="RollingFileError" />
</root>
</loggers>
</configuration>
2. 配置参数简介
1）日志级别
- trace：追踪，就是程序推进一下，可以写个trace输出
- debug：调试，一般作为最低级别，trace基本不用。
- info：输出重要的信息，使用较多
- warn：警告，有些信息不是错误信息，但也要给程序员一些提示。
- error：错误信息。用的也很多。
- fatal：致命错误
2）输出源
- CONSOLE（输出到控制台）
- FILE（输出到文件）
3）输出格式
- SimpleLayout：以简单的形式显示
- HTMLLayout：以HTML表格显示
- PatternLayout：自定义形式显示
PatternLayout自定义日志布局：
%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间,输出到毫秒的时间
%-5level : 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
%c : logger的名称(%logger)
%t : 输出当前线程名称
%p : 日志输出格式
%m : 日志内容，即 logger.info("message")
%n : 换行符
%C : Java类名(%F)
%L : 行号
%M : 方法名
%l : 输出语句所在的行数, 包括类名、方法名、文件名、行数
hostName : 本地机器名
hostAddress : 本地ip地址4）根节点Configuration
有两个属性:
- status
- monitorinterval
有两个子节点:
- Appenders
- Loggers(表明可以定义多个Appender和Logger).
status用来指定log4j本身的打印日志的级别.
monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.
5）Appenders节点
常见的有三种子节点:Console、RollingFile、File
Console节点用来定义输出到控制台的Appender.
- name:指定Appender的名字.
- target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
- PatternLayout:输出格式，不设置默认为:%m%n.
File节点用来定义输出到指定位置的文件的Appender.
- name:指定Appender的名字.
- fileName:指定输出日志的目的文件带全路径的文件名.
- PatternLayout:输出格式，不设置默认为:%m%n.
RollingFile节点用来定义超过指定条件自动删除旧的创建新的Appender.
- name:指定Appender的名字.
- fileName:指定输出日志的目的文件带全路径的文件名.
- PatternLayout:输出格式，不设置默认为:%m%n.
- filePattern : 指定当发生Rolling时，文件的转移和重命名规则.
- Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
- TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.
- SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
- DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。
6）Loggers节点
常见的有两种:Root和Logger.
Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
- level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.
- Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。
- level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
- name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
- AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。
四、使用示例
public class LogExample {
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
public static void main(String... args) {
log.info("Show me your code.");
}
} 总结
以上就是Springboot整合Log4j2日志实现框架的相关配置。
4742
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
