🍻 正在加载今日诗词....
字数统计: 4k字   |   阅读时长≈ 18分

SpringBoot日志总结

一、日志系统

在开发中，我们经常使用 System.out.println() 来打印一些信息，但是这样不好，因为大量的使用 System.out 会增加资源的消耗，而且部署在Linux上时只能通过日志来查看输出。我们实际项目中使用的是 slf4j 的 logback 来输出日志,slf4j+logback也是springboot的默认日志框架，当然logback也可以换成性能更好的log4j2框架。

1. slf4j 介绍

SLF4J，即简单日志门面（Simple Logging Facade for Java），不是具体的日志解决方案，它只服务于各种各样的日志系统。按照官方的说法，SLF4J是一个用于日志系统的简单Facade，允许最终用户在部署其应用时使用其所希望的日志系统。

slf4j要求我们只需要按统一的方式写记录日志的代码，而无需关心日志是通过哪个日志系统，以什么风格输出的。因为它们取决于部署项目时绑定的日志系统。

首先需要添加依赖

1
2
3
4
5
6
7
8
9
10
<!--<dependency>-->
<!--	<groupId>org.springframework.boot</groupId>-->
<!--	<artifactId>spring-boot-starter-logging</artifactId>-->
<!--</dependency>-->

<!-- 下面的springboot依赖已经包含上面的依赖-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

日志的使用

1
2
3
4
5
6
7
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Test {
    private static final Logger logger = LoggerFactory.getLogger(Test.class);
    //logger.info("test");
}

还有一种方法通过注解方式，需要安装好Lombok插件

1
2
3
4
5
6
7
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class Test {
  
   // log.info("test");
}

2. application.yml 中对日志的配置

application.yml 文件是 Spring Boot 中唯一一个需要配置的文件，一开始创建工程的时候是 application.properties 文件(*注：同一优先级位置同时有 application.properties 和 application.yml ，那么 application.yml 里的属性会覆盖 application.properties 里的属性)

这里我们对 application.yml 文件中对日志的配置：

1
2
3
4
logging:
  config: classpath:logback.xml 
  level:
    com.test: trace

logging.config 是用来指定项目启动的时候，读取哪个配置文件，这里指定的是日志配置文件是根路径下的 logback.xml 文件，关于日志的相关配置信息，都放在 logback.xml 文件中了。logging.level 是用来指定具体的 mapper 中日志的输出级别，上面的配置表示 com.test 包下的所有日志输出级别为 trace，会打印出所以debug以上信息。在生产环境上，将这个日志级别再设置成 error 级别即可。当然在 application.yml 中还可以显示定义其他例如logging.pattern.console等配置信息。

常用的日志级别按照从高到低依次为：ERROR、WARN、INFO、DEBUG。

对于classpath路径，src 路径下的文件 在编译后都会放到 WEB-INF/classes 路径下。默认classpath 就是指这里。用maven构建 项目时，resources 目录就是默认的classpath

3. logback.xml 配置文件解析

在上面 application.yml 文件中，我们指定了日志配置文件 logback.xml，logback.xml 文件中主要用来做日志的相关配置。在 logback.xml 中，我们可以定义日志输出的格式、路径、控制台输出格式、文件大小、保存时长等等。下面来分析一下：

3.1 定义日志输出格式和存储路径

1
2
3
4
<configuration>
	<property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n" />
	<property name="FILE_PATH" value="D:/logs/demo.%d{yyyy-MM-dd}.%i.log" />
</configuration>
1
2
3
4
5
6
7
8
9
日志输出格式:
%d表示日期时间，
%thread表示线程名，
%-5level :级别从左显示5个字符宽度
%logger{50}表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息，
%n是换行符

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

对于“FILE_PATH” 文件路径，日志都会存储在该路径下。%i 表示第 i 个文件，当日志文件达到指定大小时，会将日志生成到新的文件里，这里的 i 就是文件索引，日志文件允许的大小可以设置。这里需要注意的是，不管是 windows 系统还是 Linux 系统，日志存储的路径必须要是绝对路径。

如果想在控制台换成彩色打印输出，可以在<configuration>里添加如下配置

