Gateway网关统一处理异常的配置类

该博客介绍了在前后端分离的系统中,如何自定义全局异常处理类以确保网关在抛出异常时返回JSON格式的响应,而非默认的HTML错误页面。通过创建并配置GlobalExceptionConfiguration类,捕获异常并设置合适的HTTP状态码,转换异常信息为JSON内容,从而实现符合前后端交互需求的异常处理机制。
摘要由CSDN通过智能技术生成

首先,网关为什么要定义全局异常处理类,因为网关默认抛出异常后,返回给前端是html页面的错误提示,现在我们的系统都是前后端分离,要求响应的数据都是json格式的,所以我们要将网关中的异常,响应给前端是以json类型返回。

我们可以自定义异常类,然后在这个全局异常处理中,捕获处理响应httpstatus状态码。

package com.atlml.configs;
import com.atlml.exceptions.IllegalTokenException;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.web.reactive.error.ErrorWebExceptionHandler;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.buffer.DataBufferFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.HashMap;
import java.util.Map;

/**
 * 网关的异常处理类
 */
@Configuration
public class GlobalExceptionConfiguration implements ErrorWebExceptionHandler {
    //日志对象
    private static final Logger log = LoggerFactory.getLogger(GlobalExceptionConfiguration.class);


    @Override //参数1: request response   ex:出现异常时异常对象
    public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
        Map<String, String> result = new HashMap<>();

        //1.获取响应对象
        ServerHttpResponse response = exchange.getResponse();

        //2.response是否结束(如果有多个异常处理时候,这个response对象一定要是没提交的状态)
        if (response.isCommitted()) {
            return Mono.error(ex);
        }

        //2.设置响应头类型
        response.getHeaders().setContentType(MediaType.APPLICATION_JSON);




        //3.设置响应状态码(在这里捕获我们自定义的异常)
        if (ex instanceof IllegalTokenException) {
            response.setStatusCode(HttpStatus.FORBIDDEN);
        } else {
            response.setStatusCode(HttpStatus.INTERNAL_SERVER_ERROR);
        }



        //4.设置响应内容
        return response
                .writeWith(Mono.fromSupplier(() -> {
                    DataBufferFactory bufferFactory = response.bufferFactory();
                    result.put("msg", ex.getMessage());
                    ObjectMapper objectMapper = new ObjectMapper();
                    try {
                        return bufferFactory.wrap(objectMapper.writeValueAsBytes(result));
                    } catch (JsonProcessingException e) {
                        e.printStackTrace();
                        return null;
                    }
                }));
    }
}
  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Spring Cloud Gateway 是一个高性能且轻量级的 API 网关,它是 Spring Cloud 家族的一员,用于路由、过滤和服务发现。在 Gateway 中,异常处理是一个关键功能,它可以帮助你在全局层面上捕获和处理请求过程中可能出现的各种错误。 在 Spring Cloud Gateway 中,你可以使用全局错误处理器(Global Error Handler)来统一处理所有未被路由到其他服务的异常。这样,即使内部微服务发生异常,用户也会看到一致的错误响应,而不是直接暴露服务内部的错误。 以下是实现统一异常处理的基本步骤: 1. 配置全局错误处理器:在 `application.yml` 或 `application.properties` 文件中添加全局异常处理器的配置,例如: ```yaml error: path: /error handler: exception: my.error.handler ``` 2. 创建全局错误处理:定义一个实现了 `ReactiveErrorWebExceptionHandler` 或其子,并实现 `handle` 方法处理不同型的错误。 ```java @Bean public GlobalErrorExceptionHandler myErrorHandler() { return new MyErrorExceptionHandler(); } public class MyErrorExceptionHandler implements ReactiveErrorWebExceptionHandler { @Override public Mono<ServerResponse> handle(ServerRequest request, Throwable ex) { // 这里可以根据异常型、状态码等返回定制化的错误响应 return ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR) .bodyValue("An unexpected error occurred: " + ex.getMessage()); } } ``` 3. 异常处理策略:你可以选择只处理特定型的异常,或者使用 `@ExceptionHandler` 注解来处理特定的 HTTP 状态码。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值