网关(gateway):自定义过滤器(filter)

网关(gateway):自定义过滤器(filter)

![

网关过滤器链中的过滤器有两种:

1、GatewayFilter

路由过滤器,作用范围比较灵活,可以是任意指定的路由Route.

  • 自定义GatewayFilter不是直接实现GatewayFilter,而是实现AbstractGateWayFilterFactory

@Component
public class PrintAnyGatewayFilterFactory extends AbstractGatewayFilterFactory<Object> {
    @Override
    public GatewayFilter apply(Object config) {
        return new GatewayFilter() {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                // 获取请求
                ServerHttpRequest request = exchange.getRequest();
                // 编写过滤器逻辑
                System.out.println("过滤器执行了");
                // 放行
                return chain.filter(exchange);
            }
        };
    }
}
  • 使用

spring:
  cloud:
    gateway:
      default-filters:
            - PrintAny 

2、GlobalFilter

全局过滤器,作用范围是所有路由,声明后自动生效。

  • 自定义实现GlobalFilter接口

//多加一个实现接口Ordered是为了实现排序,例如用户校验应该是微服务转发之前执行。
@Component
public class MyGlobalFilter implements GlobalFilter , Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        HttpHeaders headers = request.getHeaders();
        System.out.println("headers = " + headers);
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}
Spring Cloud Gateway 是基于 Spring Framework 和 Spring Boot 的 API 网关服务,除内置的 GatewayFilter 工厂外,还能自定义 GatewayFilter 满足特定需求 [^3]。 ### 自定义过滤器实现方法 在实际开发中,若内置过滤器无法满足特定业务需求,就需要自定义过滤器自定义过滤器通常要实现 `GatewayFilter` 和 `Ordered` 接口。以下是一个简单示例: ```java import org.springframework.cloud.gateway.filter.GatewayFilter; import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory; import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.stereotype.Component; import reactor.core.publisher.Mono; import java.util.Collections; import java.util.List; @Component public class CustomGatewayFilterFactory extends AbstractGatewayFilterFactory<CustomGatewayFilterFactory.Config> { public CustomGatewayFilterFactory() { super(Config.class); } @Override public List<String> shortcutFieldOrder() { return Collections.singletonList("enabled"); } @Override public GatewayFilter apply(Config config) { return (exchange, chain) -> { if (!config.isEnabled()) { return chain.filter(exchange); } ServerHttpRequest request = exchange.getRequest().mutate() .header("Custom-Header", "Custom-Value") .build(); return chain.filter(exchange.mutate().request(request).build()); }; } public static class Config { private boolean enabled; public boolean isEnabled() { return enabled; } public void setEnabled(boolean enabled) { this.enabled = enabled; } } } ``` 在上述代码中,自定义了一个 `CustomGatewayFilterFactory`,它继承自 `AbstractGatewayFilterFactory`,并实现了相关方法。在 `apply` 方法中对请求进行修改,添加了自定义请求头。 ### 自定义过滤器使用方法 自定义过滤器实现后,可在 `application.yml` 配置文件中使用,配置示例如下: ```yaml spring: cloud: gateway: routes: - id: user-center-service uri: http://localhost:8080/api/user/list predicates: - Path=/user/list filters: - Custom=true # 开启自定义过滤器 ``` 上述配置中,`Custom=true` 启用了自定义的 `CustomGatewayFilterFactory` 过滤器
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值