Spring Boot 2 Webflux的全局异常处理

aoho求索

发布于 2018-12-29 10:53:02

3.7K0

发布于 2018-12-29 10:53:02

文章被收录于专栏：aoho求索aoho求索

本文首先将会回顾Spring 5之前的SpringMVC异常处理机制，然后主要讲解Spring Boot 2 Webflux的全局异常处理机制。

SpringMVC的异常处理

Spring 统一异常处理有 3 种方式，分别为：

使用 @ExceptionHandler 注解
实现 HandlerExceptionResolver 接口
使用 @controlleradvice 注解

使用`@ExceptionHandler`注解

用于局部方法捕获，与抛出异常的方法处于同一个Controller类：

 1@Controller
 2public class BuzController {
 3
 4    @ExceptionHandler({NullPointerException.class})
 5    public String exception(NullPointerException e) {
 6        System.out.println(e.getMessage());
 7        e.printStackTrace();
 8        return "null pointer exception";
 9    }
10
11    @RequestMapping("test")
12    public void test() {
13        throw new NullPointerException("出错了！");
14    }
15}

如上的代码实现，针对BuzController抛出的NullPointerException异常，将会捕获局部异常，返回指定的内容。

实现`HandlerExceptionResolver`接口

通过实现HandlerExceptionResolver接口，这里我们通过继承SimpleMappingExceptionResolver实现类（HandlerExceptionResolver实现，允许将异常类名称映射到视图名称，既可以是一组给定的handlers处理程序，也可以是DispatcherServlet中的所有handlers）定义全局异常：

 1@Component
 2public class CustomMvcExceptionHandler extends SimpleMappingExceptionResolver {
 3
 4    private ObjectMapper objectMapper;
 5
 6    public CustomMvcExceptionHandler() {
 7        objectMapper = new ObjectMapper();
 8    }
 9
10    @Override
11    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response,
12                                         Object o, Exception ex) {
13        response.setStatus(200);
14        response.setContentType(MediaType.APPLICATION_JSON_VALUE);
15        response.setCharacterEncoding("UTF-8");
16        response.setHeader("Cache-Control", "no-cache, must-revalidate");
17        Map<String, Object> map = new HashMap<>();
18        if (ex instanceof NullPointerException) {
19            map.put("code", ResponseCode.NP_EXCEPTION);
20        } else if (ex instanceof IndexOutOfBoundsException) {
21            map.put("code", ResponseCode.INDEX_OUT_OF_BOUNDS_EXCEPTION);
22        } else {
23            map.put("code", ResponseCode.CATCH_EXCEPTION);
24        }
25        try {
26            map.put("data", ex.getMessage());
27            response.getWriter().write(objectMapper.writeValueAsString(map));
28        } catch (Exception e) {
29            e.printStackTrace();
30        }
31        return new ModelAndView();
32    }
33}

如上为示例的使用方式，我们可以根据各种异常定制错误的响应。

使用`@controlleradvice`注解

 1@ControllerAdvice
 2public class ExceptionController {
 3    @ExceptionHandler(RuntimeException.class)
 4    public ModelAndView handlerRuntimeException(RuntimeException ex) {
 5        if (ex instanceof MaxUploadSizeExceededException) {
 6            return new ModelAndView("error").addObject("msg", "文件太大！");
 7        }
 8        return new ModelAndView("error").addObject("msg", "未知错误：" + ex);
 9    }
10
11    @ExceptionHandler(Exception.class)
12    public ModelAndView handlerMaxUploadSizeExceededException(Exception ex) {
13        if (ex != null) {
14            return new ModelAndView("error").addObject("msg", ex);
15        }
16
17        return new ModelAndView("error").addObject("msg", "未知错误：" + ex);
18
19    }
20}

和第一种方式的区别在于，ExceptionHandler的定义和异常捕获可以扩展到全局。

Spring 5 Webflux的异常处理

webflux支持mvc的注解，是一个非常便利的功能，相比较于RouteFunction，自动扫描注册比较省事。异常处理可以沿用ExceptionHandler。如下的全局异常处理对于RestController依然生效。

 1@RestControllerAdvice
 2public class CustomExceptionHandler {
 3    private final Log logger = LogFactory.getLog(getClass());
 4
 5    @ExceptionHandler(Exception.class)
 6    @ResponseStatus(code = HttpStatus.OK)
 7    public ErrorCode handleCustomException(Exception e) {
 8        logger.error(e.getMessage());
 9        return new ErrorCode("e","error" );
10    }
11}

