【JavaEE】LogBack配置文件解析

作者: 吾非言 | 来源:发表于2017-10-09 21:01 被阅读248次

作者：邹峰立，微博：zrunker，邮箱：zrunker@yahoo.com，微信公众号：书客创作，个人平台：www.ibooker.cc。

本文选自书客创作平台第4篇文章。阅读原文。

书客创作

Logback是由log4j创始人设计的又一个开源日志组件。logback当前分成三个模块：logback-core，logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。

那么该如何正确的使用LogBack这个开源组件呢？
首先要引入相关jar，这里通过maven进行引入：

<!-- 3.日志：logback+slf4j（规范/接口） -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.22</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.1.1</version>
</dependency>
<!-- 实现slf4j接口并整合 -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.1.1</version>
</dependency>

Logback在项目中相当于一种规范，而slf4j相当于接口。

相关jar包已经引入，那么LogBack到底该如何配置呢？LogBack打印日志信息可以分为多个等级，等级从高到地低：OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL。在实际的开发当中，配置日志属性文件，主要是为了将项目运行时遇到的一些问题或者BUG进行输出，方便对项目进行维护。那么如何设置日志输出位置呢？

一、输出日志到控制台

在logback的核心包中提供ConsoleAppender类用来设置控制台输出。

<?xml version="1.0" encoding="UTF-8"?>  
<configuration>  
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
        <!-- encoder的默认实现类是ch.qos.logback.classic.encoder.PatternLayoutEncoder -->  
        <encoder>  
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>  
        </encoder>
    </appender>
  
    <!-- name值可以是包名或具体的类名：该包（包括子包）下的类或该类将采用此logger -->  
    <logger name="cc.ibooker.logging.info" level="INFO">
        <appender-ref ref="STDOUT" />  
    </logger>  
      
    <!-- root的默认level是DEBUG -->  
    <root level="DEBUG">  
        <appender-ref ref="STDOUT" />  
    </root>  
</configuration>

在上面配置pattern模式当中有几个属性格式说明和补充：

%d时间 %thread 线程名 %level行为级别 %logger logger名称 %method 方法名称 %message 调用方法的入参消息。

二、输出日志到文件

在logback的核心包中提供FileAppender类用来设置文件输出。

<?xml version="1.0" encoding="UTF-8"?>  
<configuration>
    <appender name="fileAppender" class="ch.qos.logback.core.FileAppender">  
        <file>/logs/ibooker.log</file>  
        <encoder><!-- 必须指定，否则不会往文件输出内容 -->  
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>  
        </encoder>  
        <append>true</append>  
        <prudent>false</prudent>  
    </appender>  

    <root level="DEBUG">  
        <appender-ref ref="fileAppender" />  
    </root>
</configuration>

注意：

1、 prudent：如果设置为true，不同JVM的file appenders能够安全地将日志输出到同一个文件中。
2、当prudent为true时，如果append设置为false，会被强行转成true。

三、滚动输出记录文件

实际生产中，每天都有大量的日志生成，单个文件（FileAppender）已经不能满足要求，RollingFileAppender继承了FileAppender，并提供了更多的功能：

每天生成一个日志文件。
将前一天的日志重命名为包含日期的格式。
根据需要，删除过期历史日志。

<appender name="rollingAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">  
    <file>/logs/ibooker.log</file>  
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
        <fileNamePattern>/logs/ibooker-%d{yyyy-MM-dd}.log</fileNamePattern>  
        <maxHistory>30</maxHistory>  
    </rollingPolicy>  
    <encoder><!-- 必须指定，否则不会往文件输出内容 -->  
        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>  
    </encoder>  
    <append>false</append>  
    <prudent>false</prudent>  
</appender>  
  
<root level="DEBUG">  
    <appender-ref ref="rollingAppender" />  
</root>

四、输出日志到不同文件

为了方便查看和归档：

不同包的日志可能要放到不同的文件中，如service层和dao层的日志；
不同日志级别：调试、信息、警告和错误等也要分文件输出。

<appender name="serviceAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>/logs/ibookerservice.log</file>  
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
        <fileNamePattern>/logs/ibookerservice-%d{yyyy-MM-dd}.log</fileNamePattern>  
    </rollingPolicy>  
    <encoder>  
        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>  
    </encoder>  
</appender>  
  
