Springboot整合常见日志框架

一、前言

作为一个开发人员大家对日志框架肯定多少有些了解，在我们刚刚开始学习java的时候大家都是通过System.out.println()来进行语句输出。但是出来工作后发现项目中几乎没有使用此方法来进行日志输出的，而都是通过日志框架来进行日志输出的，那为什么我们不用System.out.println()的方式来输出而是要专门弄一个日志框架来进行日志输出呢？我们先看下System.out.println()输出方式的源码：

public void println(String x) {
    synchronized (this) {
        print(x);
        newLine();
    }
}
1
2
3
4
5
6

synchronized关键字，大家都熟悉吧，同步锁，如果项目中都用这种方式打印日志，那么我们服务器性能将会大大下降。因此我们可以得出结论：

• System.out.println是一个同步方法，在高并发的情况下，会严重影响性能
• System.out.println方式输出日志不方便采集

所以，在我们项目的生产环境中是禁止使用System.out.println()进行日志输出的，因此就诞生了专门用于解决此问题的日志框架。

二、日志框架介绍

1.常见日志框架

目前我们常见的日志框架为Log4j、Log4j2、Logback这3种，并且现在很多的工具包里面都会自带日志框架，因此我们使用的使用要格外小心日志框架的冲突

2. 三种日志框架之间的关系

最先有Log4j，然后因为Log4j有很大的性能问题因此该作者又重写了一个Logback，并且抽象出一个日志门面slf4j。由于之前Log4j的问世，Apache公司就借鉴了Log4j的部分原理，自己重新写了一个日志框架Log4j2并且也实现了slf4j日志门面。

3. SpringBoot默认的日志框架 Logback

SpringBoot种采用Logback作为默认的日志框架，至于为何会选择Logback而不是Apache开发的Log4j2，理由如下：

在SpringBoot中，底层是Spring框架，Spring框架默认使用JCL，而SpringBoot默认集成的日志框架需要的是SLF4j+Logback组合。因为spring-boot-starter-logging是Logback的日志实现，而SpringBoot启动项spring-boot-starter又依赖了spring-boot-starter-logging，所以Spring Boot就默认集成了Logback，因此SpringBoot默认集成了Logback。

默认情况下，SpringBoot内部使用logback作为系统日志实现的框架，将日志输出到控制台，不会写到日志文件。如果在application.properties或application.yml配置，这样只能配置简单的场景，保存路径、日志格式等。复杂的场景（区分 info 和 error 的日志、每天产生一个日志文件等）满足不了，只能自定义配置文件logback-spring.xml。

三、SpringBoot整合日志框架

搭建最基础的SpringBoot框架:pom文件内容如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0modelVersion>
    <parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-parentartifactId>
        <version>2.3.1.RELEASEversion>
        <relativePath/> 
    parent>
    <groupId>com.zblgroupId>
    <artifactId>springboot-logbackartifactId>
    <version>0.0.1-SNAPSHOTversion>
    <name>springboot-logbackname>
    <description>Demo project for Spring Bootdescription>
    <properties>
        <java.version>1.8java.version>
    properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
        dependency>
    dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
            plugin>
        plugins>
    build>
project>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

1.使用默认的Logback框架

根据上图查看包结构我们可以发现，SpringBoot默认集成的日志框架确实是Logback，因此我们使用Logback框架就变得很简单了，使用步骤如下：

①项目资源路径下新建配置文件logback.xml(和application.properties平级)

配置文件内容需自己定义，我此处给一个全面的，可参考我的进行配置

<configuration>
    
    <property name="APP_NAME" value="jobmd-extra-service"/>
    <property name="LOG_HOME" value="logs"/>
    
    <timestamp key="TIMESTAMP" datePattern="yyyyMMddHHmmss"/>
    
    <contextName>${APP_NAME}-${TIMESTAMP}contextName>
    
    <appender name="CONSOLE-LOG" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%npattern>
        layout>
    appender>

    
    <appender name="INFO-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERRORlevel>
            <onMatch>DENYonMatch>
            <onMismatch>ACCEPTonMismatch>
        filter>
        <encoder>
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%npattern>
        encoder>
        
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}//%d-info.logfileNamePattern>
            <maxHistory>30maxHistory>
        rollingPolicy>
    appender>

    
    <appender name="ERROR-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERRORlevel>
        filter>
        <encoder>
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%npattern>
        encoder>
        
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}//%d-error.logfileNamePattern>
            <maxHistory>30maxHistory>
        rollingPolicy>
    appender>

    
    <appender name="File" class="ch.qos.logback.core.FileAppender">
        <file>${LOG_HOME}/${appName}.file.logfile>
        <append>trueappend>　
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%npattern>
        encoder>
    appender>
    
    <appender name="ASYNC-INFO" class="ch.qos.logback.classic.AsyncAppender">
        
        <discardingThreshold>0discardingThreshold>
        
        <queueSize>256queueSize>
        
        <appender-ref ref="INFO-LOG"/>
    appender>

    <appender name="ASYNC-ERROR" class="ch.qos.logback.classic.AsyncAppender">
        
        <discardingThreshold>0discardingThreshold>
        
        <queueSize>256queueSize>
        
        <appender-ref ref="ERROR-LOG"/>
    appender>

    
    

    
    <root level="info">
        <appender-ref ref="CONSOLE-LOG"/>
        <appender-ref ref="ASYNC-INFO"/>
        <appender-ref ref="ASYNC-ERROR"/>
    root>
configuration>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

