SpringBoot.06.SpringBoot日志管理

淩亂°似流年 2022-09-11 05:28 104阅读 0赞

### SpringBoot.06.SpringBoot日志管理 ###

*   *  SpringBoot日志介绍
     *   *  概念
         *  日志的级别
         *  日志的分类
     *  SpringBoot日志基本使用
     *   *  1.新建Module
         *  2.项目配置
         *  3.配置日志
     *  SpringBoot日志切割
     *   *  1.application.yml
         *  2.application-dev.yml
         *  3.logback-dev.xml
         *  4.测试

## SpringBoot日志介绍 ##

### 概念 ###

在SpringBoot框架中默认集成的日志处理框架是`Logback`。Logback是由[log4j][]创始人设计的又一个开源日志组件。目前logback分为三个模块：logback-core、logback-classic和logback-access。它是对log4j日志展示进一步改进，相比较与log4j，logback更加轻量！

### 日志的级别 ###

在SpringBoot中日志分为以下8类：

*  `Off`：关闭，日志的最低级别，不打印日志
 *  `Fatal`：致命错误，指明非常严重的可能会导致应用终止执行的错误时间
 *  `Error`：错误，指明错误事件，但应用可能还能继续运行
 *  `Warn`：警告，指明可能潜在的危险状况
 *  `Info`：信息，指明描述信息，从粗粒度上描述了应用运行过程
 *  `Debug`：调试，指明细致的事件信息，对调试应用最有用
 *  `Trace`：跟踪，指明程序运行轨迹，比DEBUG级别的粒度更细
 *  `All`：所有，所有日志级别，包括定制级别

日志级别由低到高，级别越高，输出的日志信息越多。如下图所示：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_18_color_FFFFFF_t_70_g_se_x_16]

### 日志的分类 ###

在项目中，日志分为两类：`rootLogger`与`logger`

*  rootLogger：根全局日志，用来监听项目中的所有运行日志，包括引入依赖jar中的日志
 *  logger：指定包级别日志，用来监听项目中指定包的日志信息

## SpringBoot日志基本使用 ##

### 1.新建Module ###

打开IDEA，新建Module – `springboot-05-logback`，按下图所示填写相应信息，点击`Next`：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16]  
在Dependencies中勾选`Spring Web`，点击`Finish`，如下图所示：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 1]

### 2.项目配置 ###

我们将项目`springboot-04-mybatis`中的代码拷贝过来，整理一下项目结构。如下图所示：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 2]

### 3.配置日志 ###

在SpringBoot框架中默认的根日志级别为`INFO`，这个在项目启动时通过控制套打印输出能看出来。如下图所示：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 3]  
如果我们想要更改默认的根日志级别，可以修改配置文件如下：

我们运行单元测试测试`UserTest`中的`findAll()`，可以发现控制台吗，明显多了很多`DEBUG`日志的输出，而且还打印输出了相应的sql语句。如下图所示：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 4]  
那么问题来了，如果我想在控制台打印输出sql语句，但是又不想看到`Debug`信息怎么办？这就要用到我们上面所说的`包级别日志`了。我们修改配置文件如下：

