Spring实现全局异常处理

2021-12-21

Spring实现全局异常处理

引入依赖

// https://mvnrepository.com/artifact/com.alibaba/fastjson
implementation group: 'com.alibaba', name: 'fastjson', version: '1.2.78'

// https://mvnrepository.com/artifact/org.projectlombok/lombok
compileOnly group: 'org.projectlombok', name: 'lombok', version: '1.18.10'

ServerResponseT

package com.demo;

import com.alibaba.fastjson.JSONObject;
import lombok.Data;

@Data
public class ServerResponseT<T> {

    String status;      // 成功 or 失败
    Integer code;       // 响应状态码
    String message;     // 响应信息
    Object data;        // 响应数据

    public static <T> ServerResponseT<T> getInstance(Class<T> t) {
        return new ServerResponseT<T>();
    }

    public static ServerResponseT<?> getInstance() {
        return new ServerResponseT();
    }

    public ServerResponseT<?> code(Integer code) {
        this.code = code;
        return (ServerResponseT<?>) this;
    }

    public ServerResponseT<?> message(String message) {
        this.message = message;
        return (ServerResponseT<?>) this;
    }

    public ServerResponseT<?> data(Object data) {
        this.data = data;
        return (ServerResponseT<?>) this;
    }

    public ServerResponseT<T> t_data(T data) {
        this.data = data;
        return (ServerResponseT<T>) this;
    }


    public ServerResponseT<T> responseEnum(ResponseEnum responseEnum) {
        this.code = responseEnum.code;
        this.message = responseEnum.message;
        return (ServerResponseT<T>) this;
    }

    public ServerResponseT<?> ok() {
        this.status = "success";
        return (ServerResponseT<?>) this;
    }

    public ServerResponseT<?> failed() {
        this.status = "failed";
        return (ServerResponseT<?>) this;
    }

    @Override
    public String toString() {
        JSONObject resultJson = new JSONObject();
        resultJson.put("code", this.code);
        resultJson.put("status", this.status);
        resultJson.put("message", this.message);
        resultJson.put("data", this.data);
        return resultJson.toString();
    }

}

ServerResponse

package com.demo;

import com.alibaba.fastjson.JSONObject;
import lombok.Data;
import lombok.EqualsAndHashCode;

@EqualsAndHashCode(callSuper = true)
@Data
public class ServerResponse extends ServerResponseT {

    String status;      // 成功 or 失败
    Integer code;       // 响应状态码
    String message;        // 响应信息
    Object data;        // 响应数据

    public static ServerResponse getInstance() {
        return new ServerResponse();
    }

    public ServerResponse code(Integer code) {
        this.code = code;
        return (ServerResponse) this;
    }

    public ServerResponse message(String message) {
        this.message = message;
        return (ServerResponse) this;
    }

    public ServerResponse data(Object data) {
        this.data = data;
        return (ServerResponse) this;
    }


    public ServerResponse responseEnum(ResponseEnum responseEnum) {
        this.code = responseEnum.code;
        this.message = responseEnum.message;
        return (ServerResponse) this;
    }

    public ServerResponse ok() {
        this.status = "success";
        responseEnum(ResponseEnum.SUCCESS);
        return (ServerResponse) this;
    }

    public ServerResponse failed() {
        this.status = "failed";
        responseEnum(ResponseEnum.FAILED);
        return (ServerResponse) this;
    }

    @Override
    public String toString() {
        JSONObject resultJson = new JSONObject();
        resultJson.put("code", this.code);
        resultJson.put("status", this.status);
        resultJson.put("message", this.message);
        resultJson.put("data", this.data);
        return resultJson.toString();
    }

}

ResponseEnum

package com.demo;

public enum ResponseEnum {

    // 数据操作错误定义
    SUCCESS(200, "成功!"),
    FAILED(202, "失败!"),
    BODY_NOT_MATCH(400, "请求的数据格式不符!"),
    SIGNATURE_NOT_MATCH(401, "请求的数字签名不匹配!"),
    NOT_FOUND(404, "未找到该资源!"),
    INTERNAL_SERVER_ERROR(500, "服务器内部错误!"),
    SERVER_BUSY(503, "服务器正忙，请稍后再试!");

    Integer code;        // 响应码
    String message;      // 响应信息

    ResponseEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Boolean checkCode(Integer code) {
        return this.code.equals(code);
    }

    public Integer getResultCode() {
        return code;
    }

    public String getResultMsg() {
        return message;
    }

}

GlobalExceptionHandler

package com.demo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

/**
 * 全局异常处理类
 */
@RestControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 处理自定义的业务异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = MyException.class)
    public String myExceptionHandler(MyException e) {
        logger.error("发生业务异常！原因是：{}", e.getErrorMsg());
        return ServerResponse.getInstance().failed().code(Integer.parseInt(e.getErrorCode())).message(e.getErrorMsg()).toString();
    }

    /**
     * 处理空指针的异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = NullPointerException.class)
    public String nullPointExceptionHandler(NullPointerException e) {
        logger.error("发生空指针异常！原因是:", e);
        return ServerResponse.getInstance().failed().responseEnum(ResponseEnum.BODY_NOT_MATCH).toString();
    }

    /**
     * 处理其他异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    public String exceptionHandler(Exception e) {
        logger.error("未知异常！原因是:", e.getMessage());
        return ServerResponse.getInstance().failed().responseEnum(ResponseEnum.INTERNAL_SERVER_ERROR).toString();
    }
}

MyException

package com.demo;

public class MyException extends RuntimeException {

    private static final long serialVersionUID = 1L;

    /**
     * 错误码
     */
    protected String errorCode;

    /**
     * 错误信息
     */
    protected String errorMsg;

    public MyException() {
        super();
    }

    public MyException(String errorMsg) {
        super(errorMsg);
        this.errorMsg = errorMsg;
    }

    public MyException(String errorCode, String errorMsg) {
        super(errorCode);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public MyException(String errorCode, String errorMsg, Throwable cause) {
        super(errorCode, cause);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }


    public String getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMsg() {
        return errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }


    @Override
    public Throwable fillInStackTrace() {
        return this;
    }

}

TestController

package com.demo;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 控制层
 */
@RestController
@RequestMapping("/api")
public class TestController {

    /**
     * 抛出NullPointerException
     *
     * @return
     */
    @RequestMapping("/test")
    public String test() {

        throw new NullPointerException();
    }

    /**
     * 抛出自定义异常
     *
     * @return
     */
    @RequestMapping("/test2")
    public String test2() {

        throw new MyException("111", "error");
    }
}

引入依赖

ServerResponseT

ServerResponse

ResponseEnum

GlobalExceptionHandler

MyException

TestController

测试