WebFlux示例

WebFlux提供了一套函数式接口，可以用来实现类似MVC的效果。我们先接触两个常用的。

Controller定义对Request的处理逻辑的方式，主要有方面：

方法定义处理逻辑；
然后用@RequestMapping注解定义好这个方法对什么样url进行响应。

在WebFlux的函数式开发模式中，我们用HandlerFunction和RouterFunction来实现上边这两点。

HandlerFunction

HandlerFunction相当于Controller中的具体处理方法，输入为请求，输出为装在Mono中的响应：

1    Mono<T> handle(ServerRequest var1);

在WebFlux中，请求和响应不再是WebMVC中的ServletRequest和ServletResponse，而是ServerRequest和ServerResponse。后者是在响应式编程中使用的接口，它们提供了对非阻塞和回压特性的支持，以及Http消息体与响应式类型Mono和Flux的转换方法。

1@Component
2public class TimeHandler {
3    public Mono<ServerResponse> getTime(ServerRequest serverRequest) {
4        String timeType = serverRequest.queryParam("type").get();
5        //return ...
6    }
7}

如上定义了一个TimeHandler，根据请求的参数返回当前时间。

RouterFunction

RouterFunction，顾名思义，路由，相当于@RequestMapping，用来判断什么样的url映射到那个具体的HandlerFunction。输入为请求，输出为Mono中的Handlerfunction：

1Mono<HandlerFunction<T>> route(ServerRequest var1);

针对我们要对外提供的功能，我们定义一个Route。

 1@Configuration
 2public class RouterConfig {
 3    private final TimeHandler timeHandler;
 4
 5    @Autowired
 6    public RouterConfig(TimeHandler timeHandler) {
 7        this.timeHandler = timeHandler;
 8    }
 9
10    @Bean
11    public RouterFunction<ServerResponse> timerRouter() {
12        return route(GET("/time"), req -> timeHandler.getTime(req));
13    }
14}

可以看到访问/time的GET请求，将会由TimeHandler::getTime处理。

功能级别处理异常

如果我们在没有指定时间类型（type）的情况下调用相同的请求地址，例如/time，它将抛出异常。 Mono和Flux APIs内置了两个关键操作符，用于处理功能级别上的错误。

使用onErrorResume处理错误

还可以使用onErrorResume处理错误，fallback方法定义如下：

1Mono<T> onErrorResume(Function<? super Throwable, ? extends Mono<? extends T>> fallback);

当出现错误时，我们使用fallback方法执行替代路径：

 1@Component
 2public class TimeHandler {
 3    public Mono<ServerResponse> getTime(ServerRequest serverRequest) {
 4        String timeType = serverRequest.queryParam("time").orElse("Now");
 5        return getTimeByType(timeType).flatMap(s -> ServerResponse.ok()
 6                .contentType(MediaType.TEXT_PLAIN).syncBody(s))
 7                .onErrorResume(e -> Mono.just("Error: " + e.getMessage()).flatMap(s -> ServerResponse.ok().contentType(MediaType.TEXT_PLAIN).syncBody(s)));
 8    }
 9
10    private Mono<String> getTimeByType(String timeType) {
11        String type = Optional.ofNullable(timeType).orElse(
12                "Now"
13        );
14        switch (type) {
15            case "Now":
16                return Mono.just("Now is " + new SimpleDateFormat("HH:mm:ss").format(new Date()));
17            case "Today":
18                return Mono.just("Today is " + new SimpleDateFormat("yyyy-MM-dd").format(new Date()));
19            default:
20                return Mono.empty();
21        }
22    }
23}

在如上的实现中，每当getTimeByType()抛出异常时，将会执行我们定义的fallback方法。除此之外，我们还可以捕获、包装和重新抛出异常，例如作为自定义业务异常：

1    public Mono<ServerResponse> getTime(ServerRequest serverRequest) {
2        String timeType = serverRequest.queryParam("time").orElse("Now");
3        return ServerResponse.ok()
4                .body(getTimeByType(timeType)
5                        .onErrorResume(e -> Mono.error(new ServerException(new ErrorCode(HttpStatus.BAD_REQUEST.value(),
6                                "timeType is required", e.getMessage())))), String.class);
7    }

使用onErrorReturn处理错误

每当发生错误时，我们可以使用onErrorReturn()返回静态默认值：

