Spring Cloud Gateway自定义异常处理Exception Handler的示例分析

这篇文章给大家分享的是有关Spring Cloud Gateway自定义异常处理Exception Handler的示例分析的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。

方法1: ErrorWebExceptionHandler (仅供示意)

自定义一个 GlobalErrorAttributes:

@Componentpublic class GlobalErrorAttributes extends DefaultErrorAttributes{    @Override    public Map<String, Object> getErrorAttributes(ServerRequest request, ErrorAttributeOptions options) {        Throwable error = super.getError(request);        Map<String, Object> map = super.getErrorAttributes(request, options);        map.put("status", HttpStatus.BAD_REQUEST.value());        map.put("message", error.getMessage());        return map;    }}

实现一个

@Component@Order(-2)public class GlobalErrorWebExceptionHandler extends AbstractErrorWebExceptionHandler {    public GlobalErrorWebExceptionHandler(GlobalErrorAttributes gea, ApplicationContext applicationContext,                                          ServerCodecConfigurer serverCodecConfigurer) {        super(gea, new WebProperties.Resources(), applicationContext);        super.setMessageWriters(serverCodecConfigurer.getWriters());        super.setMessageReaders(serverCodecConfigurer.getReaders());    }    //渲染html或json    @Override    protected RouterFunction<ServerResponse> getRoutingFunction(final ErrorAttributes errorAttributes) {        return RouterFunctions.route(RequestPredicates.all(), this::renderErrorResponse);    }    private Mono<ServerResponse> renderErrorResponse(final ServerRequest request) {        final Map<String, Object> errorPropertiesMap = getErrorAttributes(request, ErrorAttributeOptions.defaults());        return ServerResponse.status(HttpStatus.BAD_REQUEST)                .contentType(MediaType.APPLICATION_JSON)                .body(BodyInserters.fromValue(errorPropertiesMap));    }}

方法2, 仅实现一个 ErrorAttributes, 以覆盖默认的 DefaultErrorAttributes

//Spring 默认的就很好了.@Componentpublic class GatewayErrorAttributes extends DefaultErrorAttributes {    private static final Logger logger = LoggerFactory.getLogger(GatewayErrorAttributes.class);    @Override    public Map<String, Object> getErrorAttributes(ServerRequest request,  ErrorAttributeOptions options) {        Throwable error = super.getError(request);        Map<String, Object> errorAttributes = new HashMap<>(8);        errorAttributes.put("message", error.getMessage());        errorAttributes.put("method", request.methodName());        errorAttributes.put("path", request.path());        MergedAnnotation<ResponseStatus> responseStatusAnnotation = MergedAnnotations                .from(error.getClass(), MergedAnnotations.SearchStrategy.TYPE_HIERARCHY).get(ResponseStatus.class);        HttpStatus errorStatus = determineHttpStatus(error, responseStatusAnnotation);        //必须设置, 否则会报错, 因为 DefaultErrorWebExceptionHandler 的 renderErrorResponse 方法会获取此属性, 重新实现 DefaultErrorWebExceptionHandler也可.        errorAttributes.put("status", errorStatus.value());        errorAttributes.put("code", errorStatus.value());        //html view用        errorAttributes.put("timestamp", new Date());        //html view 用        errorAttributes.put("requestId", request.exchange().getRequest().getId());        errorAttributes.put("error", errorStatus.getReasonPhrase());        errorAttributes.put("exception", error.getClass().getName());        return errorAttributes;    }    //从DefaultErrorWebExceptionHandler中复制过来的    private HttpStatus determineHttpStatus(Throwable error, MergedAnnotation<ResponseStatus> responseStatusAnnotation) {        if (error instanceof ResponseStatusException) {            return ((ResponseStatusException) error).getStatus();        }        return responseStatusAnnotation.getValue("code", HttpStatus.class).orElse(HttpStatus.INTERNAL_SERVER_ERROR);    }    }

这样就可以了.

注意注意: 必须设置 errorAttributes.put("status", errorStatus.value()) , 否则会报错, 因为 DefaultErrorWebExceptionHandler 的 renderErrorResponse 方法会获取此属性. 除非你自己像方法一一样重新实现 DefaultErrorWebExceptionHandler.

然后在网关中访问一个不存在的服务, 即可看到效果.

curl 'http://127.0.0.1:8900/fundmain22/abc/gogogo?id=1000' --header 'Accept: application/json'
{"exception":"org.springframework.web.server.ResponseStatusException","path":"/fundmain22/abc/gogogo","code":404,"method":"GET","requestId":"094e53e5-1","message":"404 NOT_FOUND","error":"Not Found","status":404,"timestamp":"2021-08-09T11:07:44.106+0000"}

感谢各位的阅读！关于“Spring Cloud Gateway自定义异常处理Exception Handler的示例分析”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，让大家可以学到更多知识，如果觉得文章不错，可以把它分享出去让更多的人看到吧！