关于logback的基础配置

心已赠人 2022-06-05 00:09 25阅读 0赞

目前(2017)流行的日志框架莫过于 slf4j + log4j,我们知道 log4j 相对于 commons-logging 等其他一些日志框架来说很好用，而且性能也很好，然而 log4j 也有其局限性或者说是设计缺陷，比如不能够对于不同的日志输出源所输出的日志进行分类(简单来说就是可以针对不同的类进行不同的日志输出管理)，不能够严格地根据日志级别进行日志输出管理(比如debug级别的日志输出到debug.log,info级别的日志输出到info.log)等等，现在在 logback 中都实现了，logback 相对于 log4j 来说相当于是 log4j 的2.0 版本，还有一点 loackback 和 log4j 的作者是同一个人(Ceki Gülcü)。

logback 官网: [https://logback.qos.ch/manual/configuration.html][https_logback.qos.ch_manual_configuration.html]

下面作者将介绍一些关于 slf4j + logback 基础的配置(能够拿过去就能用的)

### 1.引入logback 的依赖 jar ###

在 maven 的 pom.xml 文件中添加

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <maven.build.timestamp.format>yyyyMMddHHmmss</maven.build.timestamp.format>
        <slf4j.version>1.7.25</slf4j.version>
        <slf4jLogback.version>1.2.3</slf4jLogback.version>
      </properties>
    
     
        <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>slf4j-api</artifactId>
          <version>${slf4j.version}</version>
        </dependency>
        <dependency>
          <groupId>ch.qos.logback</groupId>
          <artifactId>logback-core</artifactId>
          <version>${slf4jLogback.version}</version>
        </dependency>
        <dependency>
          <groupId>ch.qos.logback</groupId>
          <artifactId>logback-classic</artifactId>
          <version>${slf4jLogback.version}</version>
        </dependency>

### 2.在classpath 下创建 logback.xml ###

**注意 :**  logback 程序汇自动扫描项目根目录(classpath) 下的配置文件 logback-test.xml 和 logback.xml，如果是扫描到其中一个则直接使用其配置，如果这两个文件都没有扫描到，则使用 logback 的默认配置，因此，只需将 logback 的配置文件 logback.xml 放到项目根目录(classpath)下即可

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
        
        
        <property name="LOG_HOME" value="E:\\logs\\campustore" />
        
        <property name="maxHistory" value="90" />
    
    
        
        <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>
    
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} [%thread] %-5level %logger{50}$%F %L$ -%msg%n </pattern>
            </encoder>
        </appender>
    
        
        
        <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                
                <level>DEBUG</level>
                
                <onMatch>ACCEPT</onMatch>
                
                <onMismatch>ACCEPT</onMismatch>
            </filter>
            
            
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_HOME}/debug/debugLog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
                
                <maxFileSize>10MB</maxFileSize>
                <maxHistory>${maxHistory}</maxHistory>
                
                <totalSizeCap>20GB</totalSizeCap>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} [%thread] %-5level %logger{50}$%F %L$ -%msg%n </pattern>
            </encoder>
        </appender>
    
    
        
        <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <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.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${LOG_HOME}/info/infoLog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
                <maxFileSize>10MB</maxFileSize>
                <maxHistory>${maxHistory}</maxHistory>
                <totalSizeCap>20GB</totalSizeCap>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} [%thread] %-5level %logger{50}$%F %L$ -%msg%n </pattern>
            </encoder>
        </appender>
    
        
        <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <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.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${LOG_HOME}/warn/warnLog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
                <maxFileSize>10MB</maxFileSize>
                <maxHistory>${maxHistory}</maxHistory>
                <totalSizeCap>20GB</totalSizeCap>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} [%thread] %-5level %logger{50}$%F %L$ -%msg%n </pattern>
            </encoder>
        </appender>
    
        
        <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <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.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${LOG_HOME}/error/errorLog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
                <maxFileSize>10MB</maxFileSize>
                <maxHistory>${maxHistory}</maxHistory>
                <totalSizeCap>20GB</totalSizeCap>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} [%thread] %-5level %logger{50}$%F %L$ -%msg%n </pattern>
            </encoder>
        </appender>
        
        
        <logger name="com.ljq.test" level="info" />
        
        <logger name="com.ljq.test1" additivity="false" />
    
    
        
        <root level="debug">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="DEBUG" />
            <appender-ref ref="INFO" />
                 <appender-ref ref="WARN" />
            <appender-ref ref="ERROR" />
        </root>
    </configuration>

关于 logback 的配置，注释已经很详细了，作者就不再多说了，详细配置可以参考 logback 官网

### 3. 测试程序 ###

LoggerTest.java

package com.ljq.test;
    
    import org.junit.Test;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    /** * @description: Test Logger * @author: lujunqiang * @email: flying9001@gmail.com * @date: 2017/11/12 */
    public class LoggerTest { 
    
        private static final Logger log = LoggerFactory.getLogger(LoggerTest.class);
    
        @Test
        public void logTest() {
    
            log.debug("Logger test for DEBUG level");
            log.info("Logger test for INFO level");
            log.warn("Logger test for WARN level");
            log.error("Logger test for ERROR level");
    
    
        }
    
    }

控制台输出结果：

2017-11-12 22:19:06:931 [main] DEBUG com.ljq.test.LoggerTest(LoggerTest.java 20) -Logger test for DEBUG level
    2017-11-12 22:19:06:946 [main] INFO  com.ljq.test.LoggerTest(LoggerTest.java 21) -Logger test for INFO level
    2017-11-12 22:19:06:946 [main] WARN  com.ljq.test.LoggerTest(LoggerTest.java 22) -Logger test for WARN level
    2017-11-12 22:19:06:946 [main] ERROR com.ljq.test.LoggerTest(LoggerTest.java 23) -Logger test for ERROR level

日志输出目录&日志文件

![log\_dir][log_dir]

![log\_file\_path][log_file_path]

打开生成的日志文件:

![log\_file][log_file]

### 4. 项目目录截图 ###

![loggerTest][]

最后，推荐一下作者的个人公众号**「404Code」**,分享一个互联网人的技术与思考,欢迎关注!

![404Code][]

[https_logback.qos.ch_manual_configuration.html]: https://logback.qos.ch/manual/configuration.html
[log_dir]: /images/20220605/14912a818940406b8002517407a224c5.png
[log_file_path]: /images/20220605/7fb1de8fb5c243aea8635b3d4f5aeb42.png
[log_file]: /images/20220605/bf0384e341e74dc69ccdbba759dff8ed.png
[loggerTest]: /images/20220605/cb9b31621dfa4fc4899ccd757d14fb60.png
[404Code]: /images/20220605/6517156f9dcc49c28a48412cb06e02fd.png