1
2
3
4
5
6
7
<!-- 彩色日志配置 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){green} %clr(${LOG_LEVEL_PATTERN:-%5p}){red} %clr(${PID:-}){magenta} %clr(---){blue} %clr([%30.30t]){yellow} %clr(%-40.40logger{39}){cyan} %clr(:){blue} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />

3.2 定义控制台输出

1
2
3
4
5
6
7
8
<configuration>
	<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
            <!-- 按照上面配置的LOG_PATTERN来打印日志，若彩色打印，将pattern中名字换成彩色日志格式即可-->
			<pattern>${LOG_PATTERN}</pattern>
		</encoder>
	</appender>
</configuration>

使用 <appender> 节点设置个控制台输出（class="ch.qos.logback.core.ConsoleAppender"）的配置，定义为 “CONSOLE”。使用上面定义好的输出格式（LOG_PATTERN）来输出，使用 ${} 引用进来即可。

3.3 定义日志文件的相关参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<configuration>
	<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<!-- 按照上面配置的FILE_PATH路径来保存日志 -->
			<fileNamePattern>${FILE_PATH}</fileNamePattern>
			<!-- 日志保存30天 -->
			<maxHistory>30</maxHistory>
			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
				<!-- 单个日志文件的最大，超过则新建日志文件存储 -->
				<maxFileSize>30MB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy>
		</rollingPolicy>

		<encoder>
			<!-- 按照上面配置的LOG_PATTERN来打印日志 -->
			<pattern>${LOG_PATTERN}</pattern>
		</encoder>
	</appender>
</configuration>

使用 <appender> 定义一个名为 “FILE” 的文件配置，主要是配置日志文件保存的时间、单个日志文件存储的大小、以及文件保存的路径和日志的输出格式。

3.4 定义日志输出级别

1
2
3
4
5
6
7
8
9
<configuration>
	<!--控制不同的包-->
	<logger name="com.test" level="INFO" />
	<root level="INFO">
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="FILE" />
         <!--在这里可以配置多种文件输出，只需要配置好相应的appender-->
	</root>
</configuration>

有了上面那些定义后，最后我们使用 <logger> 来定义一下项目中默认的日志输出级别，这里定义级别为 INFO，然后针对 INFO 级别的日志，使用 <root> 引用上面定义好的控制台日志输出和日志文件的参数。这样 logback.xml 文件中的配置就设置完了。

4.Springboot默认日志logback切换为log4j2

1、引入log4j2依赖，去除固有依赖

首先 ，引入log4j2的starter，将logback.xml改为log4j2的配置文件

1
2
3
4
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

然后需要排除spring自带的日志框架logback依赖，如果项目中只引入了web的starter，则可以在web starter中排除掉logging

1
2
3
4
5
6
7
8
9
10
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

如果项目中引入的不止web starter，此时我们需要在spring-boot-starter中排除logging的依赖

1
2
3
4
5
6
7
8
9
10
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

2、配置log4j2.xml文件

若自定义文件名，则需要在application.yml进行修改，配置文件也logback也有区别

