SpringBoot自定义全局异常处理并返回统一JSON格式

定义全局统一异常：程序中减少大量try catch 代码；当系统突然出错，会返回一串不雅代码。

统一返回JSON格式：系统返回信息给客户端需要JSON格式，定义一个类可以统一返回，不用在每个要返回的控制器写上重复的代码。

1.定义一个枚举类

package com.chenhognlong.error;

public enum CustomEnum {
    RETURN_SUCCESS("200", "请求成功了"),
    RETURN_FAIL("500", "请求失败"),
    NOT_FOUND("404", "未找到该资源!"),
    INTERNAL_SERVER_ERROR("500", "服务器内部错误!"),
    SERVER_BUSY("503","服务器正忙，请稍后再试!");

    private String code;
    private String msg;


    CustomEnum(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    CustomEnum() {
    }
}

2.定义一个自定义的异常类

public class CustomUsrException extends RuntimeException{
    private String code;
    private String msg;
}

3.定义一个统一返回的JSON格式的类

public class CustomReturnJSON<T> {
    private String code;
    private String msg;
    private T data;

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public CustomReturnJSON() {
    }

    public CustomReturnJSON(String code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    // 返回成功
    public static <T> CustomReturnJSON<T> success(CustomEnum customEnum, T data){
        CustomReturnJSON<T> c = new CustomReturnJSON();
        c.setCode(customEnum.getCode());
        c.setMsg(customEnum.getMsg());
        c.setData(data);
        return c;
    }
    // 返回失败
    public static <T> CustomReturnJSON<T> fail(CustomEnum customEnum){
        CustomReturnJSON<T> c = new CustomReturnJSON();
        c.setCode(customEnum.getCode());
        c.setMsg(customEnum.getMsg());
        return c;
    }
}

4.定义一个异常处理器

@RestControllerAdvice ：可以被看作是 @ControllerAdvice 和 @ResponseBody 的组合。

• @ControllerAdvice：这个注解用于定义全局的控制器相关的行为，比如全局的异常处理、数据绑定等。它本身并不暗示返回的响应体应该自动转换为JSON或XML等格式。

• @ResponseBody：这个注解用于指示一个方法返回的值应该被写入到HTTP响应体中，通常用于将Java对象转换为JSON或XML响应。这通常与@RequestMapping或@GetMapping等注解一起使用在控制器方法上。

• @RestControllerAdvice：这个注解结合了@ControllerAdvice的全局行为和@ResponseBody的自动响应体转换特性。这意味着，在@RestControllerAdvice标记的类中定义的方法返回的任何对象都会自动转换为JSON或XML响应，而不需要在每个方法上都添加@ResponseBody注解。

@ExceptionHandler：

• @ExceptionHandler 注解用于标记一个方法，该方法将处理由控制器方法抛出的特定异常（自定义的异常类型）。当控制器方法抛出异常时，Spring MVC会查找所有@RestControllerAdvice或@ControllerAdvice类中带有匹配@ExceptionHandler注解的方法，并调用它们来处理异常。

该方法的参数：是某一类的异常对象

@RestControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    /**
     * 拦截业务异常，返回业务异常信息
     * @param 参数是一个触发该异常的异常对象
     * @return 统一格式类的实例 传入了一个枚举
     */

    // CustomUsrException.class  是你自己定义的异常类型
    // 触发了CustomUsrException 则会到这个类（GlobalExceptionHandler ）来执行该方法
    // 你可以定义很多种异常类，并在这里定义方法即可
    @ExceptionHandler(CustomUsrException.class)
    public CustomReturnJSON handleBusinessError(CustomUsrException customUsrException) {
        logger.error("触发了自定义的异常！！！！");
        return CustomReturnJSON.fail(CustomEnum.RETURN_FAIL);
    }

}

5.测试

@RestController
@RequestMapping("/demo")
public class DemoController {

    @GetMapping("/mytest")
    public CustomReturnJSON myTest(){
        // 模拟触发异常
        if (1 == 1){
            // 成功
            throw new CustomUsrException();
        }
        // 没有异常则返回统一格式
        return CustomReturnJSON.fail(CustomEnum.RETURN_FAIL);
    }

}

如下：