SpringBoot学习--08配置log4j2日志详解(上)--配置使用

log4j2和log4j是一个作者，只不过log4j2是重新架构的一款日志组件，他抛弃了之前log4j的不足，以及吸取了优秀的logback的设计重新推出的一款新组件。

  • 在pom.xml中导入依赖,首先去除SpringBoot自带的logging包(logback),再导入log4j2的依赖包,
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <!-- 想要配置log4j2,就要先去除logging包 -->
      <exclusions>
        <exclusion>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
    <!-- 引用log4j2依赖包 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-log4j2</artifactId>
    </dependency>
  • 若是你只是想看看日志,这时在application配置文件中配置,
#application.properties
logging.level.root=error  #显示日志级别

#application.yml
logging:
  level: 
   root: info #显示日志级别

log4j2 中默认的日志级别为：trace < debug < info < warn < error < fatal
当设置了日志输出级别时，当前级别及以上级别的日志会输出，而当前级别以下级别的日志则不会输出，系统默认输出级别为 error，也就是说默认设置下，只有 error 和 fatal这两级日志会输出.

trace:即追踪，程序每推进一步均可输出一条trace日志，主要用于展现程序运行轨迹
debug:调试
info:输出你感兴趣的信息，一般用于基本的、高层次的诊断信息。在长时间运行的代码段开始运行及结束运行时应该产生消息，以便知道现在系统在干什么。但是这样的信息不宜太过频繁
warn:提示信息
error:错误信息，显示一个错误，或一个通用的错误情况，但还不至于会将系统挂起。这种程度的错误一般会触发邮件的发送，将消息发送到alert list中，运维人员可以在文档中记录这个bug并提交
fatal:会导致程序崩溃的重大错误，用在极端的情形中，即必须马上获得注意的情况

这时候,就可以使用系统默认的输出格式了,如图所示:

默认的输出格式

但是很多的时候我们需要进行日志的记录以及后期维护时日志的查看,所以我们需要自定义日志的配置,配置文件命名的规则如下:

SpringBoot官方文档推荐方式
  • 文件配置优先级

对应于四类配置文件：XML、 JSON、 YAML 和 properties，Log4j 分别有与之相应的 ConfigurationFactory 实现类，不同的实现类可以加载不同扩展名的配置文件中的配置信息。当 Log4j 启动时会按照一定的优先级顺序在classpath（一般是项目的src文件夹下,即在src/main/resources下）查找项目中的配置文件，若找到一个配置文件，就调用与当前文件扩展名对应的ConfigurationFactory实现类加载该配置文件中的配置信息，否则继续查找下一优先级的配置文件，若未找到任何配置文件，就使用默认配置DefaultConfiguration。
不同配置文件的优先级如下图所示：

配置文件优先级

配置文件内容:

<?xml version="1.0" encoding="UTF-8" ?>
<!-- status : 这个用于设置log4j2自身内部的信息输出,默认是OFF,可以不设置,当设置成trace时,会看到log4j2内部各种详细输出 
     monitorInterval : Log4j能够自动检测修改配置文件和重新配置本身, 设置间隔秒数。 
               注：本配置文件的目标是将不同级别的日志输出到不同文件，最大2MB一个文件， 文件数据达到最大值时，旧数据会被压缩并放进指定文件夹 -->
