Bootstrap

Log4j2详解

文章目录


前言

在项目推进中，如果说第一件事是搭Spring框架的话，那么第二件事情就是在Sring基础上搭建日志框架，我想很多人都知道日志对于一个项目的重要性，尤其是线上Web项目，因为日志可能是我们了解应用如何执行的唯一方式。在18年大环境下，更多的企业使用Springboot和Springcloud来搭建他们的企业微服务项目，此篇文章是博主在实践中用Springboot整合log4j2日志的总结。

详解

一、常用日志框架

java.util.logging：是JDK中引入的Java原生日志框架
Log4j：Apache的一个开源项目，老旧，速度慢。
LogBack：是Log4j的一个改良版本
Log4j2：速度更快，性能更好。

二、日志门面slf4j

上述介绍的是一些日志框架的实现，这里我们需要用日志门面来解决系统与日志实现框架的耦合性。SLF4J，即简单日志门面（Simple Logging Facade for Java），它不是一个真正的日志实现，而是一个抽象层（ abstraction layer），它允许你在后台使用任意一个日志实现。

三、为什么选用log4j2

相比与其他的日志系统，log4j2丢数据这种情况少；
disruptor技术，在多线程环境下，性能高于logback等10倍以上；
利用jdk1.5并发的特性，减少了死锁的发生。

整合步骤

一、 引入jar包

springboot默认是用logback的日志框架的，所以需要排除logback，不然会出现jar依赖冲突的报错。

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-web</artifactId>  
    <exclusions><!-- 去掉springboot默认配置,springboot默认是用logback框架 -->  
        <exclusion>  
            <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>

二、SpringBoot配置文件

如果自定义了log4j2的配置文件名，需要在application.properties中配置

application.properties

#log4j2配置文件位置(resource下)
logging.config=log4j2xxxxxx.xml
#包对应的日志级别
logging.level.com.example.user=trace

如果文件名为log4j2-spring.xml则不用配置，springboot会自动识别

#logging.config=log4j2-spring.xml
logging.level.com.lhl.user=trace

三、log4j2-spring.xml配置文件模板

log4j是通过一个.properties的文件作为主配置文件的，而现在的log4j2则已经弃用了这种方式，采用的是.xml，.json或者.jsn这种方式来做。

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

