Spring Boot Log4j2的配置使用详解

后台程序开发及上线时，一般都会用到log信息打印及log日志记录，开发时通过log信息打印可以快速的定位问题所在，帮助我们快捷开发。程序上线后如遇到bug或错误，此时则需要日志记录来查找发现问题所在。

spring boot 可以集成很多不同的日志系统，其中最常用的apache log4j，而log4j 2是log4j的升级版本，log4j 2相对于log4j 1.x 有了很多显著的改善。所以这篇博客就直接来说说spring boot如何集成并配置使用log4j2.

1. 导入log4j2的包

如果你使用gradle，则在 build.gradle 文件中添加以下依赖。示例代码中使用的是gradle方式。

dependencies {
  // log4j2
  compile "org.apache.logging.log4j:log4j-api:2.8"
  compile "org.apache.logging.log4j:log4j-core:2.8"
  // 用来支持logger中的async
  compile 'com.lmax:disruptor:3.3.6'
}

如果你使用maven，则在 pom.xml 文件中添加以下依赖。

<dependencies>
 <dependency>
  <groupid>org.apache.logging.log4j</groupid>
  <artifactid>log4j-api</artifactid>
  <version>2.8</version>
 </dependency>

 <dependency>
  <groupid>org.apache.logging.log4j</groupid>
  <artifactid>log4j-core</artifactid>
  <version>2.8</version>
 </dependency>

 <dependency>
  <groupid>com.lmax</groupid>
  <artifactid>disruptor</artifactid>
  <version>3.3.6</version>
 </dependency>
</dependencies>

2. 添加log4j2配置文件

在项目的resources资源文件根目录下创建 log4j2.xml 文件并复制以下代码到文件中。

<?xml version="1.0" encoding="utf-8"?>
<!-- configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，
 你会看到log4j2内部各种详细输出。可以设置成off(关闭)或error(只输出错误信息)
-->
<configurationstatus="off">
  <!-- 日志文件目录和压缩文件目录配置 -->
  <properties>
    <propertyname="filename">/home/kylin/log/knight/spring_log</property>
    <propertyname="filegz">/home/kylin/log/knight/spring_log/7z</property>
  </properties>

  <appenders>
    <!-- 输出控制台日志的配置 -->
    <consolename="console"target="system_out">
      <!--控制台只输出level及以上级别的信息（onmatch），其他的直接拒绝（onmismatch）-->
      <thresholdfilterlevel="info"onmatch="accept"onmismatch="deny"/>
      <!-- 输出日志的格式 -->
      <patternlayoutpattern="%d{hh:mm:ss.sss} [%t] %-5level %logger{36} - %msg%n"/>
    </console>

    <!-- 打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
    <rollingrandomaccessfilename="infofile"filename="${filename}/web-info.log"immediateflush="false"
                 filepattern="${filegz}/$${date:yyyy-mm}/app-%d{mm-dd-yyyy}-%i.web-info.gz">
      <patternlayoutpattern="%d{yyyy-mm-dd 'at' hh:mm:ss z} [%t] %-5level %logger{36} %l %m - %msg%xex%n"/>
      <policies>
        <timebasedtriggeringpolicyinterval="6"modulate="true"/>
        <sizebasedtriggeringpolicysize="50 mb"/>
      </policies>
      <filters>
        <!-- 只记录info和warn级别信息 -->
        <thresholdfilterlevel="error"onmatch="deny"onmismatch="neutral"/>
        <thresholdfilterlevel="info"onmatch="accept"onmismatch="deny"/>
      </filters>
      <!-- 指定每天的最大压缩包个数，默认7个，超过了会覆盖之前的 -->
      <defaultrolloverstrategymax="50"/>
    </rollingrandomaccessfile>

    <!-- 存储所有error信息 -->
    <rollingrandomaccessfilename="errorfile"filename="${filename}/web-error.log"immediateflush="false"
                 filepattern="${filegz}/$${date:yyyy-mm}/app-%d{mm-dd-yyyy}-%i.web-error.gz">
      <patternlayoutpattern="%d{yyyy-mm-dd 'at' hh:mm:ss z} [%t] %-5level %logger{36} %l %m - %msg%xex%n"/>
      <policies>
        <timebasedtriggeringpolicyinterval="6"modulate="true"/>
        <sizebasedtriggeringpolicysize="50 mb"/>
      </policies>
      <filters>
        <!-- 只记录error级别信息 -->
        <thresholdfilterlevel="error"onmatch="accept"onmismatch="deny"/>
      </filters>
      <!-- 指定每天的最大压缩包个数，默认7个，超过了会覆盖之前的 -->
      <defaultrolloverstrategymax="50"/>
    </rollingrandomaccessfile>
  </appenders>

  <!-- 全局配置，默认所有的logger都继承此配置 -->
  <loggers>
    <!-- asyncroot - 异步记录日志 - 需要lmax disruptor的支持 -->
    <asyncrootlevel="info"additivity="false">
      <appenderrefref="console"/>
      <appenderrefref="infofile"/>
      <appenderrefref="errorfile"/>
    </asyncroot>
  </loggers>
</configuration>

3. 编写log4j2辅助类

做好以上的配置之后，我们可以编写一个辅助类，让我们更方便的使用log4j2来记录日志。

在utils包中创建 l.java 类文件。

package com.spring.log4j2.utils;

import org.apache.logging.log4j.logmanager;
import org.apache.logging.log4j.logger;

/**
 * logger 日志记录辅助类
 * 
 * created by kylin on 2017/5/11.
 */
public classl{

  private static final logger logger = logmanager.getlogger();

  privatel(){
    /* cannot be instantiated */
    throw new unsupportedoperationexception("cannot be instantiated");
  }

  publicstaticloggergetlogger(){
    return logger;
  }

  publicstaticvoidt(string msg){
    logger.trace(msg);
  }

  publicstaticvoidd(string msg){
    logger.debug(msg);
  }

  publicstaticvoidi(string msg){
    logger.info(msg);
  }

  publicstaticvoidw(string msg){
    logger.warn(msg);
  }

  publicstaticvoide(string msg){
    logger.error(msg);
  }
}

编写完辅助类，使用起来就很简单了，通过下面的代码就可以轻松使用。

@controller
public classwebcontroller{
  @requestmapping("/")
  publicstringindex(){
    string msg = "spring boot系列之log4j2的配置及使用";
    l.t(msg);
    l.d(msg);
    l.i(msg);
    l.w(msg);
    l.e(msg);
    return "index";
  }
}

这里的辅助类只是写了一些基本的使用方法，你可以根据你的需求进行定制，增加更多的辅助方法。对于辅助类中没有提供的方法也可以使用 l.getlogger() 方法获取logger实例来使用。

4. 结果验证

日志的level分级：trace < debug < info < warn < error < fatal。

因为我的log4j2中的level设置的是 info 级别。所以打印信息中只能看到 info 、 warn 、 error 三种级别(fatal级别的信息没有打印，否则也可以看到)。

打印信息如下图所示：

同时在电脑系统中生成了log文件，如下图所示：

观察路径可以发现，这个路径正是在 log4j2.xml 中设置的路径：

<!-- 日志文件目录和压缩文件目录配置 -->
<properties>
  <propertyname="filename">/home/kylin/log/knight/spring_log</property>
  <propertyname="filegz">/home/kylin/log/knight/spring_log/7z</property>
</properties>

5. 更多

log4j2的github地址：

本教程的示例代码地址：https://github.com/dkylin/springboot-sample/tree/master/springboot-log4j2

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。