<Configuration status="TRACE" monitorInterval="600">

  <Properties> <!-- 配置全局变量 -->
    <!-- 配置日志文件输出目录，此配置将日志输出到tomcat根目录下的指定文件夹 -->
    <!-- <Property name="LOG_HOME">D:/logs</Property> -->
    <Property name="LOG_HOME">./target/logs</Property>
    <!-- 配置日志输出格式 -->
    <Property name="LOG_PATTERN">%d{yyyy-MM-dd 'at' HH:mm:ss.SSS} %-5level [%t] (%F:%M:%L) --- %m%xEx%n</Property>
    <!-- 配置日志输出级别 --><!-- 设置显示级别直接在这里修改 -->
    <Property name="OUT_LOG_LEVEL">INFO</Property>
    <!-- 配置日志切割的最小单位 -->
    <Property name="FILE_SIZE">2MB</Property>
  </Properties>

  <Appenders>
     <!-- 优先级从高到低分别是 OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE -->
        <!-- 单词解释： 
        Match：匹配 
        DENY：拒绝 
        Mismatch：不匹配
        ACCEPT：接受 -->
        <!-- 
        DENY，日志将立即被抛弃不再经过其他过滤器；
        NEUTRAL，有序列表里的下个过滤器过接着处理日志；
        ACCEPT，日志会被立即处理，不再经过剩余过滤器。 -->
        <!--输出日志的格式
         %d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间,输出到毫秒的时间
         %-5level : 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
         %p : 日志输出格式,输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
         %c : logger的名称 (%logger)
         %t : 输出当前线程名称
         %m : 日志内容，即 logger.info("message") 
         %n : 换行符 
         %C : Java类名(%F)
         %L : 日志输出所在行数 
         %M : 日志输出所在方法名 
         %l : 输出语句所在的行数, 包括类名、方法名、文件名、行数
         hostName : 本地机器名 
         hostAddress : 本地ip地址 -->

    <!--这个输出控制台的配置，这里输出除了debug到error级别的信息到System.out -->
    <Console name="console_out_appender" target="SYSTEM_OUT">
      <!-- 控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) . -->
      <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL" />
      <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="NEUTRAL" />
      <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="NEUTRAL" />
      <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY" />
      <!-- 输出日志的格式 -->
      <PatternLayout pattern="${LOG_PATTERN}" />
      <!-- <PatternLayout pattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/> -->
    </Console>
    <!-- 这个输出控制台的配置，这里输出error级别以上的信息到System.err，在eclipse控制台上看到的是红色文字 -->
    <Console name="console_err_appender" target="SYSTEM_ERR">
      <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY" />
      <PatternLayout pattern="${LOG_PATTERN}" />
    </Console>
    
    <!-- 运行时的测试日志 -->
    <!--   文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用 --> 
    <!--   append为TRUE表示消息增加到指定文件中，false表示消息覆盖指定的文件内容，默认值是true --> 
    <File name="INFO" fileName="${LOG_HOME}/testLog.log" append="false">
      <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="${LOG_PATTERN}"/>
    </File>
    
    <!--
            循环日志文件：日志文件大于阀值的时候，就开始写一个新的日志文件这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档

    fileName    : 指定当前日志文件的位置和文件名称
    filePattern : 指定当发生Rolling时，文件的转移和重命名规则
    SizeBasedTriggeringPolicy : 指定当文件体积大于size指定的值时，触发Rolling
    DefaultRolloverStrategy : 指定最多保存的文件个数
    TimeBasedTriggeringPolicy : 这个配置需要和filePattern结合使用
            注意:filePattern中配置的文件重命名规则是${FILE_NAME}_%d{yyyy-MM-dd}_%i，最小的时间粒度是dd，即天，TimeBasedTriggeringPolicy指定的size是1，结合起来就是每1天生成一个新文件
    -->
            
    <!-- TRACE级别日志 ; 设置日志格式并配置日志压缩格式，压缩文件独立放在一个文件夹内， 日期格式不能为冒号，否则无法生成，因为文件名不允许有冒号，此appender只输出trace级别的数据到trace.log -->
    <RollingFile name="trace_appender" immediateFlush="true" fileName="${LOG_HOME}/trace.log" filePattern="${LOG_HOME}/trace/trace - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
      <PatternLayout pattern="${LOG_PATTERN}" />
      <Policies>
        <!-- 每个日志文件最大2MB -->
        <SizeBasedTriggeringPolicy size="${FILE_SIZE}" />
      </Policies>
      <!-- 设置同一类型日志文件个数,默认为7 -->
      <!-- <DefaultRolloverStrategy max="20"/> -->  
      <Filters>
        <!-- 此Filter意思是，只输出TRACE级别的数据 DENY，日志将立即被抛弃不再经过其他过滤器； NEUTRAL，有序列表里的下个过滤器过接着处理日志； ACCEPT，日志会被立即处理，不再经过剩余过滤器。 -->
        <ThresholdFilter level="debug" onMatch="DENY" onMismatch="NEUTRAL" />
        <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY" />
      </Filters>
    </RollingFile>

    <!-- DEBUG级别日志 设置日志格式并配置日志压缩格式，压缩文件独立放在一个文件夹内， 日期格式不能为冒号，否则无法生成，因为文件名不允许有冒号，此appender只输出debug级别的数据到debug.log; -->
    <RollingFile name="debug_appender" immediateFlush="true" fileName="${LOG_HOME}/debug.log" filePattern="${LOG_HOME}/debug/debug - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
      <PatternLayout pattern="${LOG_PATTERN}" />
      <Policies>
        <!-- 每个日志文件最大2MB ; -->
        <SizeBasedTriggeringPolicy size="${FILE_SIZE}" /><!-- 按大小分 -->
        <!-- 如果启用此配置，则日志会按文件名生成新压缩文件， 即如果filePattern配置的日期格式为 %d{yyyy-MM-dd HH} ，则每小时生成一个压缩文件， 如果filePattern配置的日期格式为 %d{yyyy-MM-dd} ，则天生成一个压缩文件 -->
        <!-- <TimeBasedTriggeringPolicy interval="1" modulate="true" /> --><!-- 按天分日志文件 -->
      </Policies>
      <Filters><!-- 此Filter意思是，只输出debug级别的数据 -->
        <ThresholdFilter level="info" onMatch="DENY" onMismatch="NEUTRAL" />
        <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
      </Filters>
    </RollingFile>

    <!-- INFO级别日志 -->
    <RollingFile name="info_appender" immediateFlush="true" fileName="${LOG_HOME}/info.log" filePattern="${LOG_HOME}/info/info - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
      <PatternLayout pattern="${LOG_PATTERN}" />
      <Policies>
        <SizeBasedTriggeringPolicy size="${FILE_SIZE}" />
      </Policies>
      <Filters>
        <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL" />
        <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
      </Filters>
    </RollingFile>

    <!-- WARN级别日志 -->
    <RollingFile name="warn_appender" immediateFlush="true" fileName="${LOG_HOME}/warn.log" filePattern="${LOG_HOME}/warn/warn - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
      <PatternLayout pattern="${LOG_PATTERN}" />
      <Policies>
        <SizeBasedTriggeringPolicy size="${FILE_SIZE}" />
      </Policies>
      <Filters>
        <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL" />
        <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY" />
      </Filters>
    </RollingFile>

    <!-- ERROR级别日志 -->
    <RollingFile name="error_appender" immediateFlush="true" fileName="${LOG_HOME}/error.log" filePattern="${LOG_HOME}/error/error - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
      <PatternLayout pattern="${LOG_PATTERN}" />
      <Policies>
        <SizeBasedTriggeringPolicy size="${FILE_SIZE}" />
      </Policies>
      <Filters>
        <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY" />
      </Filters>
    </RollingFile>
    
  </Appenders>

  <!--  然后定义logger，只有定义了logger并引入的appender，appender才会生效 --> 
  <Loggers>
    <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
    <logger name="org.springframework" level="INFO" />
    <logger name="org.mybatis" level="INFO" />
    <!-- 配置日志的根节点 -->
    <!-- 定义logger，只有定义了logger并引入了appender，appender才会生效 -->
    <root level="${OUT_LOG_LEVEL}">
      <appender-ref ref="console_out_appender" />
      <appender-ref ref="console_err_appender" />
      <appender-ref ref="trace_appender" />
      <appender-ref ref="debug_appender" />
      <appender-ref ref="info_appender" />
      <appender-ref ref="warn_appender" />
      <appender-ref ref="error_appender" />
    </root> 
  </Loggers>

