美文网首页
SpringBoot中Log4j2的使用笔记

SpringBoot中Log4j2的使用笔记

作者: 树蜂 | 来源:发表于2018-12-18 17:08 被阅读0次

    本文是本人在SpringBoot中使用Log4j2的笔记,若有误还请指正。
    本文目录
    1、依赖配置
    2、Log4j2配置
    3、报错处理
    4、使用


    1、添加依赖,并去除默认的log依赖

    <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <!-- 去掉默认log配置 -->  
                    <exclusion>  
                        <groupId>org.springframework.boot</groupId>  
                        <artifactId>spring-boot-starter-logging</artifactId>  
                    </exclusion>  
                    
                    <exclusion>
                        <artifactId>logback-classic</artifactId>
                        <groupId>ch.qos.logback</groupId>
                    </exclusion>
                    
                </exclusions> 
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <!-- 引入log4j2依赖 -->  
            <dependency> 
                <groupId>org.springframework.boot</groupId>  
                <artifactId>spring-boot-starter-log4j2</artifactId>  
            </dependency>
            
        </dependencies>
    

    因为可能存在很多个依赖包含logging这个包,如果存在的话都得添加去除默认的logging,不然log4j2不会生效,因此可以使用全局去除配置,这样就不用每个依赖都单独去除了

    推荐全局去除
    <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>logback-classic</artifactId>
                <exclusions>
                    <exclusion>
                        <groupId>*</groupId>
                        <artifactId>*</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    
                  <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
                <exclusions>
                    <exclusion>
                        <groupId>*</groupId>
                        <artifactId>*</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    

    2、Log4j2配置

    在resources文件夹添加文件log4j2.xml内容如下

    <?xml version="1.0" encoding="UTF-8"?>
    <!--设置log4j2的自身log级别为warn-->
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
    <!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,
        当设置成trace时,会看到log4j2内部各种详细输出-->
    <!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数-->
    <configuration status="warn" monitorInterval="5">
        <Properties>
            <!-- 日志模板 -->
            <Property name="log_pattern" value="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <!-- 存储日志文件路径 -->
            <Property name="file_path" value="${sys:user.home}/logs/jsf/hello"/>
            <!-- 日志文件的最大容量,超过该值就进行备份 -->
            <Property name="file_max_size" value="1MB"/>
            <!-- 备份的文件夹名称 -->
            <Property name="backup_folder" value="$${date:yyyy-MM}"/>
            <!-- 备份文件的后缀 -->
            <Property name="backup_file_suffix" value="-%d{yyyy-MM-dd}-%i.log"/>
        </Properties>
        
        <!--定义appender-->
        <appenders>
        
            <!--控制台的输出配置-->
            <console name="Console" target="SYSTEM_OUT">
                <!--输出日志的格式-->
                <PatternLayout pattern="${log_pattern}"/>
            </console>
            
            <!-- 所有级别的日志会存入该文件,当append属性设置为false时,每次启动程序会自动清空 -->
            <File name="AllLog" fileName="${file_path}/all_log.log" append="false">
                <!-- <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/> -->
                <PatternLayout pattern="${log_pattern}"/>
            </File>
            
            <!-- 
            该RollingFile存储INFO级别的日志,
            默认存储到 fileName 文件中
            超过SizeBasedTriggeringPolicy的设定值,则存储到 filePattern 文件中
            -->
            <RollingFile name="RollingFileInfo" fileName="${file_path}/info.log"
                         filePattern="${file_path}/${backup_folder}/info${backup_file_suffix}">
                <Filters>
                    <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
                    <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
                    <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
                </Filters>
                 <!-- 写入日志文件的模板 -->
                <PatternLayout pattern="${log_pattern}"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="${file_max_size}"/>
                </Policies>
                <!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,超过该数量,会滚动删除前面的记录 -->
                <DefaultRolloverStrategy max="20"/>
            </RollingFile>
            
            <RollingFile name="RollingFileWarn" fileName="${file_path}/warn.log"
                         filePattern="${file_path}/${backup_folder}/warn${backup_file_suffix}">
                <Filters>
                    <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
                    <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
                </Filters>
                <PatternLayout pattern="${log_pattern}"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="${file_max_size}"/>
                </Policies>
            </RollingFile>
     
            <RollingFile name="RollingFileError" fileName="${file_path}/error.log"
                         filePattern="${file_path}/${backup_folder}/error${backup_file_suffix}">
                <ThresholdFilter level="ERROR"/>
                <PatternLayout pattern="${log_pattern}"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="${file_max_size}"/>
                </Policies>
            </RollingFile>
     
        </appenders>
        
        <!-- 只有定义了logger并使用appender-ref,appender才会生效 -->
        <loggers>
            <!--过滤掉spring和hibernate的一些无用的debug信息-->
            <logger name="org.springframework" level="INFO"/>
            <logger name="org.mybatis" level="INFO">
                <!-- 添加如下设置,控制台会再打印一次 -->
                <AppenderRef ref="Console"/>
            </logger>
            <root level="INFO">
                <appender-ref ref="Console"/>
                <appender-ref ref="RollingFileInfo"/>
                <appender-ref ref="RollingFileWarn"/>
                <appender-ref ref="RollingFileError"/>
                <appender-ref ref="AllLog"/>
            </root>
        </loggers>
     
    </configuration>
    

    3、报错处理

    1)假如出现如下提示,则说明两个日志包有冲突,删除其中一个即可。
    例如进到文件夹C:/Users/Administrator/.m2/repository/org/apache/logging/log4j/log4j-slf4j-impl/2.10.0,将log4j-slf4j-impl-2.10.0.jar删除

    SLF4J: Class path contains multiple SLF4J bindings.
    SLF4J: Found binding in [jar:file:/C:/Users/Administrator/.m2/repository/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar!/org/slf4j/impl/StaticLoggerBinder.class]
    SLF4J: Found binding in [jar:file:/C:/Users/Administrator/.m2/repository/org/apache/logging/log4j/log4j-slf4j-impl/2.10.0/log4j-slf4j-impl-2.10.0.jar!/org/slf4j/impl/StaticLoggerBinder.class]
    SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
    SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]

    2)当 log4j2 不生效,需要排查其他包是否也有使用log,可参考springboot2.0.4整合log4j2不生效,或者使用上文提到的全局去除。

    4、使用

    final Logger logger = LoggerFactory.getLogger(this.getClass());
    
    logger.trace("I am trace log.");
            logger.debug("I am debug log.");
            logger.warn("I am warn log.");
            logger.error("I am error log.");
    

    相关文章

      网友评论

          本文标题:SpringBoot中Log4j2的使用笔记

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