说说在 Spring Boot 中如何整合与配置 log4j2

小灰灰 2022-12-13 10:00 123阅读 0赞

## 1 引入 log4j2 ##

首先打开 pom.xml ，然后排除掉 Spring Boot 2 所默认使用的日志组件 log-back，接着引入 log4j2：

<dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter</artifactId>
    	<exclusions>
    		<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>

## 2 配置 log4j2 ##

在工程目录的 resources/ 下，新建 log4j2.xml（如果取名为 log4j2-spring.xml，单元测试时会找不到 log4j2 配置）：

log4j2 的日志级别以及优先级排序为： OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL。

### 2.1 配置 Configuration ###

配置时会首先使用 Configuration 标签，它有以下这些常用属性：

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td>配置名称</td> 
  </tr> 
  <tr> 
   <td>status</td> 
   <td>记录到控制台的内部Log4j事件的日志级别，可选值为“trace”，“debug”，“info”，“warn”，“error”和“fatal”</td> 
  </tr> 
  <tr> 
   <td>monitorInterval</td> 
   <td>配置文件更新检查时间间隔（以秒为单位）</td> 
  </tr> 
 </tbody> 
</table>

### 2.2 Properties ###

然后使用 Properties 标签，定义好常量。形如：

定义好后，就可以在后续的 pattern 中这样引用 `${LOG_PATH}`。

## 3 pattern 说明 ##

pattern 用于定义输出日志的格式。

### 3.1 时间格式 ###

时间的一般格式为 `d{pattern}`，d 是英文单词 date 的缩写，具体说明如下。

<table> 
 <thead> 
  <tr> 
   <th>Pattern</th> 
   <th>输出结果</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%d{DEFAULT}</td> 
   <td>2012-11-02 14:34:02,123</td> 
  </tr> 
  <tr> 
   <td>%d{DEFAULT_MICROS}</td> 
   <td>2012-11-02 14:34:02,123456</td> 
  </tr> 
  <tr> 
   <td>%d{DEFAULT_NANOS}</td> 
   <td>2012-11-02 14:34:02,123456789</td> 
  </tr> 
  <tr> 
   <td>%d{ISO8601}</td> 
   <td>2012-11-02T14:34:02,781</td> 
  </tr> 
  <tr> 
   <td>%d{ISO8601_BASIC}</td> 
   <td>20121102T143402,781</td> 
  </tr> 
  <tr> 
   <td>%d{ISO8601_OFFSET_DATE_TIME_HH}</td> 
   <td>2012-11-02’T’14:34:02,781-07</td> 
  </tr> 
  <tr> 
   <td>%d{ISO8601_OFFSET_DATE_TIME_HHMM}</td> 
   <td>2012-11-02’T’14:34:02,781-0700</td> 
  </tr> 
  <tr> 
   <td>%d{ISO8601_OFFSET_DATE_TIME_HHCMM}</td> 
   <td>2012-11-02’T’14:34:02,781-07:00</td> 
  </tr> 
  <tr> 
   <td>%d{ABSOLUTE}</td> 
   <td>14:34:02,781</td> 
  </tr> 
  <tr> 
   <td>%d{ABSOLUTE_MICROS}</td> 
   <td>14:34:02,123456</td> 
  </tr> 
  <tr> 
   <td>%d{ABSOLUTE_NANOS}</td> 
   <td>14:34:02,123456789</td> 
  </tr> 
  <tr> 
   <td>%d{DATE}</td> 
   <td>02 Nov 2012 14:34:02,781</td> 
  </tr> 
  <tr> 
   <td>%d{COMPACT}</td> 
   <td>20121102143402781</td> 
  </tr> 
  <tr> 
   <td>%d{UNIX}</td> 
   <td>1351866842</td> 
  </tr> 
  <tr> 
   <td>%d{UNIX_MILLIS}</td> 
   <td>1351866842781</td> 
  </tr> 
  <tr> 
   <td>%d{HH:mm:ss,SSS}</td> 
   <td>14:34:02,123</td> 
  </tr> 
  <tr> 
   <td>%d{HH:mm:ss,nnnn} to %d{HH:mm:ss,nnnnnnnnn}</td> 
   <td>14:34:02,1234 to 14:34:02,123456789</td> 
  </tr> 
  <tr> 
   <td>%d{dd MMM yyyy HH:mm:ss,SSS}</td> 
   <td>02 Nov 2012 14:34:02,123</td> 
  </tr> 
  <tr> 
   <td>%d{dd MMM yyyy HH:mm:ss,nnnn} to %d{dd MMM yyyy HH:mm:ss,nnnnnnnnn}</td> 
   <td>02 Nov 2012 14:34:02,1234 to 02 Nov 2012 14:34:02,123456789</td> 
  </tr> 
  <tr> 
   <td>%d{HH:mm:ss}{GMT+0}</td> 
   <td>18:34:02</td> 
  </tr> 
 </tbody> 
