spring-boot-route（十六）使用logback生产日志文件

我不是女神ヾ 2021-09-18 06:04 187阅读 0赞

日志是一个系统非常重要的一部分，我们经常需要通过查看日志来定位问题，今天我们一起来学习一下Spring Boot的日志系统。有很多同学习惯性的在生产代码中使用System.out来输出日志，这是不推荐的一种做法，因为System.out是一个同步操作，会在一定程度上影响系统性能，而Logger是一个异步操作。

Spring Boot默认的日志系统是`logback`，当然我们并不需要去引用`logback`的依赖，因为在`spring-boot-starter`中已经应用了`logback`的依赖。

### 一、控制台日志信息介绍 ###

### 1.1 日志级别 ###

日志级别从高到低为：`TRACE` < `DEBUG` < `INFO` < `WARN` < `ERROR` < `ALL` < `OFF`。

如果日志设置为`ERROR`，那么低于`ERROR`级别的日志将不会输出。

如果我们想要设置某个包的日志级别，则在pom文件中加入下面这行配置：

logging:
      level:
      	# 包名
        com.javatrip: warn

如果想修改Spring Boot默认级别，则将包名改为`root`。

logging:
      level:
        root: warn

### 1.2 控制台日志介绍 ###

默认情况下，Spring Boot会将`INFO`级别的日志输出到控制台。控制台输出信息如下：

![96912d86a85b3cf62f4d984ff44f6d8e.png][]

日志输出内容具体含义如下：

*  时间日期：精确到毫秒
 *  日志级别：ERROR, WARN, INFO, DEBUG or TRACE
 *  进程ID
 *  分隔符：`---` 标识实际日志的开始
 *  线程名：方括号括起来（可能会截断控制台输出）
 *  Logger名：通常使用源代码的类名
 *  日志内容

## 二、日志文件输出 ##

在实际项目中，我们需要将日志输出为文件，以便快速定位问题。Spring Boot关于日志文件的信息可以参考官网`https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-logging`。

> Because the standard `logback.xml` configuration file is loaded too early, you cannot use extensions in it. You need to either use `logback-spring.xml` or define a `logging.config` property.

这句话的意思大概就是：由于标准的logback.xml配置文件加载得太早，因此您不能在其中使用扩展名。您需要使用logback-spring.xml或定义logging.config属性。

因此我们来定义一个`logback-spring.xml`的文件来进行日志信息的配置。

`logback-spring.xml`文件定义及注释：

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        
        <property name="LOG_FILE" value="myLog" />
        
        <property name="LOG_PATH" value="D://log//dev" />
        
        <property name="LOG_PATTERN_CONSOLE" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} --> %msg%n" />
        
        <property name="LOG_PATTERN_FILE" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} --> %msg%n" />
        
        <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>${LOG_PATTERN_CONSOLE}</pattern>
            </encoder>
        </appender>
        
        <appender name="fileLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <encoder>
                <pattern>${LOG_PATTERN_FILE}</pattern>
            </encoder>
    		
            <file>${LOG_PATH}/${LOG_FILE}.log</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_PATH}/${LOG_FILE}-%d{yyyy-MM-dd}.log</fileNamePattern>
                
                <maxHistory>7</maxHistory>
            </rollingPolicy>
        </appender>
    
        
        <root level="INFO">
            <appender-ref ref="consoleLog" />
            <appender-ref ref="fileLog" />
        </root>
    </configuration>

启动项目后，在`D:\log\dev`中会生产我们的日志文件`myLog.log`，加入我们系统一直运行，则在我们的文件目录下会生成一个`myLog.log`文件和7个最近日志的文件`myLog-某年-某月-某日.log`。

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

#### 本文示例代码已上传至[github][]，点个`star`支持一下！ ####

## Spring Boot系列教程目录 ##

[spring-boot-route（一）Controller接收参数的几种方式][spring-boot-route_Controller]

[spring-boot-route（二）读取配置文件的几种方式][spring-boot-route]

[spring-boot-route（三）实现多文件上传][spring-boot-route 1]

[spring-boot-route（四）全局异常处理][spring-boot-route 2]

