Logback介绍及配置使用方法

淩亂°似流年 2022-07-15 05:22 212阅读 0赞

**1、简介**  
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是要与SLF4J结合起来用两个组件的官方网站如下：

logback的官方网站： [http://logback.qos.ch][http_logback.qos.ch]  
SLF4J的官方网站：[http://www.slf4j.org][http_www.slf4j.org]

**2、Logback的配置介绍**  
**2.1 Logger、appender及layout**  
**Logger**作为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也可以定义日志类型、级别。  
**Appender**主要用于指定日志输出的目的地，目的地可以是控制台、文件、 MySQL、 Oracle和其他数据库等。  
**Layout** 负责把事件转换成字符串，格式化的日志信息的输出。

**2.2 logger context**  
各个logger都被关联到一个LoggerContext，LoggerContext负责制造logger，也负责以树结构排列各logger。其他所有logger也通过org.slf4j.LoggerFactory类的静态方法getLogger取得。getLogger方法以 logger名称为参数。用同一名字调用LoggerFactory.getLogger方法所得到的永远都是同一个logger对象的引用。

**2.3 有效级别及级别的继承**  
Logger可以被分配级别。级别包括：TRACE、DEBUG、INFO、WARN和ERROR，定义于ch.qos.logback.classic.Level类。如果logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。root logger默认级别是 DEBUG。

**2.4 打印方法与基本的选择规则**  
打印方法决定记录请求的级别。例如，如果L是一个logger实例，那么语句 L.info(“..”)是一条级别为INFO的记录语句。记录请求的级别在高于或等于其logge 的有效级别时被称为被启用，否则称为被禁用。记录请求级别为p，其logger的有效级别为 q，只有则当 p>=q时，该请求才会被执行。该规则是 logback 的核心。级别排序为： TRACE < DEBUG < INFO < WARN < ERROR

**3、Logback的默认配置**  
如果配置文件logback-test.xml和logback.xml都不存在，那么logback默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根logger的ConsoleAppender组成。输出用模式为`%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n` 的 PatternLayoutEncoder进行格式化。root logger默认级别是DEBUG。

**3.1 Logback的配置文件**  
Logback配置文件的语法非常灵活。正因为灵活，所以无法用 DTD 或 XML schema 进行定义。尽管如此，可以这样描述配置文件的基本结构：以`<configuration>`开头，后面有零个或多个`<appender>`元素，有零个或多个`<logger>`元素，有最多一个`<root>`元素。

**3.2 Logback默认配置的步骤**  
(1)尝试在classpath下查找文件logback-test.xml；  
(2)如果文件不存在，则查找文件logback.xml；  
(3)如果两个文件都不存在，logback用 BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。

**3.3 maven pom.xml配置**

<dependency> 
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.0.13</version>
    </dependency>

在配置好后，除了logback-classic-1.0.13.jar，他会自动拉取拉slf4j-api-1.7.21.jar以及logback-core-1.0.13.jar到你的项目中。

**3.4 Logback.xml 文件**

<?xml version="1.0" encoding="UTF-8" ?>
    <configuration scan="true" scanPeriod="120 seconds">
        
        
        <property name="log.base" value="/var/logs/" />
    
    
        <property name="debug" value="debug/" />
        <property name="info" value="info/" />
        <property name="warn" value="warn/" />
        <property name="error" value="error/" />
    
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            
            <encoder>
                
                <pattern>%date [%thread] [%level] %logger Line:%L - %msg %n</pattern>
            </encoder>
        </appender>
    
        
        <appender name="DEBUGFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.base}${debug}debug.%d{yyyy-MM-dd}.log</fileNamePattern>
                <maxHistory>30</maxHistory>
            </rollingPolicy>
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>DEBUG</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <encoder>
                <pattern>%date [%thread] [%level] %logger Line:%L - %msg %n</pattern>
            </encoder>
        </appender>
    
        <appender name="INFOFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.base}${info}info.%d{yyyy-MM-dd}.log</fileNamePattern>
                <maxHistory>30</maxHistory>
            </rollingPolicy>
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <encoder>
                <pattern>%date [%thread] [%level] %logger Line:%L - %msg %n</pattern>
            </encoder>
        </appender>
    
        <appender name="WARNFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.base}${warn}warn.%d{yyyy-MM-dd}.log</fileNamePattern>
                <maxHistory>30</maxHistory>
            </rollingPolicy>
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>WARN</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <encoder>
                <pattern>%date [%thread] [%level] %logger Line:%L - %msg %n</pattern>
            </encoder>
        </appender>
    
        <appender name="ERRORFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.base}${error}error.%d{yyyy-MM-dd}.log</fileNamePattern>
                <maxHistory>30</maxHistory>
            </rollingPolicy>
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <encoder>
                <pattern>%date [%thread] [%level] %logger Line:%L - %msg %n</pattern>
            </encoder>
        </appender>
    
        
    
        
        <root level="INFO">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="DEBUGFILE" />
            <appender-ref ref="INFOFILE" />
            <appender-ref ref="WARNFILE" />
            <appender-ref ref="ERRORFILE" />
        </root>
    </configuration>

**4、在程序用引用Logback**

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class TestLogBack{ 
         //定义一个全局的记录器，通过LoggerFactory获取
         private final static Logger logger = LoggerFactory.getLogger(TestLogBack.class); 
    
        public static void main(String[] args) {
            logger.info("logback成功了");
            logger.error("logback发生错误");
        }
    }

[http_logback.qos.ch]: http://logback.qos.ch
[http_www.slf4j.org]: http://www.slf4j.org