Spring Cloud Gateway全局通用异常处理的实现

 更新时间:2020年05月28日 10:25:35   作者:冷冷  
这篇文章主要介绍了Spring Cloud Gateway全局通用异常处理的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

为什么需要全局异常处理

在传统 Spring Boot 应用中, 我们 @ControllerAdvice 来处理全局的异常,进行统一包装返回

// 摘至 spring cloud alibaba console 模块处理
@ControllerAdvice
public class ConsoleExceptionHandler {

  @ExceptionHandler(AccessException.class)
  private ResponseEntity<String> handleAccessException(AccessException e) {
    return ResponseEntity.status(HttpStatus.FORBIDDEN).body(e.getErrMsg());
  }
}

例如: ③ 处应用调用数据库异常,通过 @ControllerAdvice 包装异常请求响应给客户端

但在微服务架构下, 例如 ② 处 网关调用业务微服务失败(转发失败、调用异常、转发失败),在应用设置的 @ControllerAdvice 将失效,因为流量根本没有转发到应用上处理。

如上图: 模拟所有路由断言都不匹配 404 , 和 spring boot 默认保持一致的错误输出页面。 显然我们在网关同样配置 @ControllerAdvice 是不能解决问题,因为 spring cloud gateway 是基于 webflux 反应式编程。

解决方法

默认处理流程

ExceptionHandlingWebHandler 作为 spring cloud gateway 最核心 WebHandler 的一部分会进行异常处理的过滤

public class ExceptionHandlingWebHandler extends WebHandlerDecorator {
  @Override
  public Mono<Void> handle(ServerWebExchange exchange) {
    Mono<Void> completion;
    try {
      completion = super.handle(exchange);
    }
    catch (Throwable ex) {
      completion = Mono.error(ex);
    }

   // 获取全局的 WebExceptionHandler 执行
    for (WebExceptionHandler handler : this.exceptionHandlers) {
      completion = completion.onErrorResume(ex -> handler.handle(exchange, ex));
    }
    return completion;
  }
}

默认实现 DefaultErrorWebExceptionHandler

public class DefaultErrorWebExceptionHandler {

  @Override
  protected RouterFunction<ServerResponse> getRoutingFunction(ErrorAttributes errorAttributes) {
   // 根据客户端 `accpet` 请求头决定返回什么资源,如上浏览器返回的是 页面
    return route(acceptsTextHtml(), this::renderErrorView).andRoute(all(), this::renderErrorResponse);
  }
}
// 模拟指定 `accpet` 情况
curl --location --request GET 'http://localhost:9999/adminx/xx' \ 18:09:23
   --header 'Accept: application/json'
{"timestamp":"2020-05-24 18:09:24","path":"/adminx/xx","status":404,"error":"Not Found","message":null,"requestId":"083c48e3-2"}⏎

重写 ErrorWebExceptionHandler

/**
 * @author lengleng
 * @date 2020/5/23
 * <p>
 * 网关异常通用处理器,只作用在webflux 环境下 , 优先级低于 {@link ResponseStatusExceptionHandler} 执行
 */
@Slf4j
@Order(-1)
@RequiredArgsConstructor
public class GlobalExceptionConfiguration implements ErrorWebExceptionHandler {
  private final ObjectMapper objectMapper;

  @Override
  public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
    ServerHttpResponse response = exchange.getResponse();

    if (response.isCommitted()) {
      return Mono.error(ex);
    }

    // header set
    response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
    if (ex instanceof ResponseStatusException) {
      response.setStatusCode(((ResponseStatusException) ex).getStatus());
    }

    return response
        .writeWith(Mono.fromSupplier(() -> {
          DataBufferFactory bufferFactory = response.bufferFactory();
          try {
            return bufferFactory.wrap(objectMapper.writeValueAsBytes(R.failed(ex.getMessage())));
          } catch (JsonProcessingException e) {
            log.warn("Error writing response", ex);
            return bufferFactory.wrap(new byte[0]);
          }
        }));
  }
}

总结

  • 重写的 DefaultErrorWebExceptionHandler 优先级一定要小于内置 ResponseStatusExceptionHandler 经过它处理的获取对应错误类的 响应码
  • 其他扩展 可以参考 SentinelBlockExceptionHandler sentinel 整合网关的处理,不过整体和默认的异常处理没有什么区别
  • 基础环境说明:Spring Cloud Hoxton.SR4 & Spring Boot 2.3.0
  • 具体实现代码参考:https://gitee.com/log4j/pig

到此这篇关于Spring Cloud Gateway全局通用异常处理的实现的文章就介绍到这了,更多相关Spring Cloud Gateway全局异常内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • MyBatis中RowBounds实现内存分页

    MyBatis中RowBounds实现内存分页

    RowBounds是MyBatis提供的一种内存分页方式,适用于小数据量的分页场景,本文就来详细的介绍一下,具有一定的参考价值,感兴趣的可以了解一下
    2024-12-12
  • Spring Boot 静态资源处理

    Spring Boot 静态资源处理

    今天小编就为大家分享一篇关于Spring Boot 静态资源处理,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • 详解java Collections.sort的两种用法

    详解java Collections.sort的两种用法

    这篇文章主要介绍了详解java Collections.sort的两种用法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Springboot有效防止XSS攻击的几种方法

    Springboot有效防止XSS攻击的几种方法

    本文介绍了在SpringBoot项目中防止XSS攻击的多种方法,包括输入验证和过滤、输出编码、使用安全框架、使用模板引擎的自动转义功能以及设置安全HTTP头等,感兴趣的可以了解一下
    2024-12-12
  • Java死锁产生原因及示例

    Java死锁产生原因及示例

    本文主要介绍了Java死锁产生原因及示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-06-06
  • SpringCloud-Alibaba-Nacos启动失败解决方案

    SpringCloud-Alibaba-Nacos启动失败解决方案

    这篇文章主要介绍了SpringCloud-Alibaba-Nacos启动失败解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • java多线程之CyclicBarrier的使用方法

    java多线程之CyclicBarrier的使用方法

    这篇文章主要介绍了java多线程之CyclicBarrier的使用方法的相关资料,希望通过本文能帮助到大家,让大家理解掌握这部分内容,需要的朋友可以参考下
    2017-10-10
  • Java进程间通信之消息队列

    Java进程间通信之消息队列

    这篇文章主要为大家详细介绍了Java进程间通信之消息队列,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Java内存泄漏问题的排查、优化与最佳实践

    Java内存泄漏问题的排查、优化与最佳实践

    在 Java 开发中,内存泄漏是一个常见且令人头疼的问题,内存泄漏指的是程序在运行过程中,已经不再使用的对象没有被及时释放,从而导致内存占用不断增加,最终可能导致程序崩溃或性能显著下降,本文给大家介绍了Java内存泄漏排查、优化与最佳实践
    2025-01-01
  • 详解Maven Docker镜像使用技巧

    详解Maven Docker镜像使用技巧

    这篇文章主要介绍了详解Maven Docker镜像使用技巧,Maven是目前最流行的Java项目管理工具之一,提供了强大的包依赖管理和应用构建功能。本文以Maven为例介绍了Docker在应用构建中的一些常见技巧。
    2018-06-06

最新评论