[spring-boot-route（五）整合swagger生成接口文档][spring-boot-route_swagger]

[spring-boot-route（六）整合JApiDocs生成接口文档][spring-boot-route_JApiDocs]

[spring-boot-route（七）整合jdbcTemplate操作数据库][spring-boot-route_jdbcTemplate]

[spring-boot-route（八）整合mybatis操作数据库][spring-boot-route_mybatis]

[spring-boot-route（九）整合JPA操作数据库][spring-boot-route_JPA]

[spring-boot-route（十）多数据源切换][spring-boot-route 3]

[spring-boot-route（十一）数据库配置信息加密][spring-boot-route 4]

[spring-boot-route（十二）整合redis做为缓存][spring-boot-route_redis]

[spring-boot-route（十三）整合RabbitMQ][spring-boot-route_RabbitMQ]

[spring-boot-route（十四）整合Kafka][spring-boot-route_Kafka]

[spring-boot-route（十五）整合RocketMQ][spring-boot-route_RocketMQ]

[spring-boot-route（十六）使用logback生产日志文件][spring-boot-route_logback]

[spring-boot-route（十七）使用aop记录操作日志][spring-boot-route_aop]

[spring-boot-route（十八）spring-boot-adtuator监控应用][spring-boot-route_spring-boot-adtuator]

[spring-boot-route（十九）spring-boot-admin监控服务][spring-boot-route_spring-boot-admin]

[spring-boot-route（二十）Spring Task实现简单定时任务][spring-boot-route_Spring Task]

[spring-boot-route（二十一）quartz实现动态定时任务][spring-boot-route_quartz]

[spring-boot-route（二十二）实现邮件发送功能][spring-boot-route 5]

[spring-boot-route（二十三）开发微信公众号][spring-boot-route 6]

[spring-boot-route（二十四）分布式session的一致性处理][spring-boot-route_session]

[spring-boot-route（二十五）两行代码实现国际化][spring-boot-route 7]

[spring-boot-route（二十六）整合webSocket][spring-boot-route_webSocket]

[96912d86a85b3cf62f4d984ff44f6d8e.png]: /images/20210918/52997befe2ab469dacd10091d043c44c.png
[github]: https://github.com/binzh303/spring-boot-route
[spring-boot-route_Controller]: https://javatip.cn/archives/66
[spring-boot-route]: https://javatip.cn/archives/72
[spring-boot-route 1]: https://javatip.cn/archives/74
[spring-boot-route 2]: https://javatip.cn/archives/79
[spring-boot-route_swagger]: https://javatip.cn/archives/90
[spring-boot-route_JApiDocs]: https://javatip.cn/archives/91
[spring-boot-route_jdbcTemplate]: https://javatip.cn/archives/92
[spring-boot-route_mybatis]: https://javatip.cn/archives/93
[spring-boot-route_JPA]: https://javatip.cn/archives/94
[spring-boot-route 3]: https://javatip.cn/archives/95
[spring-boot-route 4]: https://javatip.cn/archives/113
[spring-boot-route_redis]: https://javatip.cn/archives/114
[spring-boot-route_RabbitMQ]: https://javatip.cn/archives/115
[spring-boot-route_Kafka]: https://javatip.cn/archives/116
[spring-boot-route_RocketMQ]: https://javatip.cn/archives/117
[spring-boot-route_logback]: https://javatip.cn/archives/118
[spring-boot-route_aop]: https://javatip.cn/archives/119
[spring-boot-route_spring-boot-adtuator]: https://javatip.cn/archives/120
[spring-boot-route_spring-boot-admin]: https://javatip.cn/archives/121
[spring-boot-route_Spring Task]: https://javatip.cn/archives/122
[spring-boot-route_quartz]: https://javatip.cn/archives/123
[spring-boot-route 5]: https://javatip.cn/archives/124
[spring-boot-route 6]: https://javatip.cn/archives/125
[spring-boot-route_session]: https://javatip.cn/archives/284
[spring-boot-route 7]: https://javatip.cn/archives/256
[spring-boot-route_webSocket]: https://javatip.cn/archives/255