Spring Cloud - 通过 Gateway webflux 编程实现网关异常处理

痛定思痛。 2024-02-19 09:24 38阅读 0赞

## 一、webflux 编程实现网关异常处理 ##

--------------------

我们知道在某一个服务中出现异常，可以通过 @ControllerAdvice + @ExceptionHandler 来统一异常处理，即使是在微服务架构中，我们也可以将上述统一异常处理放入到公共的微服务中，这样哪一个微服务需要，直接引入模块即可。 但是如果我们的 网关微服务 出现了异常，该怎么处理呢？

步骤如下：

1.  在网关微服务中创建一个类，添加 @Configuration 注解将其作为配置类.
2.  实现自定义 ErrorWebExceptionHandler 接口，重写 handle 方法.
3.  在 handle 方法中实现统一异常处理.

代码注释如下：

@Slf4j
    @Configuration
    public class GlobalExceptionConfig implements ErrorWebExceptionHandler {
    
    
        @Autowired
        private ObjectMapper objectMapper;
    
        /**
         * 全局异常处理
         * @param exchange 交换器(request, response)
         * @param ex 出现异常时的异常对象
         * @return
         */
        @Override
        public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
            Map<String, String> result = new HashMap<>();
            //1.获取响应对象
            ServerHttpResponse response = exchange.getResponse();
    
            //2. response 是否结束(一般不用，可以用来处理多个异常的场景)
            if(response.isCommitted()) {
                return Mono.error(ex);
            }
    
            //3.设置响应头类型(JSON)
            response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
    
            //4.设置响应状态码
            if (ex instanceof IllegalTokenException) {
                //是我们自定义的异常
                response.setStatusCode(HttpStatus.FORBIDDEN);
            } else {
                //不是我们自定义的异常，就通过 "服务器异常" 来处理
                response.setStatusCode(HttpStatus.INTERNAL_SERVER_ERROR);
            }
    
            //5.处理统一异常响应
            return response.writeWith(Mono.fromSupplier(() -> {
                DataBufferFactory bufferFactory = response.bufferFactory();
                result.put("msg", ex.getMessage());
                try {
                    return bufferFactory.wrap(objectMapper.writeValueAsBytes(result));
                } catch (JsonProcessingException e) {
                    throw new RuntimeException(e);
                }
            }));
        }
    
    }

*  IllegalTokenException：是我们自定义的异常，通常在上述代码的第四步中，就需要根据我们判断 ex 属于我们的哪种自定义异常，然后进行对应的状态码处理.![8173a62410654991be8495ea4afd325b.png][]
 *  Mono.fromSupplier()：是一个函数式接口，参数这里通过一 lamada 表达式实现（无参，返回值是一个 Mono）泛型. 这里要实现的逻辑就是把异常的响应进行封装.
 *  bufferFactory.wrap：这里就是按照 webflux 编程的方式，参数是 json 格式（通过 ObjectMapper 转化），得到一个 Mono 对象.

那么，如果在网关的中抛出了异常，如下：

![84222fb6170049e88c3c4c800fd458ce.png][]

![b3352ac38d254ed9ad96bfa6fe3b4ba7.png][]

![8ed4d2f3d4254b2c8ff980b6aa6e85eb.gif][]

[8173a62410654991be8495ea4afd325b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/feae9ebdeb414755ae57a586e2aad409.png
[84222fb6170049e88c3c4c800fd458ce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/11b094c7cba249628fa5675930350eee.png
[b3352ac38d254ed9ad96bfa6fe3b4ba7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/c4e3d06f5a414183b433a47a8c9c345e.png
[8ed4d2f3d4254b2c8ff980b6aa6e85eb.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/5457afbe35a842d4b855019d688fd60f.png