springboot @Slf4j+logback 配置详解

目录

一、@Slf4j使用

二、logback详解

1、logback的介绍

2、logback与log4j

3、logback的配置介绍

4、logback的默认配置

5、logback.xml常用配置详解

（1）根节点：configuration

（2）子节点：contextName

（3）子节点：property

（4）子节点：timestamp

（5）子节点：appender

（6）子节点：logger

（7）子节点：root

6、常用logger配置

7、demo

---

一、@Slf4j使用

注解@Slf4j：当前日志为logback，其他日志框架不祥

直接使用：log.xxxx("mothod is start") ;     

例如：log.info("/returncode/add start");

代替： private  final Logger logger = LoggerFactory.getLogger(XXX.class);

本文基于基于SpringBoot框架，默认加入了slf4j-api和logback的依赖，所以只需要添加lombok的依赖即可。

// 版本跟随springboot

    org.projectlombok
    lombok

另，使用lombok，idea需要安装lombok插件

演示代码：

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/log")
@Slf4j
public class TestLogController {
    @GetMapping("/testLog")
    public String testSelfLog(@RequestParam String param1, @RequestParam String param2) {
        log.info("Processing trade with param1:[{}] and param2: [{}] ", param1, param2);
        return "success";
    }
}

二、logback详解

1、logback的介绍

Logback是由log4j创始人设计的另一个开源日志组件，官方网站：http://logback.qos.ch。它当前分为下面下个模块：

• logback-core：其它两个模块的基础模块
• logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging
• logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能

2、logback与log4j

更快的实现：Logback的内核重写了，在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了，初始化内存加载也更小了。

slf4j有{}占位符，而log4j需要用“+”来连接字符串，既不利于阅读，同时消耗了内存（heap memory）

3、logback的配置介绍

• Logger、appender及layout

　　Logger作为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也可以定义日志类型、级别。
　　Appender主要用于指定日志输出的目的地，目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。 
　　Layout 负责把事件转换成字符串，格式化的日志信息的输出。

4、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。

Logback的配置文件

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

Logback默认配置的步骤

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

5、logback.xml常用配置详解

（1）根节点：configuration

包含下面三个属性：

　　scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
　　scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
　　debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
　　例如：

（2）子节点：contextName

用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

　　例如：

 
     myAppName 
　　  

（3）子节点：property

：用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。

• name: 变量的名称
• value: 的值时变量定义的值

　　例如：

 
　　　 
　　　${APP_Name} 
　　　 

（4）子节点：timestamp

获取时间戳字符串，他有两个属性key和datePattern

key: 标识此 的名字；
datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。
　　例如：

 
　　 
　　${bySecond} 
　　 

（5）子节点：appender

负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名

5.1）ConsoleAppender 把日志输出到控制台，有以下子节点：

• ：对日志进行格式化。（具体参数稍后讲解 ）
• ：字符串System.out(默认)或者System.err（区别不多说了）

 
　　　 
　　　　　  
　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg %n 
　　　　　  
　　　 

　　　 
　　　　　　 
　　　 

上述配置表示把>=DEBUG级别的日志都输出到控制台

5.2）FileAppender：把日志添加到文件，有以下子节点：

• ：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
• ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
• ：对记录事件进行格式化。（具体参数稍后讲解 ）
• ：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

　　　　例如：

 
　　 
　　　　testFile.log 
　　　　true 
　　　　 
　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n 
　　　　 
　　 

　　 
　　　　 
　　 

上述配置表示把>=DEBUG级别的日志都输出到testFile.log

5.3）RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：

• ：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
• ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
• :当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类。

class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。

有以下子节点：

• ：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。
• RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
• :可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:

• :这是活动文件的大小，默认值是10MB。
• ：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制：

1. 不支持也不允许文件压缩
2. 不能设置file属性，必须留空

• : 告知 RollingFileAppender 合适激活滚动。

class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点：

• :窗口索引最小值
• :窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
• :必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log，会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip

       例如： 　　　　　　　　

 
　　　 
　　　　　　 
　　　　　　　　　logFile.%d{yyyy-MM-dd}.log 
　　　　　　　　　30 
　　　　　　 
　　　　　　 
　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n 
　　　　　　 
　　　 

　　　 
　　　　　　 
　　　 

备注：上述配置表示每天生成一个日志文件，保存30天的日志文件。

 
　　　 
　　　　　　test.log 

　　　　　　 
　　　　　　　　　　tests.%i.log.zip 
　　　　　　　　　　1 
　　　　　　　　　　3 
　　　　　　 

　　　　　　 
　　　　　　　　　　5MB 
　　　　　　 
　　　　　　 
　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n 
　　　　　　 
　　　 

　　　 
　　　　　　 
　　　 

备注：上述配置表示按照固定窗口模式生成日志文件，当文件大于5MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。

：对记录事件进行格式化。负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。

PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义。

还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这里就不详解了。

大家可以参考官方文档（http://logback.qos.ch/documentation.html），还可以编写自己的Appender。

（6）子节点：logger

用来设置某一个包或具体的某一个类的日志打印级别、以及指定。

仅有一个name属性，一个可选的level和一个可选的additivity属性。

可以包含零个或多个元素，标识这个appender将会添加到这个logger

• 属性name: 用来指定受此logger约束的某一个包或者具体的某一个类。
• 属性level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前logger将会继承上级的级别。
• 属性additivity: 是否向上级logger传递打印信息。默认是true。同一样，可以包含零个或多个元素，标识这个appender将会添加到这个logger。

（7）子节点：root

它也是元素，但是它是根logger，是所有的上级。只有一个level属性，因为name已经被命名为"root"，且已经是最上级了。

• level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。

6、常用logger配置

7、demo

logback使用需要和slf4j一起使用，所以总共需要添加依赖的包有slf4j-api.jar，logback-core.jar，logback-classic.jar，logback-access.jar这个暂时用不到所以不添加依赖了（注：springboot默认集成了以上jar包，不需要另外添加）

1、maven配置

   
　　　　UTF-8
　　　　1.1.7
　　　　1.7.21
　　

　　
　　　　
　　　　　　org.slf4j
　　　　　　slf4j-api
　　　　　　${slf4j.version}
　　　　　　compile
　　　　
　　　　
　　　　　　ch.qos.logback
　　　　　　logback-core
　　　　　　${logback.version}
　　　　
　　　　
　　　　　　ch.qos.logback
　　　　　　logback-classic
　　　　　　${logback.version}
　　　　　　
　　

2、logback.xml配置

    
    

    
    
        
            
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
        
    

    
    
        
            
            ${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log
            
            30
        
        
            
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
        
        
        
            10MB
        
    

    
    
    
    
    
    

    
    
    
    
    

    
    
        
        
    

测试程序：

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/log")
@Slf4j
public class TestLogController {
    @GetMapping("/testLog")
    public String testSelfLog(@RequestParam String param1, @RequestParam String param2) {
        log.info("Processing trade with param1:[{}] and param2: [{}] ", param1, param2);
        log.info("logback 成功了");
        return "success";
    }
}

执行示例：

http://localhost:8080/log/testLog?param1=make¶m2=jack

logback pattern配置及详解：logback pattern配置及详解_snail_bi的博客-CSDN博客_logback pattern

参考博客：https://www.iteye.com/blog/aub-1101222

日志级别和注意事项参考：java日志使用_Object的博客-CSDN博客_java日志