1
2
logging:
  config: classpath:log4j2_dev.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="30">
    <!--这里相当于配置变量，后面在 <Appenders>  标签引入 用${}-->
    <Properties>
        <!-- 控制台彩色日志 -->
        <property name="LOG_CONSOLE" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight{%-5level} [%t] %highlight{%c{1.}.%M(%L)}: %msg%n" />
        <Property name="LOG_HOME" value="logs"/>
        <!--日志输出模式-->
        <property name="LOG_FILE" value="%d{yyyy-MM-dd HH:mm:ss.SSS} {%-5level} [%t] {%c{1.}.%M(%L)}: %msg%n" />
        <!--日志输出文件名-->
        <property name="FILE_PATH" value="lamp.%d{yyyy-MM-dd}.%i.log" />
    </Properties>

    <Appenders>
        <console name="CONSOLE" target="SYSTEM_OUT">
            <PatternLayout pattern="${LOG_CONSOLE}"/>
        </console>

        <!--生成文件的文件名，当天生成日志 log.log ，保存其他天日志为log-%d{yyyy-MM-dd}.log-->
        <RollingFile name="FILE" fileName="${LOG_HOME}/log.log" filePattern="${LOG_HOME}/${FILE_PATH}">
            <!--${FILE} 引入<Property> 标签的文件格式-->
            <PatternLayout pattern="${LOG_FILE}"/>
            <Policies>
                <!--基于时间的触发策略。该策略主要是完成周期性的log文件封存工作。有两个参数：
               interval，integer型，指定两次封存动作之间的时间间隔,modulate，boolean型，说明是否对封存时间进行调制。-->
                <!--设置每天打包日志一次-->
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
                <SizeBasedTriggeringPolicy size="20 MB" />
            </Policies>

            <DefaultRolloverStrategy>
                <!--要访问的目录的最大级别数。值为0表示仅访问起始文件,2表示能访问一下两级目录-->
                <Delete basePath="${LOG_HOME}" maxDepth="2">
                    <IfFileName glob="${LOG_HOME}/*.log">
                        <!--删除超过十天文件-->
                        <IfLastModified age="30d"/>
                    </IfFileName>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

    </Appenders>
    <Loggers>
     	<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.springframework" level="INFO"></logger>
        <logger name="org.mybatis" level="INFO"></logger>
        <!-- 生产环境下，将此级别配置为适合的级别，以免日志文件太多或影响程序性能 -->
        <!--这里指代生效的日志级别和 输出的内容，这里代表生效的是 debug ，
        文件和控制台都会输出，如果是在环境留下file就可以了，file和CONSOLE 来自于 <Appenders> 配置的标签 -->
        <root level="info">
	        <appender-ref ref="CONSOLE" />
	        <appender-ref ref="FILE" />
	        <!--在这里可以配置多种文件输出，只需要配置好相应的appender-->
        </root>
    </Loggers>

</configuration>

3、控制台显示颜色

在Log4j 2.10以前的版本，pattern中配置%highlight属性是可以正常打印彩色日志的。
但是是更新到2.10版本以后，控制台中就无法显示彩色日志了，各种级别的日志混杂在一起，难以阅读。Log4j2默认关闭了Jansi（一个支持输出ANSI颜色的类库）。

操作

IDEA中，点击右上角->Edit Configurations，在VM options中添加-Dlog4j.skipJansi=false

二、自定义日志Appender

1、logback自定义Appender

自定义文件Appender

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public class MyAppender extends AppenderBase<ILoggingEvent> {
    

    @Override
    public void start() {
        //这里可以做些初始化判断 比如layout不能为null ,
        //或者写入数据库、redis时的初始化连接等等
        super.start();
    }

    @Override
    public void stop() {
        //释放相关资源，如数据库连接，redis线程池等等
        if (!isStarted()) {
            return;
        }
        super.stop();
    }

    @Override
    protected void append(ILoggingEvent event) {
        System.out.println("这是我自定义的Appender");
    }
}

其次添加logback.xml配置

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
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d [%t] %-5level %logger{36}.%M\(%file:%line\) - %msg%n</pattern>
            <!-- 控制台也要使用UTF-8，不要使用GBK，否则会中文乱码 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="MyAppender" class="com.example.mx80.log.MyAppender">
        <!--如果只是想要 Error 级别的日志，那么需要过滤一下，默认是 info 级别的，ThresholdFilter-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
    </appender>


    <!-- 指定项目中某个包，当有日志操作行为时的日志记录级别 -->
    <!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
    <!-- additivity=false 表示匹配之后，不再继续传递给其他的logger-->
    <logger name="com.example.mx80." level="DEBUG" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="MyAppender"/>
    </logger>

    <!-- 控制台输出日志级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="MyAppender"/>
    </root>
</configuration>

2、log4j2自定义Appender

自定义文件Appender，这里需要注意几个点

  • @Plugin..注解：这个注解，是为了在之后配置log4j2.xml时，指定的Appender Tag。
  • 构造函数：除了使用父类的以外，也可以增加一些自己的配置。
  • 重写append()方法：这里面需要实现具体的逻辑，日志的去向。
  • createAppender()方法：主要是接收log4j2.xml中的配置项。
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
/**
 * 自定义日志Appender
 */
