SpringBoot中使用RestControllerAdvice进行统一异常拦截

1、创建一个ApiExceptionHandler类,定义全局异常捕捉处理

001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
import java.io.IOException;
 
import javax.servlet.http.HttpServletRequest;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.ConversionNotSupportedException;
import org.springframework.beans.TypeMismatchException;
import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.web.HttpMediaTypeNotAcceptableException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
 
import com.zongjikeji.core.result.Result;
import com.zongjikeji.core.result.ResultEnum;
 
/**
 * @author Nick Tan
 */@RestControllerAdvice
public class ApiExceptionHandler {
 
    private final static Logger logger = LoggerFactory.getLogger(ApiExceptionHandler.class);
 
    @ExceptionHandler(ErrorException.class)
    public Result errorExceptionHandler(ErrorException ex, HttpServletRequest request) {
        // response.setStatus(ex);
        return resultFormat(ex.getCode(), ex.getMessage(), ex, request);
    }
 
    @ExceptionHandler(RuntimeException.class)
    public Result runtimeExceptionHandler(RuntimeException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.UNKNOW_ERROR, ex, request);
    }
 
    @ExceptionHandler(NullPointerException.class)
    public Result nullPointerExceptionHandler(NullPointerException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.UNKNOW_ERROR, ex, request);
    }
 
    @ExceptionHandler(ClassCastException.class)
    public Result classCastExceptionHandler(ClassCastException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.UNKNOW_ERROR, ex, request);
    }
 
    @ExceptionHandler(IOException.class)
    public Result iOExceptionHandler(IOException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.UNKNOW_ERROR, ex, request);
    }
 
    @ExceptionHandler(NoSuchMethodException.class)
    public Result noSuchMethodExceptionHandler(NoSuchMethodException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.UNKNOW_ERROR, ex, request);
    }
 
    @ExceptionHandler(IndexOutOfBoundsException.class)
    public Result indexOutOfBoundsExceptionHandler(IndexOutOfBoundsException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.UNKNOW_ERROR, ex, request);
    }
 
    @ExceptionHandler({ HttpMessageNotReadableException.class })
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public Result requestNotReadable(HttpMessageNotReadableException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.PARAM_ERROR, ex, request);
    }
 
    @ExceptionHandler({ TypeMismatchException.class })
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public Result requestTypeMismatch(TypeMismatchException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.PARAM_ERROR, ex, request);
    }
 
    @ExceptionHandler({ MissingServletRequestParameterException.class })
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public Result requestMissingServletRequest(MissingServletRequestParameterException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.PARAM_ERROR, ex, request);
    }
 
    @ExceptionHandler({ HttpRequestMethodNotSupportedException.class })
    @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
    public Result request405(HttpRequestMethodNotSupportedException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.METHOD_NOT_ALLOWED, ex, request);
    }
 
    @ExceptionHandler({ HttpMediaTypeNotAcceptableException.class })
    @ResponseStatus(HttpStatus.NOT_ACCEPTABLE)
    public Result request406(HttpMediaTypeNotAcceptableException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.NOT_ACCEPTABLE, ex, request);
    }
 
    @ExceptionHandler({ ConversionNotSupportedException.class, HttpMessageNotWritableException.class })
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public Result server500(RuntimeException ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.INTERNAL_SERVER_ERROR, ex, request);
    }
 
    @ExceptionHandler({ StackOverflowError.class })
    public Result requestStackOverflow(StackOverflowError ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.UNKNOW_ERROR, ex, request);
    }
 
    @ExceptionHandler({ Exception.class })
    public Result exception(Exception ex, HttpServletRequest request) {
        return resultFormat(ResultEnum.UNKNOW_ERROR, ex, request);
    }
 
    private <T extends Throwable> Result resultFormat(int code, String message, T ex, HttpServletRequest request) {
        logger.warn("Controller Exception[" + request.getRequestURI() + "]-" + code + ":" + message, ex);
        return Result.instance(code, message, null);
    }
 
    private <T extends Throwable> Result resultFormat(ResultEnum ResultEnum, T ex, HttpServletRequest request) {
        logger.warn("Controller Exception[" + request.getRequestURI() + "]-" + ResultEnum.getCode() + ":"
                + ResultEnum.getMessage(), ex);
        return Result.instance(ResultEnum.getCode(), ResultEnum.getMessage(), null);
    }
}

2、创建一个ErrorException自定义异常类

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/**
 * @author Nick Tan
 */public class ErrorException extends RuntimeException {
 
    private static final long serialVersionUID = -1162371143658279115L;
 
    private int code;
 
    private String message;
 
    public ErrorException(int code, String message) {
        super();
        this.code = code;
        this.message = message;
    }
 
    public int getCode() {
        return code;
    }
 
    @Override
    public String getMessage() {
        return message;
    }
}

3、返回数据及错误代码

参考:Java API统一返回Response格式

发表评论

欢迎阅读『SpringBoot中使用RestControllerAdvice进行统一异常拦截|Java、开发语言、框架算法|Nick Tan-梓潼Blog』