<!--configuration后面的status，用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，会看到log4j2内部各种详细输出，OFF即不打印-->
<!--monitorInterval：Log4j2能够自动检测修改配置文件和重新配置本身，设置间隔数 秒-->
<configuration monitorInterval="5" status="OFF">
    <!--变量配置-->
    <properties>
        <!--格式化输出:
        %d或%date{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间,输出到毫秒的时间
        %-5level : 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
        %c或%logger{36} : Java全类名，{36}最长36个字符
        %F : Java类名
        %C : Logger的名称
        %t : 输出当前线程名称
        %p : 日志输出格式
        %m或%msg : 日志内容，即 logger.info("message")
        %n : 换行符
        %L : 行号
        %M : 日志方法名
        %l : 输出语句所在的行数, 包括类名、方法名、文件名、行数
        %thread或%t : 表示线程名
        hostName : 本地机器名
        hostAddress : 本地ip地址-->
        <property name="LOG_PATTERN" value="%style{%date{yyyy年MM月dd日 HH:mm:ss.SSS}} 线程:[%thread] 日志级别:%highlight{%-5level} 类名:%style{%logger{36}}{bright,yellow} - 日志消息:%highlight{%msg}%n%style{%throwable}{red}" />
        <property name="FILE_PATH">D:\log</property> <!--日志储存路径-->
        <property name="FILE_NAME">demo项目</property> <!--文件名-->
    </properties>

    <!-- 定义所有的输出器 -->
    <appenders>
        <!-- 输出到控制台，下面分别是 debug、info、error 级别的配置 -->
        <console name="InfoConsole" target="SYSTEM_OUT">
            <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <!--输出日志的格式: PatternLayout：自定义形式显示,SimpleLayout：简单的形式显示,HTMLLayout：HTML表格显示-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </console>
        <Console name="DebugConsole" target="SYSTEM_OUT">
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout pattern="${LOG_PATTERN}" />
        </Console>
        <Console name="ErrorConsole" target="SYSTEM_OUT">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout pattern="${LOG_PATTERN}" />
        </Console>


        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
        <!--<File name="File" fileName="${FILE_PATH}/test.html" append="false">
            <HTMLLayout pattern="${LOG_PATTERN}"/>-->
        <!--<File name="File" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>-->


        <!-- 打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年-月建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="InfoRollingFile" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.gz">
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <RollingFile name="WarnRollingFile" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <RollingFile name="ErrorRollingFile" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>
    </appenders>

    <!--定义Loggers，让appender才会生效：
    1.默认Root项目整体配置方式
    2.如果Logger有定义指定包的特殊配置,则该指定包按照Logger的配置打印-->
    <Loggers>
        <!-- Root节点用来指定项目整体的默认日志配置，此处最低级别level为 debug，整个项目的输出按照这个级别执行-->
        <Root level="info">
            <appenderRef ref="InfoConsole"/><!--启用控制台日志输出-->
            <appenderRef ref="InfoRollingFile" /><!--启用Info级别文件日志记录-->
            <appenderRef ref="WarnRollingFile" /><!--启用Warn级别文件日志记录-->
            <appenderRef ref="ErrorRollingFile"/><!--启用Error级别文件日志记录-->
            <!--<appenderRef ref="File"/>-->
        </Root>

        <!--Logger用来针对指定的package配置日志的形式，比如为指定包下的class指定不同的日志级别等。 -->
        <Logger name="org.mybatis" level="info" additivity="false"><!--过滤掉mybatis的一些无用的DEBUG信息-->
            <AppenderRef ref="InfoConsole"/>
            <AppenderRef ref="ErrorRollingFile"/>
        </Logger>
        <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false"><!--过滤掉spring的一些无用的DEBUG信息-->
            <AppenderRef ref="ErrorConsole"/>
            <AppenderRef ref="ErrorRollingFile"/>
        </Logger>
    </Loggers>
</configuration>

配置简介

一、配置参数简介

1. 日志级别

机制：如果一条日志信息的级别大于等于配置文件的级别，就记录。

  • trace：追踪，就是程序推进一下，可以写个trace输出
  • debug：调试，一般作为最低级别，trace基本不用。
  • info：输出重要的信息，使用较多
  • warn：警告，有些信息不是错误信息，但也要给程序员一些提示。
  • error：错误信息。用的也很多。
  • fatal：致命错误。

2. 输出源

  • CONSOLE（输出到控制台）
  • FILE（输出到文件）

3. 格式

  • SimpleLayout：以简单的形式显示
  • HTMLLayout：以HTML表格显示
  • PatternLayout：自定义形式显示

4. PatternLayout自定义日志输出格式

%d或%date{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间,输出到毫秒的时间%-5level : 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
%c或%logger{36} : Java全类名，{36}最长36个字符
%F : Java类名
%C : Logger的名称
%t : 输出当前线程名称
%p : 日志输出格式
%m或%msg : 日志内容，即 logger.info(“message”)
%n : 换行符
%L : 行号
%M : 日志方法名
%l : 输出语句所在的行数, 包括类名、方法名、文件名、行数
%thread : 表示线程名
hostName : 本地机器名
hostAddress : 本地ip地址

二、xml配置详解

1. 根节点Configuration

有两个属性:

  • status：用来指定log4j本身的打印日志的级别
  • monitorinterval：用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s

有两个子节点:

  • Appenders
  • Loggers(表明可以定义多个Appender和Logger).

2. 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属性)。

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中进行输出。

使用示例

1. LoggerFactory.getLogger(xxx.class);

public class LogExampleOther {
  private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExampleOther.class);
  
  public static void main(String... args) {
    log.error("Something else is wrong here");
  }
}

2. 配合lambok

使用lombok后下面的代码等效于上述的代码，这样会更方便的使用日志。

@Slf4j
public class LogExampleOther {
  public static void main(String... args) {
    log.error("Something else is wrong here");
  }
}

悦读

道可道，非常道；名可名，非常名。 无名，天地之始，有名，万物之母。 故常无欲，以观其妙，常有欲，以观其徼。 此两者，同出而异名，同谓之玄，玄之又玄，众妙之门。

最新收录
如何利用 Puppeteer 的 Evaluate 函数操作网页数据
4.二极管（常见元器件及电路基础知识）
C语言——学生信息管理系统（数组）
2024-6-1 石群电路-20
Java基于的火车票管理系统(源码+mysql+文档)
动态绑定属性
编程是什么？为什么建议零基础先学Python？附入门教程
Windows安装MySQL 5.7 ZIP
单片机毕业设计|基于stm32单片机的智能宠物投喂系统设计
安装openswitch
;