server:
      port: 8805
    
    # datasource
    spring:
      datasource:
        type: com.alibaba.druid.pool.DruidDataSource
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://localhost:3306/christy?characterEncoding=UTF-8
        username: root
        password: 123456
    
    # mybatis
    mybatis:
      mapper-locations: classpath:com/christy/mapper/*.xml
      type-aliases-package: com.christy.entity
    
    # logback
    logging:
      level:
        root: info  # 指定全局根日志级别为INFO（默认）
        com.christy.mapper: debug   # 指定包级别日志为debug，在控制台不打印DEBUG日志时能看到sql语句

然后们再次运行上面的单元测试方法，可以看到控制台没有打印框架DEBUG日志，而只是打印了指定包级别日志的DEBUG信息，这个信息就是我们想要的sql信息。如下图所示：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 5]

## SpringBoot日志切割 ##

上面虽然能够打印我们想要的日志，但是在实际开发中我们不仅需要在控制台输出日志信息，还需要将运行日志输出到磁盘上，便于日常维护。这个时候就需要日志切割功能了。

在实际开发中我们的开发环境和生产环境配置文件和日志配置是不一样的，一半般都要做多环境配置。这里我们先调整一下resources的目录结构，如下图所示：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_19_color_FFFFFF_t_70_g_se_x_16]

> 官方推荐使用的xml名字的格式为：logback-spring.xml而不是logback.xml，带spring后缀的可以使用`<springProfile>`这个标签。  
> 这是因为logback.xml加载早于application.properties，所以如果你在logback.xml使用了变量时，而恰好这个变量是写在application.properties时，那么就会获取不到，只要改成logback-spring.xml就可以解决。

### 1.application.yml ###

# 指定当前为开发环境
    spring:
      profiles:
        active: dev   # 开发环境端口号为8805

### 2.application-dev.yml ###

server:
      port: 8805
    
    # datasource
    spring:
      datasource:
        type: com.alibaba.druid.pool.DruidDataSource
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://localhost:3306/christy?characterEncoding=UTF-8
        username: root
        password: 123456
      ldap:
        template:
          ignore-name-not-found-exception:
    
    # mybatis
    mybatis:
      mapper-locations: classpath:com/christy/mapper/*.xml
      type-aliases-package: com.christy.entity
    
    # logback
    # logging:
    # level:
    # root: info # 指定全局根日志级别为INFO（默认）
    # com.christy.mapper: debug # 指定包级别日志为debug，在控制台不打印DEBUG日志时能看到sql语句
    
    # 多环境下我们需要指定当前使用的日志文件
    logging:
      config: classpath:logs/logback-dev.xml

### 3.logback-dev.xml ###

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
        
        <property name="log_path" value="/logs/spring-05-logback" />
        
        <property name="maxHistory" value="30" />
        
        
        <property name="PATTERN" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger -%msg%n" />
    
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>DEBUG</level>
            </filter>
            
            
            <encoder>
                <pattern>${PATTERN}</pattern>
                <charset>UTF-8</charset>
            </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.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log_path}/%d{yyyy-MM-dd}/error-log.log</fileNamePattern>
                
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
    
            
            
    
            
            
    
            <encoder>
                <pattern>${PATTERN}</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.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log_path}/%d{yyyy-MM-dd}/warn-log.log</fileNamePattern>
                
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
    
            <encoder>
                <pattern>${PATTERN}</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.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log_path}/%d{yyyy-MM-dd}/info-log.log</fileNamePattern>
                
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
    
            <encoder>
                <pattern>${PATTERN}</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>DENY</onMismatch>
            </filter>
    
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log_path}/%d{yyyy-MM-dd}/debug-log.log
                </fileNamePattern>
                
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
    
            <encoder>
                <pattern>${PATTERN}</pattern>
            </encoder>
        </appender>
    
        
        <appender name="TRACE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>TRACE</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
    
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log_path}/%d{yyyy-MM-dd}/trace-log.log</fileNamePattern>
                
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
    
            <encoder>
                <pattern>${PATTERN}</pattern>
            </encoder>
        </appender>
    
        
        
        
        
        
        <logger name="com.christy.mapper" level="DEBUG"></logger>
    
        
        <root level="INFO">
            
            <appender-ref ref="CONSOLE" />
            
            <appender-ref ref="ERROR" />
            <appender-ref ref="INFO" />
            <appender-ref ref="WARN" />
            <appender-ref ref="DEBUG" />
            
            <appender-ref ref="TRACE" />
        </root>
    </configuration>

> 对于配置文件和日志处理，目前开发和生产的环境是一样的，暂时不做区分处理

### 4.测试 ###

我们再次运行上面的单元测试方法，注意观察控制台。效果如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 6]  
本地磁盘上也已经记录下了详细的日志信息，如下图所示：  
![在这里插入图片描述][28845ac814bd4c93b5da99fc86159245.png_pic_center]

[log4j]: https://baike.baidu.com/item/log4j/480673
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_18_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/0285691ee2dd4eb2bd8226b091c88d21.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/7b40d0d55a5549049035f18dcaec07dd.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/a0375301e0a1479d846344550ce23d72.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220828/ed98622a03d143508cd7bef0d282e2ad.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220828/eb904ac2b16e4373aeda84325c3494af.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 4]: /images/20220828/66cd5b5fcf254064b2f38d65e4c7ceb6.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 5]: /images/20220828/cb5ad26b35b54e2481a74a7d0ed46a7b.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_19_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/8f3ac756ca734ff59bf755049c932793.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5r2u5rGQ5YWI55Sf_size_20_color_FFFFFF_t_70_g_se_x_16 6]: /images/20220828/e9249705b0544ad1a40a45f72529370f.png
[28845ac814bd4c93b5da99fc86159245.png_pic_center]: /images/20220828/c02aa323992c47a08bf9a6461eaccec2.png