SpringBoot全局异常处理+Slf4j日志文件配置

超详细的Java知识点路线图

---

概述

在做项目开发时，必须要做异常处理，但如果每个方法都写try-catch，会导致代码冗余，维护性变差，在SpringBoot中提供了非常优雅的全局异常处理方法解决这个难题。

全局异常处理

1）相关依赖

 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 <dependency>
     <groupId>org.projectlombok</groupId>
     <artifactId>lombok</artifactId>
     <optional>true</optional>
 </dependency>

2）Json数据包装类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class JsonResult {

    private Integer code;
    private String msg;
    private String url;
}

3）全局异常处理类

/**
 * 全局异常处理
 */
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHanlder {

    @ExceptionHandler(Exception.class)
    public ResponseEntity handleException(Exception ex, HttpServletRequest request){
        log.error("Exception ",ex);
        return ResponseEntity.ok(new JsonResult(500,ex.getMessage(),request.getRequestURL().toString()));
    }
}

代码说明：

@Slf4j 是注入日志对象log
@RestControllerAdvice 注解将当前类作为全局异常处理类，Rest表示里面所有方法都直接返回JSON数据，
如果需要页面跳转可以使用@ControllerAdvice 
@ExceptionHandler配置异常处理方法，value是处理的异常类型，Exception.class就是处理所有异常了
处理方法中进行了日志输出，并将异常信息以JSON方法发送给客户端。

4）测试

@RestController
@RequestMapping("/test")
public class TestController {

    @GetMapping("/{id}")
    public ResponseEntity findUser(@PathVariable("id") Long id){
        int n = 10 / 0;
        return ResponseEntity.ok("查询到用户" + id);
    }
}

自定义异常处理

上面案例中处理的是通用的异常，我们在做开发时，经常需要根据业务需要自定义异常，对自定义异常的处理也应该和通用异常的处理有所区别。
1） 添加自定义异常

/**
 * 自定义业务异常
 */
@Data
@NoArgsConstructor
public class BizException extends RuntimeException {

    private Integer code;
    private String msg;

    public BizException(Integer code,String msg) {
        super(msg);
        this.code = code;
        this.msg = msg;
    }
}

2） 给全局异常处理类，添加新方法

@ExceptionHandler(BizException.class)
public ResponseEntity handleBizException(BizException ex, HttpServletRequest request){
    log.error("BizException ",ex);
    return ResponseEntity.ok(new JsonResult(ex.getCode(),ex.getMessage(),request.getRequestURL().toString()));
}

3）测试

@RestController
@RequestMapping("/test")
public class TestController {

    @GetMapping("/{id}")
    public ResponseEntity findUser(@PathVariable("id") Long id){
//        int n = 10 / 0;
        if(id > 100){
            throw new BizException(404,"没有此用户");
        }
        return ResponseEntity.ok("查询到用户" + id);
    }
}

日志文件配置

SpringBoot默认使用slf4j+logback的方式完成日志处理。
@Slf4j注解能够给所在类注入log对象,能够输出各种级别的日志，级别由低到高：
trace < debug < info < warn < error
日志默认只能在控制台输出

项目上线后，肯定需要日志文件来记录运行过程，那么就需要对日志进行配置
在resources下添加logback-spring.xml配置文件就可以了，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--每隔10秒，扫描当前配置-->
<configuration  scan="true" scanPeriod="10 seconds">
    <contextName>logback</contextName>
    <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
    <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
    <!-- 定义日志存储的路径，不要配置相对路径 -->
    <property name="FILE_PATH" value="C:/oa-log/spring-log.%d{yyyy-MM-dd}.%i.log" />
    <!-- 控制台输出日志 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 日志级别过滤INFO以下 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <!-- 按照上面配置的LOG_PATTERN来打印日志 -->
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!--每天生成一个日志文件，保存30天的日志文件。rollingFile用来切分文件的 -->
    <appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${FILE_PATH}</fileNamePattern>
            <!-- 保留30天 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 最大大小 -->
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 超出删除文件 -->
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- 配置日志默认级别 -->
    <logger name="com.xray.oa.exception" level="ERROR" />
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="console" />
        <appender-ref ref="rollingFile" />
    </root>
</configuration>

结束

好了就写这么多，如果能帮到你，就很高兴了：）

---

大家如果需要学习其他Java知识点，戳这里 超详细的Java知识点汇总