SpringBoot 入门:10 - 统一异常处理

在开发过程中,我们经常会遇到程序报错的情况,对调用方来说,这种情况下他们能看到的就是一大段错误或者是描述模糊的提示。我们希望对可预期的异常进行全局捕获,并进行适当处理,然后以清晰的说明返回给调用方。

在 Spring Boot 中我们可以使用 @ControllerAdvice 注解然后配合 @ExceptionHandler 对不同类型的异常进行统一的捕获并输出:

@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public ApiResponse<Object> constraintViolationException(ConstraintViolationException e) {
    return ApiResponse.fail(400, e.getConstraintViolations().iterator().next().getMessage());
}

@ExceptionHandler
@ResponseBody
public ApiResponse<Object> unknownException(Exception e) {
    log.error("[CUSTOM]Handling error: " + e.getClass().getSimpleName() + ", " + e.getMessage());
    return ApiResponse.fail(ApiCode.API_ERR);
}
复制代码

第二个方法是通用异常捕获输出,上面的异常处理方法没有捕获到的异常都有一个兜底的处理方法。第一个方法是对参数校验失败的异常进行捕获并获取第一个校验失败的参数的失败说明进行输出。

上面的捕获方式只能对程序进入到 Controller 层之后报出的异常进行捕获,比如如果是认证失败、未授权等这类前置过滤器、拦截器中报出的异常则无法进行捕获,所以我们还需要在 WebSecurityConfig 中的 configure(HttpSecurity http) 方法进行异常处理:

@Override
protected void configure(HttpSecurity http) throws Exception {
    http.exceptionHandling()
        .authenticationEntryPoint((httpServletRequest, httpServletResponse, e) -> ApiResponse.fail(httpServletResponse, ApiCode.API_UNAUTHORIZED.getMsg()))
        .accessDeniedHandler((httpServletRequest, httpServletResponse, e) -> ApiResponse.fail(httpServletResponse, ApiCode.API_ACCESS_DENIED.getMsg()));

    http.addFilterBefore(jwtAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
}
复制代码

暂时就这么多,多实践,多分享~

原文  https://juejin.im/post/5f16b803f265da22b05b05dc
正文到此结束
Loading...