②添加测试代码进行测试

@RestController
public class LogController {
    private Logger log = LoggerFactory.getLogger(LogController.class);

    @RequestMapping("/testLog")
    public String testLog(String msg) {
        log.info("这是info信息：{}", msg);
        log.debug("这是debug信息：{}", msg);
        log.warn("这是warn信息：{}", msg);
        log.error("这是error信息：{}", msg);
        return "success";
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

可修改logback.xml中的的日志级别查看日志输出状态。在外面开发或生产时需要设置合适的日志查看级别。
提示：如果不需要自定义日志格式及其它信息，也可以不用添加logback.xml文件，直接使用默认的也可以哟！

2.整合使用Log4j2框架

看了上面我们知道Springboot默认支持的是Logback框架，但是如果我们要使用Log4j2可以不呢，其实也是可以的，不过我们使用Log4j2框架之前需要先将SpringBoot框架中Logback的所有实现和spring中自带的日志框架全部去掉，然后替换成Log4j2即可，操作步骤如下：

①.修改pom.xml文件，移除多余的Jar包并添加新的jar包

• 移除springboot中的默认日志框架：spring-boot-starter-logging
• 引入log4j2框架jar包：spring-boot-starter-log4j2
• 移除spring中的jar包：commons-logging

修改pom文件之前：

    <dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
        dependency>
    dependencies>
1
2
3
4
5
6

修改pom文件之后：

    <dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-loggingartifactId>
                    <groupId>org.springframework.bootgroupId>
                exclusion>
            exclusions>
        dependency>
        
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-log4j2artifactId>
        dependency>
    dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

②添加log4j2.xml配置文件(和application.properties平级)

<configuration status="OFF">
    <properties>
        
        <property name="fileSavePath" value="/home/logs/sweep/sweep(${hostName}).log"/>
        <property name="errorFileSavePath" value="/home/logs/sweep/sweep(${hostName})-error.log"/>
        
        <property name="fileBackSavePath" value="/home/backlogs/sweep"/>
        
        <property name="logLevel" value="debug"/>
        <property name="layoutPattern"
                  value="%d{yyyy-MM-dd HH:mm:ss.SSS}---[%-5level]---[%-32X{traceId}]---[%-16.16thread]---[%c{64}] : %msg%n"/>
    properties>
    
    <appenders>
        
        <Console name="Console" target="SYSTEM_OUT">
            
            <PatternLayout pattern="${layoutPattern}"/>
        Console>
        
        <RollingRandomAccessFile name="RollingRandomAccessFile" fileName="${fileSavePath}"
                                 filePattern="${fileBackSavePath}-%d{yyyy-MM-dd}.%i.log.zip">
            
            <PatternLayout pattern="${layoutPattern}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="200MB"/>
            Policies>
            <DefaultRolloverStrategy max="30"/>
        RollingRandomAccessFile>
        
        <RollingRandomAccessFile name="ERROR" fileName="${errorFileSavePath}"
                                 filePattern="${fileBackSavePath}-error-%d{yyyy-MM-dd}.%i.log.zip">
            
            <PatternLayout pattern="${layoutPattern}"/>
            <Filters>
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            Filters>
            <Policies>
                <SizeBasedTriggeringPolicy size="200MB"/>
            Policies>
            <DefaultRolloverStrategy max="30"/>
        RollingRandomAccessFile>
    appenders>

    
    <loggers>
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        

        <Root level="${logLevel}">
            <appender-ref ref="RollingRandomAccessFile"/>
            <appender-ref ref="ERROR"/>
            <appender-ref ref="Console"/>
        Root>
    loggers>
configuration>


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

③添加测试代码进行测试

@RestController
public class LogController {
     
    private Logger log = LoggerFactory.getLogger(LogController.class);

    @RequestMapping("/testLog")
    public String testLog(String msg) {
        log.info("这是info信息：{}", msg);
        log.debug("这是debug信息：{}", msg);
        log.warn("这是warn信息：{}", msg);
        log.error("这是error信息：{}", msg);
        return "success";
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

3.项目中日志框架需要注意事项

1. 我们整个项目的日志框架应该统一，不允许多个模块出现不同的日志框架
2. 如果采用非默认的LogBack框架，必须先删除之前的默认框架相关信息
3. 日志输出格式以及我们开发中日志的输出尽量规范，不可以过多的打印无效日志又或者不打日志
4. 日志输出级别总共分为8种，不同的环境应该选择合适的日志级别进行输出，框架只会输出比选择级别高的日志。

所有日志级别顺序为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF
比如：选择级别为info,则只会显示 INFO、WARN、ERROR、FATAL、OFF这几个级别的日志，小于该级别的日志都不会进行显示。

4.代码优化之Lombok的使用

随着现在的工具包层出不穷，大家项目中肯定也又使用Lombok的吧，Lombok工具包可以帮我们简化代码，其中也包括日志框架的代码简化，具体如下：

①不使用Lombok情况下使用日志框架：

②使用Lombok情况下使用日志框架：

pom文件中引入jar包：

 <dependency>
     <groupId>org.projectlombokgroupId>
     <artifactId>lombokartifactId>
 dependency>
1
2
3
4

使用日志的类上添加@Slf4j注解：

我们不需要再定义成员变量log，而是直接使用@Slf4j注解就可以使用log变量进行日志输出了，lombok只是对代码进行了简化，底层的日志框架还是用的我们自己选择的日志框架。
源码地址：https://gitee.com/zhaobolan/myspringboot