SpringBoot统一异常通用处理

约定不等于承诺〃 2021-09-03 04:52 458阅读 0赞

# 一 日志 #

## 1 什么是日志 ##

通过日志查看程序的运行过程，运行信息，异常信息等。

## 2 配置日志级别 ##

日志记录器（Logger）的行为是分等级的。

一般分为：FATAL(致命)、ERROR（错误）、WARN（警告）、INFO（信息）、DEBUG（调试）

默认情况下，spring boot从控制台打印出来的日志级别只有INFO及以上级别，可以配置日志级别

# 设置日志级别为ERROR
    logging:
      level:
        root: ERROR

这种方式能将ERROR级别以及以上级别的日志打印在控制台上。

# 二 Logback日志 #

spring boot内部使用Logback作为日志实现的框架。

Logback和log4j非常相似，如果你对log4j很熟悉，那对logback很快就会得心应手。

logback相对于log4j的一些优点：[https://blog.csdn.net/caisini\_vc/article/details/48551287][https_blog.csdn.net_caisini_vc_article_details_48551287]

## 1 配置logback日志 ##

*  删除 application.yml 中的日志配置
 *  安装idea彩色日志插件：grep console
 *  resources 中创建 logback-spring.xml （默认日志的名字，必须是这个名字）

<?xml version="1.0" encoding="UTF-8"?>
    <configuration scan="true" scanPeriod="10 seconds">
        <contextName>logback</contextName>
        <property name="log.path" value="F:/project/helen/guli_log/edu"/>
        
        
        
        
        
        
        <property name="CONSOLE_LOG_PATTERN"
                  value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/>
        
        <property name="FILE_LOG_PATTERN"
                  value="%date{yyyy-MM-dd HH:mm:ss} |%-5level |%thread |%file:%line |%logger |%msg%n"/>
        
        <property name="ENCODING"
                  value="UTF-8"/>
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                
                <level>DEBUG</level>
            </filter>
            <encoder>
                
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
                
                <charset>${ENCODING}</charset>
            </encoder>
        </appender>
        
        <appender name="INFO_FILE" 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>
            
            <file>${log.path}/log_info.log</file>
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>${ENCODING}</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>500MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
        </appender>
        <appender name="WARN_FILE" 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>
            
            <file>${log.path}/log_warn.log</file>
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>${ENCODING}</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
        </appender>
        <appender name="ERROR_FILE" 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>
            
            <file>${log.path}/log_error.log</file>
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>${ENCODING}</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
        </appender>
        
        <springProfile name="dev">
            
            <root level="INFO">
                <appender-ref ref="CONSOLE"/>
                <appender-ref ref="INFO_FILE"/>
                <appender-ref ref="WARN_FILE"/>
                <appender-ref ref="ERROR_FILE"/>
            </root>
        </springProfile>
        
        <springProfile name="pro">
            <root level="ERROR">
                <appender-ref ref="ERROR_FILE"/>
            </root>
        </springProfile>
    </configuration>

## 2 节点说明 ##

*  <property>：定义变量
 *  <appender>：定义日志记录器
 *  <filter>：定义日志过滤器
 *  <rollingPolicy>：定义滚动策略
 *  <springProfile>：定义日志适配的环境
 *  <root>：根日志记录器

## 3 控制日志级别 ##

通过在开发环境设置以下<root>节点的 level 属性的值，调节日志的级别。

<springProfile name="dev">
            
            <root level="INFO">
                <appender-ref ref="CONSOLE"/>
                <appender-ref ref="INFO_FILE"/>
                <appender-ref ref="WARN_FILE"/>
                <appender-ref ref="ERROR_FILE"/>
            </root>
        </springProfile>

### 3.1 控制台彩色日志INFO级别的打印如下。 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70][]

### 3.2 文件打印策略如下 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 1][]

# 三 异常日志处理 #

## 1 用日志记录器异常错误日志 ##

GlobalExceptionHandler.java 中,类上添加注解

> @Slf4j

修改异常输出语句

// e.printStackTrace();
    log.error(e.getMessage());

## 2 输出日志堆栈信息 ##

为了保证日志的堆栈信息能够被输出，我们需要定义工具类

common\_util中创建ExceptionUtil.java工具类

/**
    * @className: ExceptionUtils
    * @description: 异常工具类
    * @date: 2020/11/20
    * @author: cakin
    */
    public class ExceptionUtils {
        public static String getMessage(Exception e) {
            StringWriter sw = null;
            PrintWriter pw = null;
            try {
                sw = new StringWriter();
                pw = new PrintWriter(sw);
                // 将出错的栈信息输出到printWriter中
                e.printStackTrace(pw);
                pw.flush();
                sw.flush();
            } finally {
                if (sw != null) {
                    try {
                        sw.close();
                    } catch (IOException e1) {
                        e1.printStackTrace();
                    }
                }
                if (pw != null) {
                    pw.close();
                }
            }
            return sw.toString();
        }
    }

修改异常输出语句

// e.printStackTrace();
    // log.error(e.getMessage());
    log.error(ExceptionUtils.getMessage(e));

这样修改后，日志文件就有异常打印了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 2][]

[https_blog.csdn.net_caisini_vc_article_details_48551287]: https://blog.csdn.net/caisini_vc/article/details/48551287
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70]: /images/20210724/091cb16c2cf240f6b7374c020b91c51d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 1]: /images/20210724/44a1e6df43b94301af0c0afe51cb6218.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 2]: /images/20210724/1e24da6b92c64260899168fe93dd1581.png