@Plugin(name = "MyAppender", category = "Core", elementType = "appender", printObject = true)
public class MyAppender extends AbstractAppender {

    private String fileName;

    protected MyAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, String fileName) {
        super(name, filter, layout, ignoreExceptions, properties);
        this.fileName=fileName;
    }

    @Override
    public void start(){
        //这里可以做些初始化判断，即系统启动时
        System.out.println("日志开始");
        super.start();
    }

    @Override
    public void stop(){
        System.out.println("日志结束");
        if (!isStarted()) {
            return;
        }
        super.stop();
    }


    @Override
    public void append(LogEvent event) {
        // 这里就可以通过log日志做很多事情，比如接入邮件等日志报警通知，或者自己的文件写入磁盘
        System.out.println("这是我的自定义appender");
        //final byte[] bytes = getLayout().toByteArray(event);
        //writerFile(bytes);
    }

    /**
     *  接收配置文件中的参数
     */
    @PluginFactory
    public static MyAppender createAppender(@PluginAttribute("name") String name,
                                            @PluginAttribute("fileName") String fileName,
                                            @PluginElement("Filter") final Filter filter,
                                            @PluginElement("Layout") Layout<? extends Serializable> layout,
                                            @PluginAttribute("ignoreExceptions") boolean ignoreExceptions) {

        if (name == null) {
            LOGGER.error("no name defined in conf.");
            return null;
        }
        if (layout == null) {
            layout = PatternLayout.createDefaultLayout();
        }

        // 创建文件
//        if (!createFile(fileName)) {
//            return null;
//        }

        return new MyAppender(name, filter, layout, ignoreExceptions, null,fileName);
    }

//    private static boolean createFile(String fileName) {
//        Path filePath = Paths.get(fileName);
//        try {
//            // 每次都重新写文件，不追加
//            if (Files.exists(filePath)) {
//                Files.delete(filePath);
//            }
//            Files.createFile(filePath);
//        } catch (IOException e) {
//            LOGGER.error("create file exception", e);
//            return false;
//        }
//        return true;
//    }
//
//    private void writerFile(byte[] log) {
//        try {
//            Files.write(Paths.get(fileName), log, StandardOpenOption.APPEND);
//        } catch (IOException e) {
//            LOGGER.error("write file exception", e);
//        }
//    }

}

其次添加log4j2.xml配置，需要注意一下几点

  • 下面的log配置，一共配了2个输出。一个是终端输出，一个是采用自定义的MyAppender 输出，即append()方法输出
  • <MyAppender>标签要与自定义Appender中的类注解保持一致。
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
<?xml version="1.0" encoding="UTF-8"?>

<configuration status="INFO" monitorInterval="30">
    <appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="%highlight{[ %p ] [%-d{yyyy-MM-dd HH:mm:ss}] [%l] %m%n}"/>
        </console>

        <!-- 这个就是自定义的Appender -->
        <MyAppender name="MyAppender" fileName="log.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] [%-5p] {%F:%L} - %m%n" />
        </MyAppender>

    </appenders>

    <loggers>
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.springframework" level="INFO"></logger>
        <logger name="org.mybatis" level="INFO"></logger>
        <root level="all">
            <appender-ref ref="Console"/>
            <appender-ref ref="MyAppender"/>
        </root>
    </loggers>
</configuration>

参考：

https://blog.csdn.net/java821643/article/details/88753898

http://logback.qos.ch/manual/index.html

https://blog.csdn.net/weixin_39370859/article/details/105039787

log4j2自定义Appender（输出到文件/RPC服务中）

赏

谢谢你请我吃糖果

支付宝
-------------本文结束^-^感谢您的阅读-------------
本文作者： Shawn
发布时间： 2021-03-15
最后更新： 2022-04-12
本文标题： SpringBoot日志总结
本文链接： https://blog.shawncoding.top/posts/ece49569.html
版权声明： 本作品采用 CC BY-NC-SA 4.0 许可协议进行许可。转载请注明出处！
知识共享许可协议

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

<br/><br/><br/>心怀天下<br/>只认真生活<br/>自信微笑面对未来