<appender name="daoAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">  
    <file>/logs/ibookerdao.log</file>  
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
        <fileNamePattern>/logs/ibookerdao-%d{yyyy-MM-dd}.log</fileNamePattern>  
    </rollingPolicy>  
    <encoder>  
        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>  
    </encoder>  
</appender>  
  
<logger name="cc.ibooker.service" level="DEBUG" additivity="false">  
    <appender-ref ref="serviceAppender" />  
</logger>  
  
<logger name="cc.ibooker.dao" level="DEBUG" additivity="false">  
    <appender-ref ref="daoAppender" />  
</logger>

最后给出一个常用的logback.xml仅供参考：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<!-- 从高到地低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
<!-- 日志输出规则 根据当前ROOT 级别，日志输出时，级别高于root默认的级别时 会输出 -->
<!-- 以下 每个配置的 filter 是过滤掉输出文件里面，会出现高级别文件，依然出现低级别的日志信息，通过filter 过滤只记录本级别的日志 -->

<!-- 属性描述 
    scan：设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true 
    scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 
    debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志文件 输入位置 -->
    <property name="logDir" value="/logs/ibooker" />
    <!-- 日志最大的历史 30天 -->
    <property name="maxHistory" value="30" />



    <!-- ConsoleAppender 控制台输出日志 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 对日志进行格式化 -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>


    <!-- ERROR级别日志 -->
    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 RollingFileAppender -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录WARN级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 最常用的滚动策略，它根据时间来制定滚动策略.既负责滚动也负责出发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志输出位置 可相对、和绝对路径 -->
            <fileNamePattern>${logDir}/%d{yyyy-MM-dd}/error-log.log</fileNamePattern>
            <!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件假设设置每个月滚动，且<maxHistory>是6， 则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除 -->
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>

        <!-- 按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。 
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> 
            <fileNamePattern>${logDir}/%d{yyyy-MM-dd}/.log.zip</fileNamePattern> 
            <minIndex>1</minIndex> 
            <maxIndex>3</maxIndex> 
        </rollingPolicy> -->
        <!-- 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动 
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> 
            <maxFileSize>5MB</maxFileSize> 
        </triggeringPolicy> -->

        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>



    <!-- WARN级别日志 appender -->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录WARN级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${logDir}/%d{yyyy-MM-dd}/warn-log.log</fileNamePattern>
            <!-- 日志最大的历史 60天 -->
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>



    <!-- INFO级别日志 appender -->
    <appender name="INFO"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录INFO级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${logDir}/%d{yyyy-MM-dd}/info-log.log</fileNamePattern>
            <!-- 日志最大的历史 60天 -->
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>



    <!-- DEBUG级别日志 appender -->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录DEBUG级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${logDir}/%d{yyyy-MM-dd}/debug-log.log</fileNamePattern>
            <!-- 日志最大的历史 60天 -->
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>



    <!-- TRACE级别日志 appender -->
    <appender name="TRACE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录ERROR级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>TRACE</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${logDir}/%d{yyyy-MM-dd}/trace-log.log</fileNamePattern>
            <!-- 日志最大的历史 60天 -->
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="java.sql.PreparedStatement" value="DEBUG" />
    <logger name="java.sql.Connection" value="DEBUG" />
    <logger name="java.sql.Statement" value="DEBUG" />
    <logger name="com.ibatis" value="DEBUG" />
    <logger name="com.ibatis.common.jdbc.SimpleDataSource" value="DEBUG" />
    <logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG" />
    <logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate" value="DEBUG" />



    <!-- root级别 DEBUG -->
    <root level="debug">
        <!-- 控制台输出 -->
        <appender-ref ref="STDOUT" />
        <!-- 文件输出 -->
        <appender-ref ref="ERROR" />
        <appender-ref ref="INFO" />
        <appender-ref ref="WARN" />
        <appender-ref ref="DEBUG" />
        <appender-ref ref="TRACE" />
    </root>
</configuration>

在使用的时候只需要将该配置文件导入工程的根目录即可。

阅读原文

微信公众号：书客创作

【JavaEE】LogBack配置文件解析

一、输出日志到控制台

二、输出日志到文件

三、滚动输出记录文件

四、输出日志到不同文件

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

伴职创作「banzhi.cc」

书客创作[ibooker.cc]