轻松上手，打造独一无二的SpringCloud GateWay全局过滤器

2023-06-15 05:42:30

微服务中的 Spring Cloud Gateway：掌控自定义全局过滤器

简介

微服务架构凭借其灵活性、可扩展性和弹性，在构建现代分布式系统时广受欢迎。而 Spring Cloud Gateway 作为一款强大的微服务网关框架，更是让开发者轻松实现路由、过滤器和跨域配置，极大简化了微服务开发和维护工作。

本文将深入探讨 Spring Cloud Gateway 中的自定义全局过滤器，为你提供构建复杂过滤逻辑和增强系统控制的全面指南。

获取请求参数

自定义过滤器的核心步骤之一是获取请求参数。在 Spring Cloud Gateway 中，你可以使用特殊的 ServerWebExchange 对象，它不同于 Servlet 中的 request，来访问请求信息。

ServerHttpRequest request = exchange.getRequest();
MultiValueMap<String, String> queryParams = request.getQueryParams();

queryParams 是一个多键 map 集合，其中键可以重复。

校验

获取请求参数后，就可以对它们进行校验，确保其合法且符合业务规则。

String userName = queryParams.getFirst("userName");

if (userName == null || userName.isEmpty()) {
    // 校验不通过，返回错误
}

放行

如果校验通过，则放行请求，继续执行后续操作。

return chain.filter(exchange);

拦截

如果校验不通过，则拦截请求，并根据需要做出相应处理，如返回错误信息或禁止访问。

return Mono.error(new RuntimeException("userName is required"));

代码示例

以下代码展示了一个完整的自定义全局过滤器示例，用于检查 userName 参数并阻止其为空的请求。

@Component
public class CustomGlobalFilter implements GlobalFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> queryParams = request.getQueryParams();

        String userName = queryParams.getFirst("userName");

        if (userName == null || userName.isEmpty()) {
            return Mono.error(new RuntimeException("userName is required"));
        }

        return chain.filter(exchange);
    }
}