@ControllerAdvice @ExceptionHandler用法 全局异常处理两种方法（HandlerExceptionResolver）及全局返回处理 ResponseBodyAdvice

@ControllerAdvice 作用

controller 的增强，用于对controller 做一些统一的操作，一般是用于全局的异常处理，也可以用于全局结果的返回处理

可以在一定程度上简化代码，减少代码的书写量，统一对所有结果和异常做处理，包括异常信息的返回和错误日志的答应等

全局异常处理举例以及说明

@ControllerAdvice ，@ExceptionHandler 的全局处理

Slf4j 为日志注解

......
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
@Slf4j
public class MyGlobalExceptionHandler {

	// 自定义异常
    @ResponseBody
    @ExceptionHandler(value = MyException.class)
    public Response<String> handle(HttpServletRequest request, MyException e) {
        log.error("错误信息:{}", e.getMessage(), e);
		return Response.failMessage(e.getCode(), e.getMessage());
    }
    
    // @Valid 校验框架抛出的特殊异常类
    @ResponseBody
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public Response<String> handleValidException(HttpServletRequest request, MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        StringBuilder message = new StringBuilder();
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            for (ObjectError allError : allErrors) {
                message.append(allError.getDefaultMessage()).append(", ");
            }
        }
        return Response.failMessage(message.toString());
    }

	// 默认其他的所有异常
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public Response<String> handleOtherException(HttpServletRequest request, Exception e) {
        log.error("request error Exception:", e);
        return Response.failMessage(e.getMessage());
    }
}

说明：

这的 Response 类为自己定义的一个返回体类
属性很简单只有三个
code 状态码
message 返回信息
data 最终返回的结果，可能没有

@ResponseBody ：返回体为 json 结构

@ExceptionHandler：
通过指定不同的异常类型来完成不同异常的处理

从以上方法可以看出，入参可以包含三个 HttpServletRequest （当前请求，可以从这里获取请求的路径以及类型等，用于完善日志信息），XxxxxException(某一种特殊的异常对象)，有请求自然也可以有响应体 HttpServletResponse（可以用于特殊返回体里面的内容）

请求类型和路径可以通过 request 方式获取：

String method = request.getMethod();
String requestURI = request.getRequestURI();

spring, springMVC 中的另一种处理方式

import lombok.extern.slf4j.Slf4j;
import org.apache.http.protocol.HTTP;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
@Component
public class MyExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request,
                                         HttpServletResponse response, Object handler, Exception ex) {

        log.error("全局异常捕获", ex);

        ModelAndView modelAndView = new ModelAndView();

        // 如果抛出的是系统自定义的异常则直接转换
        // 可以出现多个 instance 定义不同的返回
        if(ex instanceof MyException) {
            modelAndView.setStatus(HttpStatus.OK);
            modelAndView.addObject("code", ((MyException) ex).getCode());
            modelAndView.addObject("message", ex.getMessage());
        } else {
            modelAndView.setStatus(HttpStatus.INTERNAL_SERVER_ERROR);
            modelAndView.addObject("code", HttpStatus.INTERNAL_SERVER_ERROR);
            modelAndView.addObject("message", ex.getMessage());
        }

        response.setHeader(HTTP.CONTENT_TYPE, "application/json;charset=UTF-8");

        return modelAndView;
    }
}

全局结果返回处理

实现接口 ResponseBodyAdvice

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

// controller 增强   以及实现请求响应体返回增强
@ControllerAdvice(basePackages = {"org.aurora.controller"})
public class MyResponseAdvice implements ResponseBodyAdvice<Object> {

	// 支持哪些的定义
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    	// 这里的 Response.class 为统一的返回实体 为自定义返回类
    	// 这里的意思就是当返回体不是response 的时候就都执行下面的方法
        return returnType.getParameterType() != Response.class;
    }

	// 在将结果写入返回体前的动作
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
                                  Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        // 这里的意思是上面支持后的结果 我会将结果放到我定义的返回结构里面 最为结果返回，没有就是null 也不会出错
        return Response.setSuccess(body);
    }
}

这样写有什么好处？

可以统一定义返回体的结构，我们只需要Controller 将需要的结果返回即可，最后的包装过程统一完成，可以减少所有controller 的封装返回体过程，只需要统一处理这一次书写即可！
可以在相当程度上减少封装返回体的代码量。