spring-boot集成log4j2

spring-boot集成log4j2

常用日志框架

• java.util.logging：是JDK在1.4版本中引入的Java原生日志框架
• Log4j：Apache的一个开源项目，可以控制日志信息输送的目的地是控制台、文件、GUI组件等，可以控制每一条日志的输出格式，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。虽然已经停止维护了，但目前绝大部分企业都是用的log4j。
• LogBack：是Log4j的一个改良版本
• Log4j2：Log4j2已经不仅仅是Log4j的一个升级版本了，它从头到尾都被重写了

门面日志slf4j

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

使用了slf4j后，对于应用程序来说，无论底层的日志框架如何变，应用程序不需要修改任意一行代码，就可以直接上线了。

1、引入log4j2依赖

<!--集成log4j2依赖-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

2、禁用默认自带日志

springboot默认用logback，所以要排除logback，不然会jar包冲突。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

3、配置

使用xml进行日志配置，yml与properties对log4j2不是很友好

resources要目录下建立log4j2.xml文件，

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<configuration status="OFF">
    <properties>
        <!-- 服务器生产环境日志目录 -->
        <property name="SERVER_HOME_PATH">./logs/</property>
        <!-- 日志目录 -->
        <property name="LOG_HOME">${SERVER_HOME_PATH}</property>
        <!-- 日志备份目录 -->
        <property name="BACKUP_HOME">{LOG_HOME}/backup</property>
        <!-- 系统/服务名称 用于生成.log名称与日志切分名称-->
        <property name="SERVER_NAME">saas-agent</property>
    </properties>
    <appenders>
        <!-- 定义控制台输出 生产环境可以去掉-->
        <Console name="Console" target="SYSTEM_OUT" follow="true">
            <!--设置日志格式及颜色-->
            <PatternLayout
                    pattern="[%TraceId] [%style{%d{HH:mm:ss.SSS}}{bright,green}][%highlight{%-5level}][%style{%.36c %-4L}{bright,yellow}]: %msg%n%style{%throwable}{red}"
                    disableAnsi="false" noConsoleNoAnsi="false"/>
        </Console>
        <!-- 生产环境文件日志 -->
        <RollingRandomAccessFile name="ProductEnvLog" fileName="${LOG_HOME}/current/${SERVER_NAME}.log"
                                 filePattern="${LOG_HOME}/%date{yyyy-MM-dd}/${SERVER_NAME}/monitor-%d{yyyyMMdd-HH}.log">
            <PatternLayout pattern="[%TraceId] %date{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %.36c %-4L - %msg%xEx%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
        </RollingRandomAccessFile>
    </appenders>
    <loggers>
        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="ProductEnvLog"/>
        </root>
        <logger level="debug" name="com.shuhai"/>
        <logger level="debug" name="java.sql"/>
        <logger level="warn" name="org.apache.tomcat"/>
        <logger level="debug" name="com.shuhai.dao"/>
    </loggers>
</configuration>

4、测试

@GetMapping("/testLog")
    public String testLog() {
        log.info("test info");
        log.debug("test info");
        log.warn("test warn");
        log.trace("test trace");
        log.error("test error");
        return "agent test log .....";
    }

5、常见问题

• maven依赖冲突
• log4j2.xml相关配置是否正常