SpringBoot的两种统一错误处理方式

1.使用继承BasicErrorController 来实现
SpringBoot为我们提供了自动处理异常的BasicErrorController 其返回的JSON数据如下:

“timestamp”:…
“status”:…
“error”:…
“exception”:…
“path”:…
“message”:…

但一般 前端只需要我们传的message 信息，那么我们需要重新构造返回的JSON数据

（1）首先 创建错误枚举

/**
 * @BelongsProject: financial
 * @BelongsPackage: com.yhr.manager.error
 * @Author: yang
 * @CreateTime: 2019-03-26 13:14
 * @Description: 错误种类
 */
public enum ErrorEnum {

    ID_NOT_NULL("F001","编号不可为空",false),
    //,.,,,
    UNKNOWN("999","未知异常",false);


    private String code;
    private String message;
    private boolean canRestry;

    ErrorEnum(String code,String message,boolean canRestry){
        this.code=code;
        this.message=message;
        this.canRestry=canRestry;
    }

    public static ErrorEnum getByCode(String code){
        for (ErrorEnum errorEnum : ErrorEnum.values()) {
            if(errorEnum.code.equals(code)){
                return errorEnum;
            }
        }
        return UNKNOWN;
    }

    public String getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    public boolean isCanRestry() {
        return canRestry;
    }}

（2）我们通过spring-boot-autoconfigure 依赖包下面 找到一个属性BasicErrorController
BasicErrorController ，创建MyErrorController 继承BasicErrorController 代码如下

public class MyErrorController extends BasicErrorController {
    public MyErrorController(ErrorAttributes errorAttributes, ErrorProperties errorProperties, List<ErrorViewResolver> errorViewResolvers) {
        super(errorAttributes, errorProperties, errorViewResolvers);
    }


    /**
     * 自定义错误处理结果
     * 只要 message信息 并添加 code ,canRetry 信息
     * @param request
     * @param includeStackTrace
     * @return
     */
    @Override
    protected Map<String, Object> getErrorAttributes(HttpServletRequest request, boolean includeStackTrace) {
        Map<String, Object>  attrs = super.getErrorAttributes(request, includeStackTrace);
        attrs.remove("timestamp");
        attrs.remove("status");
        attrs.remove("error");
        attrs.remove("exception");
        attrs.remove("path");
        String errorCode = (String) attrs.get("message");
        ErrorEnum errorEnum=ErrorEnum.getByCode(errorCode);
        attrs.put("message",errorEnum.getMessage());
        attrs.put("code",errorEnum.getCode());
        attrs.put("canRetry",errorEnum.isCanRestry());
        return  attrs;

    }
}

加入了我们自己需要的message code canRetry 。通过本身BasciController 里的message （这里的message是我们业务逻辑处理时

 Assert.notNull(product.getId(), ErrorEnum.ID_NOT_NULL.getCode());

而抛出的枚举ID_NOT_NULL ，我们将其捕获 并返回message code canRetry

（3）配置ErrorConfiguration
由于BasicErrorContorller 是被ErrorMvcAutoConfiguration 所注入的 于是我们找到ErrorMvcAutoConfiguration 注入BasicErrorController的方法

public ErrorMvcAutoConfiguration(ServerProperties serverProperties,
			ObjectProvider<List<ErrorViewResolver>> errorViewResolversProvider) {
		this.serverProperties = serverProperties;
		this.errorViewResolvers = errorViewResolversProvider.getIfAvailable();
	}


	@Bean
	@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
	public BasicErrorController basicErrorController(ErrorAttributes errorAttributes) {
		return new BasicErrorController(errorAttributes, this.serverProperties.getError(),
				this.errorViewResolvers);
	}

因此我们创建自己的ErrorConfiguration ，复制上面的方法，并做修改
以下是我们自己的ErrorConfiguration代码

/**
 * @BelongsProject: financial
 * @BelongsPackage: com.yhr.manager.error
 * @Author: yang
 * @CreateTime: 2019-03-26 13:08
 * @Description: 错误处理相关配置
 */

/**
 * 从 ErrorMvcAutoConfiguration 里复制的方法 再进行改造
 */
@Configuration
public class ErrorConfiguration {

    @Bean
    @ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
    public MyErrorController basicErrorController(ErrorAttributes errorAttributes, ServerProperties serverProperties, ObjectProvider<List<ErrorViewResolver>> errorViewResolversProvider) {
        return new MyErrorController(errorAttributes, serverProperties.getError(),
                errorViewResolversProvider.getIfAvailable());
    }

}

好了至此 配置结束 我们查看结果 就得到我们想要返回的数据了

2.通过@ControllerAdvice 注解来处理统一错误
@ControllerAdivce 是比@Controller 的增强，对于这个注解 ，处理统一错误只是它的一种使用方式。

话不多说 代码如下:

/**
 * @BelongsProject: financial
 * @BelongsPackage: com.yhr.manager.error
 * @Author: yang
 * @CreateTime: 2019-03-26 13:27
 * @Description: 统一错误处理
 */
//
@ControllerAdvice("com.yhr.manager.controller")
public class ErrorControllerAdvice {


    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseEntity handleException(Exception e){
        Map<String, Object> attrs = new HashMap<>();
        String errorCode = (String) attrs.get("message");
        ErrorEnum errorEnum=ErrorEnum.getByCode(errorCode);
        attrs.put("message",errorEnum.getMessage());
        attrs.put("code",errorEnum.getCode());
        attrs.put("canRetry",errorEnum.isCanRestry());
        attrs.put("type","advice"); //这里加入这个只是测试一下 是否使用controller advice 来控制异常的
        return new ResponseEntity(attrs, HttpStatus.INTERNAL_SERVER_ERROR);
  }
}

@ControllerAdvice 里的参数可以指定增强控制器要扫描的包，如果制定了 只对这个包产生作用，不指定，是对全局抛出的错误都产生作用

这里我们加入一个type 属性 来看看两种处理统一错误共存情况下的处理顺序
我们访问:

由此可见 @ControllerAdvice是优先于MyErrorController处理的
如下图所示：

ControllerAdvice 是所有Controller外包裹的一层
如果我们在@ControllerAdvice里抛出一个异常，那么这个异常将会被下一级的MyErrorController处理。