LogBack的简单使用

落日映苍穹つ 2022-05-07 23:38 128阅读 0赞

### 文章目录 ###

*   *  0. 为什么要使用logback
     *  1. logback的pom 文件导入
     *  2. logback的配置
     *  3. logback文件的解释

## 0. 为什么要使用logback ##

官方文档介绍

*  更快的实施

基于我们之前关于log4j的工作，已经重写了logback内部，以便在某些关键执行路径上执行大约十倍的速度。不仅logback组件更快，而且内存占用更少。

*  大量的测试

Logback包含了在几年和无数小时工作中开发的大量测试。虽然log4j也经过测试，但logback将测试带到了完全不同的水平。在我们看来，这是优先于log4j进行logback的最重要原因。您希望您的日志框架即使在不利条件下也能够坚如磐石且可靠。

*  logback-classic本身就说SLF4J

由于Loggerlogback-classic中的类本身实现了SLF4J API，因此在调用带有logback-classic作为底层实现的SLF4J记录器时，会产生零开销。此外，由于logback-classic强烈鼓励使用SLF4J作为其客户端API，如果需要切换到log4j或jul，则可以通过将一个jar文件替换为另一个jar文件来实现。您无需通过SLF4J API触摸代码记录。这可以大大减少切换日志框架所涉及的工作。

参考[优先于log4j进行logback的原因][log4j_logback]

--------------------

## 1. logback的pom 文件导入 ##

<dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.7</version>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.1.3</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>log4j-over-slf4j</artifactId>
        <version>1.7.7</version>
    </dependency>

注意你的项目，之前是log4j配置的话，需要将原来log4j引入的pom文件都移除掉，并且需要移除项目中其他第三方框架引入的log4j。

*  如果使用的IDEA可以使用Maven Project 中提供的查看依赖视图界面  
    ![在这里插入图片描述][70]  
    将其中包含的log4j 都排除掉  
    ![在这里插入图片描述][70 1]  
    其中在我的项目排除的有：

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>dubbo</artifactId>
        <exclusions>
            <exclusion>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.apache.zookeeper</groupId>
        <artifactId>zookeeper</artifactId>
        <exclusions>
            <exclusion>
                <artifactId>log4j</artifactId>
                <groupId>log4j</groupId>
            </exclusion>
            <exclusion>
                <artifactId>slf4j-log4j12</artifactId>
                <groupId>org.slf4j</groupId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>com.github.sgroschupf</groupId>
        <artifactId>zkclient</artifactId>
        <exclusions>
            <exclusion>
                <artifactId>log4j</artifactId>
                <groupId>log4j</groupId>
            </exclusion>
        </exclusions>
    </dependency>

--------------------

## 2. logback的配置 ##

