app.myoss.cloud.web.spring.web.method.aspectj

Class AopLogControllerExceptionHandler

java.lang.Object

org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

app.myoss.cloud.web.spring.web.method.aspectj.AopLogControllerExceptionHandler

@ConditionalOnWebApplication
 @ControllerAdvice
public class AopLogControllerExceptionHandler
extends org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

全局Controller异常处理器

Spring Boot官方文档给出的示例是直接继承ResponseEntityExceptionHandler，但是此类中的方法 ResponseEntityExceptionHandler.handleException(Exception, WebRequest) 是final的， 无法进行覆盖 （不覆盖将会导致此方法上捕获的异常无法在使用AOP拦截），并且没有将异常输出到log中。通过重写方法 ResponseEntityExceptionHandler.handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatus, WebRequest) ，因为所有的异常处理最后一步都会走到这里，对外的错误异常统一输出，完美解决。

如果要开启此功能，EnableAopLogController

如果要禁用掉此功能，EnableAopLogController.enableAopLogControllerException()

Since:

2018年4月11日 下午12:10:23

Author:

Jerry.Chen

See Also:

ResponseEntityExceptionHandler, EnableAopLogController

Field Summary

Fields

Modifier and Type	Field and Description
protected MonitorControllerProperties	properties

Fields inherited from class org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

logger, PAGE_NOT_FOUND_LOG_CATEGORY, pageNotFoundLogger

Constructor Summary

Constructors

Constructor and Description
AopLogControllerExceptionHandler()

Method Summary

Modifier and Type	Method and Description
static org.springframework.http.HttpStatus	getStatus(javax.servlet.http.HttpServletRequest request) 获取 HTTP 请求响应状态码
org.springframework.http.ResponseEntity<Object>	handleException(Throwable ex, javax.servlet.http.HttpServletRequest request) 不在页面暴露具体的异常信息
protected org.springframework.http.ResponseEntity<Object>	handleExceptionInternal(Exception ex, Object responseBody, org.springframework.http.HttpHeaders headers, org.springframework.http.HttpStatus status, org.springframework.web.context.request.WebRequest request) ResponseEntityExceptionHandler.handleException(Exception, WebRequest) 是final的， 无法进行覆盖 （不覆盖将会导致此方法上捕获的异常无法在使用AOP拦截），并且没有将异常输出到log中。通过重写方法 ResponseEntityExceptionHandler.handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatus, WebRequest) ，因为所有的异常处理最后一步都会走到这里，对外的错误异常统一输出，完美解决。
protected org.springframework.http.ResponseEntity<Object>	outputException(Throwable ex, org.springframework.http.HttpHeaders headers, org.springframework.http.HttpStatus status, javax.servlet.http.HttpServletRequest servletRequest) 对外的错误异常统一输出JSON字符串，并且包含traceId，方便跟踪错误日志

Methods inherited from class org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

handleAsyncRequestTimeoutException, handleBindException, handleConversionNotSupported, handleException, handleHttpMediaTypeNotAcceptable, handleHttpMediaTypeNotSupported, handleHttpMessageNotReadable, handleHttpMessageNotWritable, handleHttpRequestMethodNotSupported, handleMethodArgumentNotValid, handleMissingPathVariable, handleMissingServletRequestParameter, handleMissingServletRequestPart, handleNoHandlerFoundException, handleServletRequestBindingException, handleTypeMismatch

Methods inherited from class java.lang.Object

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

Field Detail

properties

@Autowired
protected MonitorControllerProperties properties

Constructor Detail

AopLogControllerExceptionHandler

public AopLogControllerExceptionHandler()

Method Detail

getStatus

public static org.springframework.http.HttpStatus getStatus(javax.servlet.http.HttpServletRequest request)

获取 HTTP 请求响应状态码

Parameters:

request - HTTP 请求

Returns:

响应状态码

handleException

@ExceptionHandler(value=java.lang.Throwable.class)
 @ResponseBody
public org.springframework.http.ResponseEntity<Object> handleException(Throwable ex,
                                                                                                                                         javax.servlet.http.HttpServletRequest request)

不在页面暴露具体的异常信息

Parameters:

ex - 异常信息

request - 客户端请求信息

Returns:

服务端返回信息

handleExceptionInternal

protected org.springframework.http.ResponseEntity<Object> handleExceptionInternal(Exception ex,
                                                                                  Object responseBody,
                                                                                  org.springframework.http.HttpHeaders headers,
                                                                                  org.springframework.http.HttpStatus status,
                                                                                  org.springframework.web.context.request.WebRequest request)

ResponseEntityExceptionHandler.handleException(Exception, WebRequest) 是final的， 无法进行覆盖 （不覆盖将会导致此方法上捕获的异常无法在使用AOP拦截），并且没有将异常输出到log中。通过重写方法 ResponseEntityExceptionHandler.handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatus, WebRequest) ，因为所有的异常处理最后一步都会走到这里，对外的错误异常统一输出，完美解决。

Overrides:

handleExceptionInternal in class org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

outputException

protected org.springframework.http.ResponseEntity<Object> outputException(Throwable ex,
                                                                          org.springframework.http.HttpHeaders headers,
                                                                          org.springframework.http.HttpStatus status,
                                                                          javax.servlet.http.HttpServletRequest servletRequest)

对外的错误异常统一输出JSON字符串，并且包含traceId，方便跟踪错误日志

Parameters:

ex - 异常信息

headers - 服务端返回的HttpHeaders信息

status - 服务端返回的状态码

servletRequest - 客户端请求信息

Returns:

服务端返回信息