pro.haichuang.framework.base.config.mvc

类 BaseControllerAdvice

java.lang.Object

pro.haichuang.framework.base.config.mvc.BaseControllerAdvice

@RestControllerAdvice
public class BaseControllerAdvice
extends Object

全局Controller异常处理

该类具体实现了全局请求异常拦截, 对于不同的异常有不同的拦截并返回, 无论是自定义异常/校验异常/未知异常等都具有详细的实现, 拦截后给予客户端友好返回, 同时将异常规范的写出到日志文件中, 便于项目运行中通过日志排查问题

注意: 该类启用的前置条件为标注了 @EnableControllerAdvice 注解

从以下版本开始:

1.1.0.211021

作者:

JiYinchuan

构造器概要

构造器

构造器和说明
BaseControllerAdvice()

方法概要

限定符和类型	方法和说明
BaseVO	generalErrorHandle(ApplicationException e, javax.servlet.http.HttpServletRequest request) 自定义异常全局捕获
BaseVO	serverErrorHandler(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 系统异常全局捕获
BaseVO	stackTracerErrorHandler(StackTraceException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 堆栈异常全局捕获
com.alibaba.fastjson.JSONObject	thirdPartyErrorHandler(ThirdPartyException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 第三方异常全局捕获
com.alibaba.fastjson.JSONObject	validationExceptionHandler(org.springframework.validation.BindException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 绑定异常全局捕获
com.alibaba.fastjson.JSONObject	validationExceptionHandler(org.springframework.http.converter.HttpMessageNotReadableException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 请求体异常全局捕获 RequestType = RequestBody Also throw to InvalidFormatException
com.alibaba.fastjson.JSONObject	validationExceptionHandler(org.springframework.web.HttpRequestMethodNotSupportedException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 方法不被允许全局捕获
com.alibaba.fastjson.JSONObject	validationExceptionHandler(org.springframework.web.bind.MethodArgumentNotValidException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 请求体验证全局捕获 RequestType = RequestBody 捕获来自 javax.validation.constraints
com.alibaba.fastjson.JSONObject	validationExceptionHandler(org.springframework.web.method.annotation.MethodArgumentTypeMismatchException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 参数转换异常全局捕获
com.alibaba.fastjson.JSONObject	validationExceptionHandler(org.springframework.web.bind.MissingServletRequestParameterException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 参数为空全局捕获 RequestType = RequestParam 捕获来自 RequestParam
com.alibaba.fastjson.JSONObject	validationExceptionHandler(javax.validation.ValidationException e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 验证异常全局捕获 RequestType = RequestParam 捕获来自 javax.validation.constraints

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

BaseControllerAdvice

public BaseControllerAdvice()

方法详细资料

generalErrorHandle

@ExceptionHandler(value=ApplicationException.class)
public BaseVO generalErrorHandle(ApplicationException e,
                                                                                      javax.servlet.http.HttpServletRequest request)

自定义异常全局捕获

参数:

e - ApplicationException

request - HttpServletRequest

返回:

结果响应

从以下版本开始:

1.1.0.211021

stackTracerErrorHandler

@ExceptionHandler(value=StackTraceException.class)
public BaseVO stackTracerErrorHandler(StackTraceException e,
                                                                                          javax.servlet.http.HttpServletRequest request,
                                                                                          javax.servlet.http.HttpServletResponse response)

堆栈异常全局捕获

参数:

e - StackTraceException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

thirdPartyErrorHandler

@ExceptionHandler(value=ThirdPartyException.class)
public com.alibaba.fastjson.JSONObject thirdPartyErrorHandler(ThirdPartyException e,
                                                                                                                  javax.servlet.http.HttpServletRequest request,
                                                                                                                  javax.servlet.http.HttpServletResponse response)

第三方异常全局捕获

参数:

e - ThirdPartyException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

serverErrorHandler

@ExceptionHandler(value=java.lang.Exception.class)
public BaseVO serverErrorHandler(Exception e,
                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                     javax.servlet.http.HttpServletResponse response)

系统异常全局捕获

参数:

e - Exception

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

validationExceptionHandler

@ExceptionHandler(value=org.springframework.web.bind.MissingServletRequestParameterException.class)
public com.alibaba.fastjson.JSONObject validationExceptionHandler(org.springframework.web.bind.MissingServletRequestParameterException e,
                                                                                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                       javax.servlet.http.HttpServletResponse response)

参数为空全局捕获

RequestType = RequestParam

捕获来自 RequestParam

参数:

e - MissingServletRequestParameterException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

validationExceptionHandler

@ExceptionHandler(value=org.springframework.web.method.annotation.MethodArgumentTypeMismatchException.class)
public com.alibaba.fastjson.JSONObject validationExceptionHandler(org.springframework.web.method.annotation.MethodArgumentTypeMismatchException e,
                                                                                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                javax.servlet.http.HttpServletResponse response)

参数转换异常全局捕获

参数:

e - MethodArgumentTypeMismatchException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

validationExceptionHandler

@ExceptionHandler(value=javax.validation.ValidationException.class)
public com.alibaba.fastjson.JSONObject validationExceptionHandler(javax.validation.ValidationException e,
                                                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                                                       javax.servlet.http.HttpServletResponse response)

验证异常全局捕获

RequestType = RequestParam

捕获来自 javax.validation.constraints

参数:

e - ValidationException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

validationExceptionHandler

@ExceptionHandler(value=org.springframework.http.converter.HttpMessageNotReadableException.class)
public com.alibaba.fastjson.JSONObject validationExceptionHandler(org.springframework.http.converter.HttpMessageNotReadableException e,
                                                                                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                     javax.servlet.http.HttpServletResponse response)

请求体异常全局捕获

RequestType = RequestBody

Also throw to InvalidFormatException

参数:

e - HttpMessageNotReadableException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

另请参阅:

Enum deserialize failed exception is unsolved

validationExceptionHandler

@ExceptionHandler(value=org.springframework.web.bind.MethodArgumentNotValidException.class)
public com.alibaba.fastjson.JSONObject validationExceptionHandler(org.springframework.web.bind.MethodArgumentNotValidException e,
                                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                                               javax.servlet.http.HttpServletResponse response)

请求体验证全局捕获

RequestType = RequestBody

捕获来自 javax.validation.constraints

参数:

e - MethodArgumentNotValidException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

validationExceptionHandler

@ExceptionHandler(value=org.springframework.validation.BindException.class)
public com.alibaba.fastjson.JSONObject validationExceptionHandler(org.springframework.validation.BindException e,
                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                               javax.servlet.http.HttpServletResponse response)

绑定异常全局捕获

参数:

e - BindException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021

validationExceptionHandler

@ExceptionHandler(value=org.springframework.web.HttpRequestMethodNotSupportedException.class)
public com.alibaba.fastjson.JSONObject validationExceptionHandler(org.springframework.web.HttpRequestMethodNotSupportedException e,
                                                                                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                 javax.servlet.http.HttpServletResponse response)

方法不被允许全局捕获

参数:

e - HttpRequestMethodNotSupportedException

request - HttpServletRequest

response - HttpServletResponse

返回:

结果响应

从以下版本开始:

1.1.0.211021