![在这里插入图片描述][70 2]  
将我们之前的log4j.properties 删除，新建一个logback.xml 文件  
项目之前的使用log4j.properties可以用http://logback.qos.ch/translator/转换到等价的logback配置文件。PS:转换后的配置文件，pattern参数需要修改。  
如log4j的pattern配置 %-d\{yyyy-MM-dd HH:mm:ss,SSS\} \[%c:%L\]-\[%p\] %m%n 在logback里面不在起效。  
我把它调整为 %date \[%level\] \[%thread\] %logger\{80\} \[%file : %line\] %msg%n  
另外按日期产生日志文件策略的pattern也需要修改（具体查看下文的logback.xml配置文件）。  
参数 含义  
%date 表示日期格式（yyyy-MM-dd HH:mm:ss,SSS）  
%level 表示日志的级别  
%thread 表示输出产生该日志的线程名  
%logger\{80\} 表示logger名字最长80个字符，否则按照句点(.)分割  
%file 表示文件名  
%line 表示第几行  
%msg 表示输出信息  
%n 表示换行  
参考[log4j迁移到logback][log4j_logback 1]  
转换界面  
![在这里插入图片描述][70 3]  
这个是我项目里面配置的

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration>
        
        <property name="LOG_HOME" value="F:/ELK/newlog/logback" />
    
        
          <appender name="DC" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <File>${LOG_NAME}/logs/devicecontrol.log</File>
            <encoder>
              <pattern>%date [%level] [%thread] %logger{80} [%file : %line] %msg%n</pattern>
            </encoder>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
              <fileNamePattern>${LOG_NAME}/logs/devicecontrol.log.%d{yyyy-MM-dd}</fileNamePattern>
            </rollingPolicy>
          </appender>
    
            
          <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
            
            <Target>System.out</Target>
            <encoder>
              <pattern>%date [%level] [%thread] %logger{80} [%file : %line] %msg%n</pattern>
            </encoder>
          </appender>
    
          
          <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <File>${LOG_HOME}/logs/vod.log</File>
            <encoder>
              <pattern>%date [%level] [%thread] %logger{80} [%file : %line] %msg%n</pattern>
            </encoder>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/logs/vod.log.%d{yyyy-MM-dd}</fileNamePattern>
            </rollingPolicy>
          </appender>
    
    
        
          <logger name="org.springframework" level="error"/>
          <logger name="com.thunisoft.crs" level="error"/>
          <logger name="jdbc.connection" level="OFF"/>
          <logger name="com.thunisoft.artery" level="error"/>
          <logger name="com.thunisoft.cas.service.devicecontrol" level="debug">
            <appender-ref ref="DC"/>
          </logger>
          <logger name="org.apache" level="error"/>
          <logger name="jdbc.resultset" level="OFF"/>
          <logger name="com.thunisoft.summer" level="warn"/>
          <logger name="org.hibernate" level="error"/>
          <logger name="jdbc.audit" level="OFF"/>
          <logger name="com.thunisoft.test" level="error"/>
          <logger name="jdbc.sqlonly" level="INFO"/>
          <logger name="jdbc.sqltiming" level="DEBUG"/>
          <logger name="org.quartz.simpl" level="error"/>
          <logger name="com.alibaba.dubbo" level="INFO"/>
          <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="FILE"/>
            <appender-ref ref="DC"/>
          </root>
    </configuration>

## 3. logback文件的解释 ##