</table>

### 3.2 日志等级格式 ###

日志等级格式为 `%p{level=label, level=label, ...}`。  
如果直接 `%p`，则会输出等级默认文本，形如：WARN、DEBUG、ERROR、TRACE 或 INFO。

我们可以对这些等级重命名：

%p{WARN=Warning, DEBUG=Debug, ERROR=Error, TRACE=Trace, INFO=Info}

也可以将原本输出文本的默认大写形式转化为小写：

%level{lowerCase=true}

### 3.3 彩色日志 ###

彩色日志格式定义语法为 `%clr{}[颜色]`。比如：

%clr{[%15.15t]}{yellow}

![image.png][]

![8af392a79689533ee75493000c610f88.png][]

### 3.4 日志名输出格式 ###

<table> 
 <thead> 
  <tr> 
   <th>Conversion Pattern</th> 
   <th>Logger Name</th> 
   <th>Result</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%c{1}</td> 
   <td>org.apache.commons.Foo</td> 
   <td>Foo</td> 
  </tr> 
  <tr> 
   <td>%c{2}</td> 
   <td>org.apache.commons.Foo</td> 
   <td>commons.Foo</td> 
  </tr> 
  <tr> 
   <td>%c{10}</td> 
   <td>org.apache.commons.Foo</td> 
   <td>org.apache.commons.Foo</td> 
  </tr> 
  <tr> 
   <td>%c{-1}</td> 
   <td>org.apache.commons.Foo</td> 
   <td>apache.commons.Foo</td> 
  </tr> 
  <tr> 
   <td>%c{-2}</td> 
   <td>org.apache.commons.Foo</td> 
   <td>commons.Foo</td> 
  </tr> 
  <tr> 
   <td>%c{-10}</td> 
   <td>org.apache.commons.Foo</td> 
   <td>org.apache.commons.Foo</td> 
  </tr> 
  <tr> 
   <td>%c{1.}</td> 
   <td>org.apache.commons.Foo</td> 
   <td>o.a.c.Foo</td> 
  </tr> 
  <tr> 
   <td>%c{1.1.<sub>.</sub>}</td> 
   <td>org.apache.commons.test.Foo</td> 
   <td>o.a.<sub>.</sub>.Foo</td> 
  </tr> 
  <tr> 
   <td>%c{.}</td> 
   <td>org.apache.commons.test.Foo</td> 
   <td>....Foo</td> 
  </tr> 
 </tbody> 
</table>

### 3.5 对齐格式 ###

<table> 
 <thead> 
  <tr> 
   <th>%20</th> 
   <th>右对齐，不足20个字符则在文本前面用空格补足，超过20个字符则保留原文本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%-20</td> 
   <td>左对齐，不足20个字符则在文本后面用空格补足，超过20个字符则保留原文本</td> 
  </tr> 
  <tr> 
   <td>%.30</td> 
   <td>如果文本超过30个字符，则只保留最后30个字符</td> 
  </tr> 
  <tr> 
   <td>%20.30</td> 
   <td>右对齐，不足20个字符则在文本前面用空格补足，超过30个字符则只保留最后30个字符</td> 
  </tr> 
  <tr> 
   <td>%-20.30</td> 
   <td>左对齐，不足20个字符则在文本后面用空格补足，超过30个字符则只保留最后30个字符</td> 
  </tr> 
 </tbody> 
</table>

--------------------

常用模式总结如下：

<table> 
 <thead> 
  <tr> 
   <th>模式</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%d</td> 
   <td>时间</td> 
  </tr> 
  <tr> 
   <td>%t</td> 
   <td>线程名</td> 
  </tr> 
  <tr> 
   <td>%c</td> 
   <td>日志名</td> 
  </tr> 
  <tr> 
   <td>%m</td> 
   <td>日志内容</td> 
  </tr> 
  <tr> 
   <td>%n</td> 
   <td>换行</td> 
  </tr> 
  <tr> 
   <td>%p</td> 
   <td>日志等级</td> 
  </tr> 
  <tr> 
   <td>%l</td> 
   <td>日志输出所在代码位置信息</td> 
  </tr> 
 </tbody> 
