开发中 — — 异常与日志处理

梦里梦外; 2024-04-06 12:49 97阅读 0赞

## 开发中 — — 异常与日志处理 ##

> 在企业开发中，对异常的处理显得尤为重要，因为一旦处理不好就极有可能让用户看到不友好的界面

### 1 异常处理（全局处理异常） ###

- common
    	- common-util
    	- serivce-util

![在这里插入图片描述][30001fb2efe64a1494cf996900d4c63f.png]

#### 1.1 在common-util模块添加异常类 ####

/**
     * 自定义全局异常类
     *
     * @author qy
     */
    @Data
    @ApiModel(value = "自定义全局异常类")
    public class YyghException extends RuntimeException {
        
    
        @ApiModelProperty(value = "异常状态码")
        private Integer code;
    
        /**
         * 通过状态码和错误消息创建异常对象
         * @param message
         * @param code
         */
        public YyghException(String message, Integer code) {
        
            super(message);
            this.code = code;
        }
    
        /**
         * 接收枚举类型对象
         * @param resultCodeEnum
         */
        public YyghException(ResultCodeEnum resultCodeEnum) {
        
            super(resultCodeEnum.getMessage());
            this.code = resultCodeEnum.getCode();
        }
    
        @Override
        public String toString() {
        
            return "YyghException{" +
                    "code=" + code +
                    ", message=" + this.getMessage() +
                    '}';
        }
    }

#### 1.2 在service-util模块添加全局异常处理 ####

@ControllerAdvice
    public class GlobalExceptionHandler {
        
    
        @ExceptionHandler(Exception.class)//处理Exception异常
        @ResponseBody//返回值转换为json格式
        public Result error(Exception e){
        
            e.printStackTrace();
            return Result.fail();
        }
    
    
        @ExceptionHandler(YyghException.class)//自定义异常处理办法
        @ResponseBody
        public Result error(YyghException e){
        
            return Result.build(e.getCode(), e.getMessage());
        }
    }

#### 1.3 测试 ####

> 在controller中，手写一个异常

![在这里插入图片描述][6efa95b2c0024abba7691cebe15b08ed.png]

通过Swagger发送请求，服务端发送回来的数据【走全局异常处理】：  
![在这里插入图片描述][e2f66ee5e1c54ee790801b677132f775.png]

> 手动抛出自定义异常

![在这里插入图片描述][11db5b8530fa4a509d7dae07b8784f90.png]

返回结果：  
![在这里插入图片描述][ab0c4a915a08457a85ceb25b1c25577b.png]

### 2 日志处理 ###

> 在开发中，日志也是很重要的，一个良好的日志，可以让我们快速定位到问题所在

日志记录器（Logger）的行为是分等级的。如下所示：  
分为：OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL  
默认情况下，spring boot从控制台打印出来的日志级别只有INFO及以上级别，可以配置日志级别

> 设置日志级别  
> logging.level.root=WARN  
> 这种方式只能将日志打印在控制台上

#### 2.1 logback日志 ####

spring boot内部使用Logback作为日志实现的框架。  
Logback和log4j非常相似，如果你对log4j很熟悉，那对logback很快就会得心应手。

在想要使用logback日志模块的resource目录下，创建logback-spring.xml即可完成配置【文件名不变】  
![在这里插入图片描述][45ca04042a9e49ae9bd4f1afa45b30e5.png]

#### 2.2 logback日志内容（样板） ####

> <property name=“log.path” value=“D:/yygh\_log/edu” /> 指定日志输出目录

<?xml version="1.0" encoding="UTF-8"?>
    <configuration  scan="true" scanPeriod="10 seconds">
        
        
        
        
        <contextName>logback</contextName>
        
        <property name="log.path" value="D:/yygh_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)"/>
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>INFO</level>
            </filter>
            <encoder>
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
                
                <charset>UTF-8</charset>
            </encoder>
        </appender>
        
        
        <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_info.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</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>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_warn.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</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>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
    
        
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_error.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</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>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        
        
        <springProfile name="dev">
            
            <logger name="com.guli" level="INFO" />
    
            
            <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="INFO">
                <appender-ref ref="CONSOLE" />
                <appender-ref ref="DEBUG_FILE" />
                <appender-ref ref="INFO_FILE" />
                <appender-ref ref="ERROR_FILE" />
                <appender-ref ref="WARN_FILE" />
            </root>
        </springProfile>
    </configuration>

结果：  
![在这里插入图片描述][9143dec036c24762a49bfd76fd6060bc.png]  
![!\[在这里插入图片描述)][eca983cd996146d1bd1e2928347b5c83.png]

[30001fb2efe64a1494cf996900d4c63f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/4461f0c796984b6fb16d2c4a6c428812.png
[6efa95b2c0024abba7691cebe15b08ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/1f2a190ceb244573aab73a3ccf5a3620.png
[e2f66ee5e1c54ee790801b677132f775.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/a960d02f87854b60b3d18bcd7b649d1c.png
[11db5b8530fa4a509d7dae07b8784f90.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/3ac1144f524f49f1b78bec2dbcfbe622.png
[ab0c4a915a08457a85ceb25b1c25577b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/9fcb8931281442cba3225ba223afd6d6.png
[45ca04042a9e49ae9bd4f1afa45b30e5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/5770a6ae82954fd39269cec44d5ee3cf.png
[9143dec036c24762a49bfd76fd6060bc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/ec0d6b9fed3244e78189d8d73ccdf463.png
[eca983cd996146d1bd1e2928347b5c83.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/d0faa182af94419b9bc7e3eef27b5d1e.png