SpringMvc统一异常处理@RestControllerAdvice
统一异常处理主要是防止项目未捕获的异常直接返回给用户,给用户不好的体验和暴露细节。
还需要配合@ExceptionHandler注解细化异常的处理,翻看@RestControllerAdvice注解源码是包含@ResponseBody和@ControllerAdvice注解的, 所以无需在方法中添加@ResponseBody注解,即可返回json数据
@Slf4j
@RestControllerAdvice
public class XzyConsoleExceptionHandler {
private static final ImmutableMap<Class<? extends Throwable>, ResponseEnum> EXCEPTION_MAPPINGS;
static {
final ImmutableMap.Builder<Class<? extends Throwable>, ResponseEnum> builder = ImmutableMap.builder();
builder.put(MethodArgumentTypeMismatchException.class, ResponseEnum.INVALID_PARAMS_CONVERSION);
builder.put(UnsatisfiedServletRequestParameterException.class, ResponseEnum.INVALID_PARAMS_CONVERSION);
builder.put(HttpRequestMethodNotSupportedException.class, ResponseEnum.REQUEST_METHOD_NOT_SUPPORTED);
builder.put(HttpMessageNotReadableException.class, ResponseEnum.HTTP_MESSAGE_NOT_READABLE);
builder.put(Exception.class, ResponseEnum.SERVER_UNKNOWN_ERROR);
EXCEPTION_MAPPINGS = builder.build();
}
@ExceptionHandler(HystrixRuntimeException.class)
public XzyResponse hystrixRuntimeException(HystrixRuntimeException e, HttpServletRequest request) {
return exception(e, request);
}
@ExceptionHandler(XzyConsoleException.class)
public XzyResponse xzyConsoleException(XzyConsoleException e, HttpServletRequest request) {
int code = Integer.parseInt(e.getMessage());
ResponseEnum responseEnum = ResponseEnum.valueOfCode(code);
return XzyResponse.build(responseEnum);
}
@ExceptionHandler(Exception.class)
public XzyResponse exception(Exception e, HttpServletRequest request) {
final ResponseEnum responseEnum = EXCEPTION_MAPPINGS.get(e.getClass());
final XzyResponse xzyResponse;
if(responseEnum != null) {
xzyResponse = XzyResponse.build(responseEnum);
} else {
xzyResponse = XzyResponse.build(ResponseEnum.SERVER_UNKNOWN_ERROR);
}
return xzyResponse;
}
}
XzyConsoleException是自定义的异常,相当于业务异常。
有不对的地方或者更好的方法欢迎指正。