</table>

更多详情可以参考 [http://logging.apache.org/log4j/2.x/manual/layouts.html][http_logging.apache.org_log4j_2.x_manual_layouts.html]

## 4 appenders ##

[appenders][] 负责把日志输出到相应的目的地。

### 4.1 控制台 ###

设置日志输出到控制台的格式：

### 4.2 日志文件 ###

设置日志输出到文件的文件名、格式、输出等级、日志大小等信息：

## 5 配置实例 ##

以下是 log4j2 配置实例，以供参考：

<?xml version="1.0" encoding="UTF-8"?>
    
    <Configuration name="xxx_log_config" status="WARN" monitorInterval="60">
    
        <Properties>
            
            <Property name="LOG_PATH">./../xxxWorkflowLogs</Property>
            
            <Property name="LOG_LEVEL_PATTERN">%7p{WARN=Warning, DEBUG=Debug, ERROR=Error, TRACE=Trace, INFO=Info} ->>>
            </Property>
            
            <Property name="CONSOLE_LOG_PATTERN">%clr{%d{ABSOLUTE}} %clr{${LOG_LEVEL_PATTERN}}
                %clr{${sys:PID}}{magenta} %clr{---} %clr{[%-15.15t]}{yellow} %clr{%-40.40c}{blue} %clr{:}{blue}
                %m%n
            </Property>
            
            <Property name="FILE_LOG_PATTERN">[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%p] - %l -> %m%n</Property>
        </Properties>
    
        <appenders>
            
            <Console name="Console">
                <PatternLayout pattern="${CONSOLE_LOG_PATTERN}"/>
            </Console>
    
            
            <RollingFile name="RollingFileInfo" fileName="${LOG_PATH}/info.log"
                         filePattern="${LOG_PATH}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd-HH}-%i.log.gz">
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${FILE_LOG_PATTERN}"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
                <DefaultRolloverStrategy max="100"/>
            </RollingFile>
    
            
            <RollingFile name="RollingFileWarn" fileName="${LOG_PATH}/warn.log"
                         filePattern="${LOG_PATH}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd-HH}-%i.log.gz">
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${FILE_LOG_PATTERN}"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
                <DefaultRolloverStrategy max="100"/>
            </RollingFile>
            
            <RollingFile name="RollingFileError" fileName="${LOG_PATH}/error.log"
                         filePattern="${LOG_PATH}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd-HH}-%i.log.gz">
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${FILE_LOG_PATTERN}"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
                <DefaultRolloverStrategy max="100"/>
            </RollingFile>
        </appenders>
    
        <loggers>
            <root level="info">
                <appender-ref ref="Console"/>
                <appender-ref ref="RollingFileInfo"/>
                <appender-ref ref="RollingFileWarn"/>
                <appender-ref ref="RollingFileError"/>
            </root>
        </loggers>
    
    </Configuration>

工程日志放置在 tomcat 根目录下的名为 xxxLogs 文件夹中。

日志级别以及优先级排序为：FATAL > ERROR > WARN > INFO > DEBUG > TRACE。日志文件分为 info.log、warn.log以及 error.log，三种类型。每种日志文件，会记录相应等级及以上的日志内容。比如 error.log 会记录 ERROR 与 FATAL 类型的数据。

当日志文件大于 100M 时，会自动归档。

归档格式为：`/$${date:yyyy-MM}/[日志等级]-%d{yyyy-MM-dd-HH}-%i.log.gz`，表示放入归档时的年月文件夹，然后把日志压缩后放入带年月日小时与序号的 gz 包中。

[image.png]: /images/20221123/a2fc64ef146743309aa7bb7fd9b703e8.png
[8af392a79689533ee75493000c610f88.png]: /images/20221123/8d5a0c7501f2408887eabb362c068451.png
[http_logging.apache.org_log4j_2.x_manual_layouts.html]: http://logging.apache.org/log4j/2.x/manual/layouts.html
[appenders]: http://logging.apache.org/log4j/2.x/manual/appenders.html