四、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。
    　1、Logback的配置文件：
             Logback 配置文件的语法非常灵活。正因为灵活，所以无法用 DTD 或 XML schema 进行定义。尽管如此，可以这样描述配置文件的基本结构：以<configuration>开头，后面有零个或多个<appender>元素，有零个或多个<logger>元素，有最多一个<root>元素。
    　2、Logback默认配置的步骤：
    　　(1). 尝试在 classpath下查找文件logback-test.xml；
    　　(2). 如果文件不存在，则查找文件logback.xml；
    　　(3). 如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。
    
     
    
    五、logback.xml常用配置详解     
    
       
    
         1.根节点<configuration>包含三个属性：   
    
            scan:默认为true。作用：当设置为true时，如果配置文件发生改变，将会被重新加载。
    
            scanPeriod：默认时间间隔为1分钟，默认单位是毫秒，当scan为true时，此属性生效。作用：检测配置文件是否有修改时间间隔。
    
            debug：默认为false。作用：当此属性为true时，将打印出logback内部日志信息，实时查看logback运行状态。
    　　　例如：
               <configuration scan="true" scanPeriod="60 seconds" debug="false">
                        
               </configuration>
    
            2.子节点<contextName>:用来设置上下文名称。
              每个logger都关联到logger上下文，默认上下文名称为default。
              可以使用<contextName>设置成其他名字，用于区分不同的应用程序的记录。一旦设置，不能修改。
              例如：
               <configuration scan="true" scanPeriod="60 seconds" debug="false">
                      <contextName>myAppName</contextName>
                      
    　        </configuration>
    
            3.子节点<property>:用来定义变量值，有两个属性name和value。
              通过<property>定义的值被插入到logger上下文中，可以使"${}"来使用变量。
              name:变量的名字
              value：变量名字对应的数值
              例如:
               <configuration scan="true" scanPeriod="60 seconds" debug="false">
                      <property name="APP_Name" value="myAppName"></property>
                      <contextName>${APP_Name}</contextName>
                      
              </configuration>
    
             4.子节点<timestamp>:获取时间戳字符串，有两个属性key和datePattern。
              key：标识此<timestamp>的名字
              datePattern：设置将当前时间（即解析配置文件的时间）转换为字符串，遵循java.txt.SimpleDateFormat的格式。
                 例如：
               <configuration scan="true" scanPeriod="60 seconds" debug="false">
                    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"></timestamp>
                    <contextName>${bySecond}</contextName>
               </configuration>
    
           5.子节点<appender>:负责写日志的组件，有两个必要属性name和class。
             name：指定appender名称
             class：指定appender的全限定名
    
           5.1 class="ch.qos.logback.core.ConsoleAppender"：把日志输出到控制台，有以下子节点。
              <encoder>:对日志进行格式化。（具体参数稍后讲~~~~~~~~~~~~~） 
              <target>：字符串System.out（默认）或者System.err
                例如：
               <configuration scan="true" scanPeriod="60 seconds" debug="false">
                    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
                           <encoder>
                                <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
                           </encoder>
                   </appender>
                   <root level="DEBUG">
                         <appender-ref ref="STDOUT"></appender-ref>
                   </root>
             </configuration>	
             上述配置表示把>=DEBUG级别的日志都输出到控制台
    
          5.2 class="ch.qos.logback.core.FileAppender"：把日志添加到文件，有以下子节点：
              <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
              <append>：默认为true。如果是true，日志被追加到文件结尾，如果是false，清空现存文件。
              <encoder>：对记录事件进行格式化。（具体参数稍后讲~~~~~~~~~~~）
              <prudent>：默认为false。如果是true，日志会被安全的写入文件，即其他的FileAppender也在向此文件做写入操作，效率低。
                例如：
               <configuration scan="true" scanPeriod="60 seconds" debug="false">
                      <appender name="FILE" class="ch.qos.logback.core.FileAppender">
                             <file>testFile.log</file>
                             <append>true</append>
                             <encoder>
                                    <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
                             </encoder>
                     </appender>
                    <root level="DEBUG">
                         <appender-ref ref="FILE"/>
                    </root>
               </configuration>
               上述配置表示把>=DEBUG级别的日志都输出到testFile.log
    
         5.3 class="ch.qos.logback.core.rolling.RollingFileAppender"：滚动记录文件，先将日志文件指定到文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
      　　<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
    
    　　<append>：默认为true。如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件。
    
    　　<rollingPolicy>：当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类。　　
    
    　　<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
    
    　　<encoder>：对记录事件进行格式化。负责两件事：1）是把日志信息转换成字节数组，2）是把字节数组写入到输出流。
    
    　　PatternLayoutEncoder 是唯一有用的且默认的encoder。有一个节点：
    
    　　<pattern>节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义。
    
     
    
    
              class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：
                <fileNamePattern>：必要节点，包含文件名及"%d"转换符，"%d"可以包含一个java.text.SimpleDateFormat指定的时间格式，默认格式是 yyyy-MM-dd。也可以设置其他格 式，如：%d{yyyy-MM}。
                <maxHistory>:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。
               注:删除旧文件时，那些为了归档而创建的目录也会被删除。
    
                 注：（RollingFileAppender的<file>子节点可有可无，通过设置<file>，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变； 如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。）
               
    
    　　  class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
    　　　  <maxFileSize>:活动文件的大小，默认值是10MB。
    　　　  <prudent>：当为true时，不支持FixedWindowRollingPolicy，支持TimeBasedRollingPolicy。但是有两个限制：1）不支持也不允许文件压缩，2）不能设置file属性，必须留空。	
    　　　  
    
    
    　      class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" ：根据固定窗口算法重命名文件的滚动策略。有以下子节点：
    　　      <minIndex>:窗口索引最小值
    　　      <maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
    　　      <fileNamePattern>:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip
    　　例如：	
    　　<configuration scan="true" scanPeriod="60 seconds" debug="false">
    　　　　<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    　　　　　　<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    　　　　　　　　<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
    　　　　　　　　<maxHistory>30</maxHistory>
    　　　　　　</rollingPolicy>
    　　　　　　<encoder>
    　　　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    　　　　　　</encoder>
    　　　　</appender>
    　　　　<root level="DEBUG">
    　　　　　　<appender-ref ref="FILE"/>
    　　　　</root>
    　　</configuration>
          上述配置表示每天生成一个日志文件，保存30天的日志文件。
    
    　　<configuration scan="true" scanPeriod="60 seconds" debug="false">
    
    　　　　<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    　　　　　　<file>test.log</file>
    
    　　　　　　<roollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
    　　　　　　　　<fileNamePattern>tests.%i.log.zip</fileNamePattern>
    　　　　　　　　<minIndex>1</minIndex>
    　　　　　　　　<maxIndex>3</maxIndex>
    　　　　　　</roollingPolicy>
    
    　　　　　　<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
    　　　　　　　　<maxFileSize>5MB</maxFileSize>
    　　　　　　</triggeringPolicy>
    
    　　　　　　<encoder>
    　　　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    　　　　　　</encoder>
    　　　　</appender>
    
    　　　　<root level="DEBUG">
    　　　　　<appender-ref ref="FILE" />
    　　　　</root>
    　　</configuration>
         上述配置表示按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。
    
    
        5.4 还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这里就不详解了。
    大家可以参考官方文档（http://logback.qos.ch/documentation.html），还可以编写自己的Appender。
    
         6. 子节点<logger>：用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。
            <logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。
    
    　　 name: 用来指定受此logger约束的某一个包或者具体的某一个类。
    　　 level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前logger将会继承上级的级别。
    　　 addtivity: 是否向上级logger传递打印信息。默认是true。同<logger>一样，可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。
    
         7. 子节点<root>：它也是<logger>元素，但是它是根logger,是所有<logger>的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。有一个属性：
    　　  level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。	
    
    六、常用logger配置
    
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />
    
    
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    
    
    七、使用例子
    
    logback.xml配置文件
    
    复制代码
    <?xml version="1.0" encoding="UTF-8"?>
    <configuration debug="false">
        
        <property name="LOG_HOME" value="/home" />
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
        </appender>
    
        
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
                
                <MaxHistory>30</MaxHistory>
            </rollingPolicy>
    
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
            
            <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
                <MaxFileSize>10MB</MaxFileSize>
            </triggeringPolicy>
        </appender>
    
        
        <root level="INFO">
            <appender-ref ref="STDOUT" />
        </root>
    
    </configuration>
    复制代码
    测试类，日志在控制台输出：
    
    复制代码
    private final static Logger logger = LoggerFactory.getLogger(SpringbootStudyLoggerApplicationTests.class);
    
        @Test
        public void log() {
            logger.info("==============================================");
            logger.error("==============================================");
            logger.debug("==============================================");
        }
    复制代码
     
    
    八、总结
    
    logback的配置，需要配置输出源appender，打日志的loger（子节点）和root（根节点），实际上，它输出日志是从子节点开始，子节点如果有输出源直接输入，如果无，判断配置的addtivity，是否像上级传递，即是否向root传递，传递则采用root的输出源，否则不输出日

参考[logback配置详解和使用][logback]

--------------------

参考[log4j迁移到logback][log4j_logback 1]  
![在这里插入图片描述][70 4]

[log4j_logback]: https://logback.qos.ch/reasonsToSwitch.html
[70]: /images/20220508/4fb0261a38684a4c8f4514926eefd587.png
[70 1]: /images/20220508/70c6446b3601479ea8b7637a30545d6a.png
[70 2]: /images/20220508/bc0dab0ca8b3410d95a3996037c40aee.png
[log4j_logback 1]: https://blog.csdn.net/chenminghe271/article/details/38682493
[70 3]: /images/20220508/87d746f6c91d44829aa1a08611165422.png
[logback]: https://www.cnblogs.com/nananana/p/8371805.html
[70 4]: /images/20220508/ca689e6c7a2e4fe296265816578e3ae3.png