自定义Spring Cloud Gateway异常返回报文，让错误更友好

2023-06-01 00:15:20

自定义 Spring Cloud Gateway 异常返回报文：提升用户体验

在微服务架构中，Spring Cloud Gateway 作为一款强大的网关，负责处理来自客户端的请求并将其转发到后端服务。然而，在实际应用中，难免会遇到异常情况。这些异常如果处理不当，可能会对用户体验造成不利影响。

自定义异常返回报文的重要性

默认情况下，Spring Cloud Gateway 会根据异常类型返回标准的 HTTP 状态代码和简短的错误信息。然而，这些信息对于用户来说可能过于技术化或难以理解。为了提升用户体验，我们可以自定义异常返回报文，以更加友好和易于理解的方式呈现异常信息。

如何自定义异常返回报文

自定义异常返回报文涉及创建和注册一个 Filter 类。Filter 是一个特殊的 Spring Bean，会在请求处理过程中被调用。在 Filter 中，我们可以捕获异常并生成自定义的异常返回报文。

以下是一个自定义异常返回报文的 Filter 示例：

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class CustomExceptionFilter implements GatewayFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        try {
            return chain.filter(exchange);
        } catch (IllegalArgumentException e) {
            ServerHttpResponse response = exchange.getResponse();
            response.setStatusCode(HttpStatus.BAD_REQUEST);
            return response.getWriter().write(Mono.just("参数不合法"));
        }
    }

}