美文网首页springboot
SpringBoot 使用log4j2日志配置

SpringBoot 使用log4j2日志配置

作者: 月弦 | 来源:发表于2019-10-15 14:10 被阅读0次

    前言

    • Apache Log4j2 是对 Log4j 的升级,它比其前身 Log4j 1.x 提供了重大改进,并提供了 Logback 中可用的许多改进,同时修复了 Logback 的 architecture 中的一些固有问题。
    • Spring Boot 默认使用 logback,但相比较而言,log4j2 在性能上面会更好。SpringBoot 高版本都不再支持 log4j,而是支持 log4j2。log4j2 在使用方面与 log4j 基本上没什么区别,比较大的区别是 log4j2 不再支持 properties 配置文件,支持 xml、json、xml格式的文件。

    一、pom.xml文件

    disruptor为log4j2 异步依赖,可根据自己的需求自行配置,本文未使用。同时这里也使用了lombok。下面有例子。

        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <!--排除spring-boot-starter-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>
    
            <!--用来支持Logger中的Async-->
            <dependency>
                <groupId>com.lmax</groupId>
                <artifactId>disruptor</artifactId>
                <version>3.4.2</version>
            </dependency>
    
            <!--lombok-->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    

    二、log4j2配置文件

    log4j2异步配置已注释,需要的可自行配置。具体配置详解可以参考log4j2配置全解

    <?xml version="1.0" encoding="UTF-8"?>
    <!-- Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,
     你会看到log4j2内部各种详细输出。可以设置成OFF(关闭)或Error(只输出错误信息)
    -->
    <Configuration status="info">
    
        <!-- 日志文件目录和压缩文件目录配置 -->
        <Properties>
            <Property name="fileName">logs/spring-boot-log4j2</Property>
            <Property name="fileGz">logs/spring-boot-log4j2/7z</Property>
            <property name="PATTERN">%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</property>
        </Properties>
    
        <Appenders>
    
            <!-- 输出控制台日志的配置 -->
            <Console name="console" target="SYSTEM_OUT">
                <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
                <!-- 输出日志的格式 -->
                <PatternLayout pattern="${PATTERN}" charset="UTF-8"/>
            </Console>
    
            <!-- 打印出所有的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档 -->
            <!--immediateFlush默认为true-->
            <RollingRandomAccessFile name="infoFile" fileName="${fileName}/log-info.log" immediateFlush="true"
                                     filePattern="${fileGz}/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.web-info.gz">
                <PatternLayout pattern="${PATTERN}" charset="UTF-8"/>
    
                <Policies>
                    <TimeBasedTriggeringPolicy interval="6" modulate="true"/>
                    <SizeBasedTriggeringPolicy size="50 MB"/>
                </Policies>
    
                <Filters>
                    <!-- 只记录info和warn级别信息 -->
                    <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/>
                    <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
                </Filters>
    
                <!-- 指定每天的最大压缩包个数,默认7个,超过了会覆盖之前的 -->
                <DefaultRolloverStrategy max="50"/>
            </RollingRandomAccessFile>
    
            <!-- 存储所有error信息 -->
            <RollingRandomAccessFile name="errorFile" fileName="${fileName}/log-error.log" immediateFlush="true"
                                     filePattern="${fileGz}/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.web-error.gz">
                <PatternLayout pattern="${PATTERN}" charset="UTF-8"/>
    
                <Policies>
                    <TimeBasedTriggeringPolicy interval="6" modulate="true"/>
                    <SizeBasedTriggeringPolicy size="50 MB"/>
                </Policies>
    
                <Filters>
                    <!-- 只记录error级别信息 -->
                    <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
                </Filters>
    
                <!-- 指定每天的最大压缩包个数,默认7个,超过了会覆盖之前的 -->
                <DefaultRolloverStrategy max="50"/>
            </RollingRandomAccessFile>
        </Appenders>
    
        <!-- 全局配置,默认所有的Logger都继承此配置 -->
        <Loggers>
            <!-- All < Trace < Debug < Info < Warn < Error < Fatal < OFF. -->
            <!-- 程序会打印高于或等于所设置级别的日志,设置的日志等级越高,打印出来的日志就越少。-->
            <!-- 此level设置的日志级别,是过滤项目中输出的日志信息,和ThresholdFilter的level有所区别 -->
            <Root level="info">
                <AppenderRef ref="console"/>
                <AppenderRef ref="infoFile"/>
                <AppenderRef ref="errorFile"/>
            </Root>
            <!--第三方的软件日志级别 -->
            <logger name="org.springframework" level="info" additivity="true">
            </logger>
    
            <!-- AsyncRoot - 异步记录日志 - 需要LMAX Disruptor的支持 -->
            <!--<AsyncRoot level="debug" additivity="false">-->
            <!--<AppenderRef ref="console"/>-->
            <!--<AppenderRef ref="infoFile"/>-->
            <!--<AppenderRef ref="errorFile"/>-->
            <!--</AsyncRoot>-->
        </Loggers>
    </Configuration>
    

    三、controller类

    • 未使用lombok。
    import org.apache.logging.log4j.LogManager;
    import org.apache.logging.log4j.Logger;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class IndexController {
    
        private static final Logger logger = LogManager.getLogger(IndexController.class);
    
        @RequestMapping("/index")
        public String index() {
            logger.debug("记录debug日志............");
            logger.info("访问了index方法............");
            logger.warn("访问了warn方法............");
            logger.error("记录了error错误日志............");
            logger.fatal("访问了fatal方法............");
    
            try {
                int i = 0;
                int j = 1 / i;
            } catch (Exception e) {
                logger.error("错误异常............:", e);
            }
            return "index";
        }
    }
    
    • 使用lombok。
    import lombok.extern.log4j.Log4j2;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @Log4j2
    public class IndexController2 {
    
        @RequestMapping("/index2")
        public String index2() {
    
            log.debug("记录debug日志");
            log.info("访问了index方法");
            log.warn("访问了warn方法");
            log.error("记录了error错误日志");
            log.fatal("访问了fatal方法");
    
            try {
                int i = 0;
                int j = 1 / i;
            } catch (Exception e) {
                log.error("错误异常:", e);
            }
            return "index2";
        }
    }
    

    相关文章

      网友评论

        本文标题:SpringBoot 使用log4j2日志配置

        本文链接:https://www.haomeiwen.com/subject/zmpjmctx.html