1    public Mono<ServerResponse> getDate(ServerRequest serverRequest) {
2        String timeType = serverRequest.queryParam("time").get();
3        return getTimeByType(timeType)
4                .onErrorReturn("Today is " + new SimpleDateFormat("yyyy-MM-dd").format(new Date()))
5                .flatMap(s -> ServerResponse.ok()
6                        .contentType(MediaType.TEXT_PLAIN).syncBody(s));
7    }

全局异常处理

如上的配置是在方法的级别处理异常，如同对注解的Controller全局异常处理一样，WebFlux的函数式开发模式也可以进行全局异常处理。要做到这一点，我们只需要自定义全局错误响应属性，并且实现全局错误处理逻辑。

我们的处理程序抛出的异常将自动转换为HTTP状态和JSON错误正文。要自定义这些，我们可以简单地扩展DefaultErrorAttributes类并覆盖其getErrorAttributes()方法：

 1@Component
 2public class GlobalErrorAttributes extends DefaultErrorAttributes {
 3
 4    public GlobalErrorAttributes() {
 5        super(false);
 6    }
 7
 8    @Override
 9    public Map<String, Object> getErrorAttributes(ServerRequest request, boolean includeStackTrace) {
10        return assembleError(request);
11    }
12
13    private Map<String, Object> assembleError(ServerRequest request) {
14        Map<String, Object> errorAttributes = new LinkedHashMap<>();
15        Throwable error = getError(request);
16        if (error instanceof ServerException) {
17            errorAttributes.put("code", ((ServerException) error).getCode().getCode());
18            errorAttributes.put("data", error.getMessage());
19        } else {
20            errorAttributes.put("code", HttpStatus.INTERNAL_SERVER_ERROR);
21            errorAttributes.put("data", "INTERNAL SERVER ERROR");
22        }
23        return errorAttributes;
24    }
25    //...有省略
26}

如上的实现中，我们对ServerException进行了特别处理，根据传入的ErrorCode对象构造对应的响应。

接下来，让我们实现全局错误处理程序。为此，Spring提供了一个方便的AbstractErrorWebExceptionHandler类，供我们在处理全局错误时进行扩展和实现：

 1@Component
 2@Order(-2)
 3public class GlobalErrorWebExceptionHandler extends AbstractErrorWebExceptionHandler {
 4
 5    //构造函数
 6    @Override
 7    protected RouterFunction<ServerResponse> getRoutingFunction(final ErrorAttributes errorAttributes) {
 8        return RouterFunctions.route(RequestPredicates.all(), this::renderErrorResponse);
 9    }
10
11    private Mono<ServerResponse> renderErrorResponse(final ServerRequest request) {
12
13        final Map<String, Object> errorPropertiesMap = getErrorAttributes(request, true);
14
15        return ServerResponse.status(HttpStatus.OK)
16                .contentType(MediaType.APPLICATION_JSON_UTF8)
17                .body(BodyInserters.fromObject(errorPropertiesMap));
18    }
19}

这里将全局错误处理程序的顺序设置为-2。这是为了让它比@Order(-1)注册的DefaultErrorWebExceptionHandler处理程序更高的优先级。

该errorAttributes对象将是我们在网络异常处理程序的构造函数传递一个的精确副本。理想情况下，这应该是我们自定义的Error Attributes类。然后，我们清楚地表明我们想要将所有错误处理请求路由到renderErrorResponse()方法。最后，我们获取错误属性并将它们插入服务器响应主体中。

然后，它会生成一个JSON响应，其中包含错误，HTTP状态和计算机客户端异常消息的详细信息。对于浏览器客户端，它有一个whitelabel错误处理程序，它以HTML格式呈现相同的数据。当然，这可以是定制的。

小结

本文首先讲了Spring 5之前的SpringMVC异常处理机制，SpringMVC统一异常处理有 3 种方式：使用 @ExceptionHandler 注解、实现 HandlerExceptionResolver 接口、使用 @controlleradvice 注解；然后通过WebFlux的函数式接口构建Web应用，讲解Spring Boot 2 Webflux的函数级别和全局异常处理机制（对于Spring WebMVC风格，基于注解的方式编写响应式的Web服务，仍然可以通过SpringMVC统一异常处理实现）。

注：本文后半部分基本翻译自https://www.baeldung.com/spring-webflux-errors

本文参与腾讯云自媒体分享计划，分享自微信公众号。

原始发表：2018-12-20，如有侵权请联系 cloudcommunity@tencent.com 删除

spring

本文分享自 aoho求索微信公众号，前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体分享计划，欢迎热爱写作的你一起参与！

spring

登录后参与评论

0 条评论

热度