丢掉丑陋的 try-catch 代码块，试试统一异常处理吧!

本文章最先发表于我的个人博客，CSDN为同步发布，如有需要，请访问 腿短快跑的个人博客 获取更多内容

对于我们日常写代码来说，异常常用的处理方式是通过 try-catch 代码块来处理，但是对于生产环境来说，各种 try-catch 代码块不仅使代码变得十分丑陋难以阅读，且如果忘记处理异常可能会导致各种问题，spring 为我们提供了全局异常处理的实现方式!

ControllerAdvice & RestControllerAdvice

这是 spring mvc 中提供的注解，从名称含义上来讲，即：Controller / RestController 建议，在 spring boot 中一样可以使用

这两个注解被 spring 用来对 controller 和 restController 来进行增强

一般主要用于以下 3 个方面：

• 异常处理
• 数据预处理
• 全局数据绑定

实现

自定义异常

BizException.java

package cn.tdkpcw.exception;

import lombok.Data;

/**
 * @author C.W
 * @date 2022/5/9 19:41
 * @desc 异常
 */
@Data
public class BizException extends RuntimeException {

    private Integer code;

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

}

RespModel

RespModel.java

package cn.tdkpcw.model;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author C.W
 * @date 2022/5/9 15:34
 * @desc 响应结果
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class RespModel<T> {

    public static final Integer SUCCESS_CODE = 200;
    public static final Integer ERROR_CODE = 400;

    private Integer code;

    private String message;

    private Long time;

    private T data;

}

ControllerAdvice

RestGlobalExceptionHandler.java

package cn.tdkpcw.exception;

import cn.tdkpcw.model.RespModel;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.servlet.http.HttpServletResponse;

/**
 * @author C.W
 * @date 2022/5/10 11:15
 * @desc 全局异常处理
 */
@Slf4j
@RestControllerAdvice(basePackages = {"cn.tdkpcw.controller"})
public class RestGlobalExceptionHandler {

    @ExceptionHandler(value = {BizException.class})
    public RespModel handleException(BizException e, HttpServletResponse response) {
        log.error("request internal error: ", e);
        return RespModel.builder()
                .code(400)
                .message(e.getMessage())
                .build();
    }

    @ExceptionHandler(value = {Throwable.class})
    public RespModel handleException(Exception e, HttpServletResponse response) {
        log.error("request internal error: ", e);
        response.setStatus(500);
        return RespModel.builder()
                .code(500)
                .message(e.getMessage())
                .build();
    }

}

TestController

TestController.java

package cn.tdkpcw.controller;

import cn.tdkpcw.exception.BizException;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author C.W
 * @date 2022/6/22 20:04
 * @desc
 */
@RestController
public class TestController {

    @GetMapping("biz")
    public Object biz() {
        throw new BizException(400, "测试自定义异常");
    }

    @GetMapping("throw")
    public Object throwExc() throws Throwable {
        throw new Throwable("Throwable异常");
    }

    @GetMapping("normal")
    public Object normal() {
        return "213";
    }

}

测试结果

自定义异常

Throwable异常

正常情况