</Configuration>

到这里就可以使用log4j2日志了,其显示如下图:

输出日志样式
  • 但是我这种强迫一定要分包分类存放文件,如下:
项目文件分包

这时你会发现启动项目会报错,无法找到log4j2的配置文件,解决办法:

  • 在application配置文件中添加log日志配置文件地址
# yml方式
logging: 
  config: classpath:log4j2/log4j2-spring.xml

# properties方式
logging.config = classpath:log4j2/log4j2-spring.xml

再启动项目就可以成功了.

  • 使用方式
# 导包
import org.apache.logging.log4j.LogManager;

# 初始化log
private static final Logger log = LogManager.getLogger(SysDepartmentController.class);

# 使用
log.trace("======trace");
log.debug("======debug");
log.info("======info");
log.warn("======warn");
log.error("======error");

log4j2的官网:http://logging.apache.org/log4j/2.x/
Log4j2高级配置以及简单的示例:https://my.oschina.net/kkrgwbj/blog/734530
Log4j2配置项目详解:https://blog.csdn.net/womeng2009/article/details/53510913
Log4j2详解:https://www.jianshu.com/p/4ac14b9f51d2
SpringBoot官方文档:https://docs.spring.io/spring-boot/docs/current/reference/html/index.html
Log4j2日志输出路径配置:https://www.cnblogs.com/doit8791/p/5372004.html

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 217,406评论 6赞 503
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,732评论 3赞 393
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 163,711评论 0赞 353
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,380评论 1赞 293
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,432评论 6赞 392
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,301评论 1赞 301
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,145评论 3赞 418
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,008评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,443评论 1赞 314
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,649评论 3赞 334
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,795评论 1赞 347
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,501评论 5赞 345
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,119评论 3赞 328
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,731评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,865评论 1赞 269
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,899评论 2赞 370
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,724评论 2赞 354