spring boot + log4j2

由于本人技术有限, 没有弄清楚为什么选择日志框架优先使用 log4j2, 我也一样是是通过其他博主的文章中的压力测试报告发现 log4j2 的异步输出方式远高于 spring boot 自带的 logback, 不过不管是 logback, 还是 log4j2 它们的作者都是同一人.

这里还提一下 slf4j, 它是一个经典的门面模式的框架 (如 jdbc), 就是一套接口定义, 不负责具体的实现. 所以一般组合就是 slf4j + 日志打印驱动框架了.

导入 spring boot + log4j2 依赖, spring-boot-starter-web 里面是有依赖 spring-boot-starter 的.

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <!-- spring boot 默认使用 slf4j + logback, 不排除这个依赖默认还是用的自带的 logback -->
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-log4j2 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

创建配置文件 log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="INFO" monitorInterval="30">

    <properties>
        <!--日志格式, %X 取线程相关联的NDC, NDC对象里面是存了请求的栈信息的, 可以借助它取请求参数里面的变量-->
        <property name="LOG_CONVERSION_PATTERN" value="%d -[%p] [%X{sessionId}] %c:L%L - %m%n"/>
        <!--单个日志文件大小-->
        <property name="MAX_FILE_SIZE" value="100MB"/>
        <!--日志保存时间-->
        <property name="MAX_HISTORY" value="P60D"/>
        <!--日志根路径-->
        <property name="BASE_LOG_PATH" value="logs"/>
        <!--日志应用名，${sys:application_name}是系统变量中配置的, 如vm中配置-Dapplication_name="xxx"-->
        <property name="SERVER_NAME" value="${sys:application_name}"/>
    </properties>
    
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_CONVERSION_PATTERN}"/>
        </console>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <File name="log" fileName="${BASE_LOG_PATH}/${SERVER_NAME}/catalina.out" append="false">
            <PatternLayout pattern="${LOG_CONVERSION_PATTERN}"/>
        </File>
        <!-- 这个会打印出所有的info及以上级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFile" fileName="${BASE_LOG_PATH}/${SERVER_NAME}/logs/info.log"
                     filePattern="${BASE_LOG_PATH}/${SERVER_NAME}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz">
            <!--输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_CONVERSION_PATTERN}"/>
            <Policies>
                <!-- 按天打包日志 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 配合上一个配置, 表示当日满 100M 再打包一次 -->
                <SizeBasedTriggeringPolicy size="${MAX_FILE_SIZE}"/>
            </Policies>
            <DefaultRolloverStrategy>
                <!-- 配置删除日志文件的周期, maxDepth 为文件深度, IfFileName 配置会被删除的文件后缀 -->
                <Delete basePath="${BASE_LOG_PATH}/${SERVER_NAME}/logs" maxDepth="2">
                    <IfFileName glob="*/*.log.gz"/>
                    <IfLastModified age="${MAX_HISTORY}" />
                </Delete>
            </DefaultRolloverStrategy>

        </RollingFile>
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <!--<logger name="org.springframework" level="INFO"></logger>
        <logger name="org.mybatis" level="INFO"></logger>-->
        <root level="all">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFile"/>
        </root>
    </loggers>
</configuration>

获取日志输入对象方式1:

private static Logger log = LoggerFactory.getLogger(XXX.class)

方式2, 需要导入 lombok 的依赖:

@Log4j2 //还可以使用@slf4j
public class XXX