SpringBoot 日志处理

SpringBoot三 日志处理

---

比较

性能比较：Log4J2 和 Logback 都优于 log4j（不推荐使用）

配置方式：Logback最简洁，spring boot默认，推荐使用

 

1.日志配置-logback

支持日志框架：Log4J2 and Logback ，默认是使用logback

引用外部配置文件 logback配置方式：

spring boot默认会加载classpath:logback-spring.xml或者classpath:logback-spring.groovy

在application.properties中加入

logging.config=classpath:logback-zg.xml

注意：不要使用logback这个来命名，否则spring boot将不能完全实例化

#在application.properties中加入

#在application.properties中加入

logging.config=classpath:logback-zg.xml

---

logback-zg.xml

<?xml version="1.0" encoding="UTF-8"?>

<configuration>

 

    <!-- log输出格式 -->

    <property name="PATTERN" value="%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n" />

    <!-- test文件路径 -->

    <property name="TEST_FILE_PATH" value="c:/opt/zg/logs" />

    <!-- pro文件路径 -->

    <property name="PRO_FILE_PATH" value="/opt/zg/logs" />

 

    <!-- 开发环境 -->

    <springProfile name="dev">

        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">

            <encoder>

                <pattern>${PATTERN}</pattern>

            </encoder>

        </appender>

        <!-- TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF-->

        <logger name="com.example.demo" level="debug"/>

         

        <root level="info">

            <appender-ref ref="CONSOLE" />

        </root>

    </springProfile>

 

 

    <!-- 测试环境 -->

    <springProfile name="test">

        <!-- 每天产生一个文件 -->

        <appender name="TEST-FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

            <!-- 文件路径 -->

            <file>${TEST_FILE_PATH}</file>

            <append>true</append>

            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

                <!-- 文件名称 -->

                <fileNamePattern>${TEST_FILE_PATH}/info.%d{yyyy-MM-dd}.log</fileNamePattern>

                <!-- 文件最大保存历史数量 -->

                <MaxHistory>100</MaxHistory>

            </rollingPolicy>

            

            <layout class="ch.qos.logback.classic.PatternLayout">

                <pattern>${PATTERN}</pattern>

            </layout>

        </appender>

        

        <root level="info">

            <appender-ref ref="TEST-FILE" />

        </root>

    </springProfile>

 

 

    <!-- 生产环境 -->

    <springProfile name="prod">

        <appender name="PROD_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

            <file>${PRO_FILE_PATH}</file>

            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

                <fileNamePattern>${PRO_FILE_PATH}/warn.%d{yyyy-MM-dd}.log</fileNamePattern>

                <MaxHistory>100</MaxHistory>

            </rollingPolicy>

            <layout class="ch.qos.logback.classic.PatternLayout">

                <pattern>${PATTERN}</pattern>

            </layout>

        </appender>

        

        <root level="info">

            <appender-ref ref="PROD_FILE" />

        </root>

    </springProfile>

</configuration>

---

 

2.日志配置Log4J2

1).在项目的pom.xml中 去除logback的依赖包，添加log4j2的依赖包

POM.XML

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-parent</artifactId>

        <version>2.2.2.RELEASE</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    

    <groupId>com.zg</groupId>

    <artifactId>my_boot</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <name>my_boot</name>

    <description>my_boot</description>

 

    <properties>

        <java.version>1.8</java.version>

    </properties>

 

    <dependencies>

<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

<!-- 去除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>

<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

        <!-- 使用log4j2,添加log4j2的依赖包 -->

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-log4j2</artifactId>

        </dependency>

<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-test</artifactId>

            <scope>test</scope>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-devtools</artifactId>

        </dependency>

    </dependencies>

<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

 

</project>

---

2).项目中指定log4j2的配置(开发环境/生产环境/测试环境)

spring.profiles.active=dev

 

zg.secret=${random.value}

zg.number=${random.int}

zg.bignumber=${random.long}

 

zg.name=www.zg.com

zg.desc=${zg.name} is a domain name

 

#\u65F6\u95F4

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

#\u65F6\u533A\u8BBE\u7F6E

spring.jackson.time-zone=Asia/Chongqing

 

logging.config=classpath:log4j2-dev.xml

注意: spring.profiles.active= dev 与classpath的配对使用

---

1.开发环境配置:log4j2-dev.xml

<?xml version="1.0" encoding="utf-8"?>

<configuration>

    <properties>

        <!-- 输出格式 -->

        <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} |-%-5level [%thread] %c [%L] -| %msg%n</property>

    </properties>

 

 

    <appenders>

        <Console name="CONSOLE" target="system_out">

            <PatternLayout pattern="${PATTERN}" />

        </Console>

    </appenders>

    

    <loggers>

        <logger name="com.example.demo" level="info" />

        <root level="debug">

            <appenderref ref="CONSOLE" />

        </root>

    </loggers>

 

</configuration>

2.测试环境配置: log4j2-test.xml

 

<?xml version="1.0" encoding="utf-8"?>

<configuration>

    <!--先定义所有的appender-->

    <appenders>

        <!-- 这个会打印出所有的debug及以上级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->

        <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"

                     filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">

            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->

            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>

            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>

            <Policies>

                <TimeBasedTriggeringPolicy/>

                <SizeBasedTriggeringPolicy size="100 MB"/>

            </Policies>

        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"

                     filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">

            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>

            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>

            <Policies>

                <TimeBasedTriggeringPolicy/>

                <SizeBasedTriggeringPolicy size="100 MB"/>

            </Policies>

            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->

            <DefaultRolloverStrategy max="20"/>

        </RollingFile>

        <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"

                     filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">

            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>

            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>

            <Policies>

                <TimeBasedTriggeringPolicy/>

                <SizeBasedTriggeringPolicy size="100 MB"/>

            </Policies>

        </RollingFile>

    </appenders>

    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->

    <loggers>

        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->

        <logger name="org.springframework" level="INFO"></logger>

        <logger name="org.mybatis" level="INFO"></logger>

        <logger name="com.example.demo" level="debug" />

        <root level="all">

            <appender-ref ref="RollingFileInfo"/>

            <appender-ref ref="RollingFileWarn"/>

            <appender-ref ref="RollingFileError"/>

        </root>

    </loggers>

</configuration>

3.生产环境配置: log4j2-prod.xml

<?xml version="1.0" encoding="utf-8"?>

<configuration>

    <properties>

        <!-- 文件输出格式 -->

        <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} |-%-5level [%thread] %c [%L] -| %msg%n</property>

    </properties>

 

    <appenders>

        <Console name="CONSOLE" target="system_out">

            <PatternLayout pattern="${PATTERN}" />

        </Console>

    </appenders>

    

    <loggers>

        <logger name="com.example.demo" level="info" />

        <root level="debug">

            <appenderref ref="CONSOLE" />

        </root>

    </loggers>

 

</configuration>