自定义Spring Cloud Gateway过滤器工厂

一时失言乱红尘 2023-02-26 04:21 1阅读 0赞

## SpringCloud视频教程： ##

[https://ke.qq.com/course/2805647?tuin=a3e3fb1&from\_uin=171851697&from=1000201007][https_ke.qq.com_course_2805647_tuin_a3e3fb1_from_uin_171851697_from_1000201007]

## 个人博客纯净版 ##

[http://www.51ufo.cn/%E5%BE%AE%E6%9C%8D%E5%8A%A1/%E5%88%86%E5%B8%83%E5%BC%8F/2020/07/11/SpringCloud%E5%85%A5%E9%97%A820-%E8%87%AA%E5%AE%9A%E4%B9%89Spring-Cloud-Gateway%E8%BF%87%E6%BB%A4%E5%99%A8%E5%B7%A5%E5%8E%82.html][http_www.51ufo.cn_E5_BE_AE_E6_9C_8D_E5_8A_A1_E5_88_86_E5_B8_83_E5_BC_8F_2020_07_11_SpringCloud_E5_85_A5_E9_97_A820-_E8_87_AA_E5_AE_9A_E4_B9_89Spring-Cloud-Gateway_E8_BF_87_E6_BB_A4_E5_99_A8_E5_B7_A5_E5_8E_82.html]

自定义 Spring Cloud Gateway 过滤器工厂需要继承 AbstractGatewayFilterFactory 类，重写 apply 方法的逻辑。命名需要以 GatewayFilterFactory 结尾，比如 AccessAuthGatewayFilterFactory，那么在使用的时候 AccessAuth就是这个过滤器工厂的名称。

自定义过滤器工厂代码如下所示。

@Slf4j
    @Component
    public class AccessAuthGatewayFilterFactory extends AbstractGatewayFilterFactory<AccessAuthGatewayFilterFactory.Config> {
    
        public static final String WARNING_MSG = "访问未授权";
    
        public AccessAuthGatewayFilterFactory(){
            super(AccessAuthGatewayFilterFactory.Config.class);
            log.info("Loaded GatewayFilterFactory [AccessAuth]");
        }
    @Override
    public List<String> shortcutFieldOrder() {
    return Arrays.asList("name");
    } 
    
        @Override
        public GatewayFilter apply(Config config) {
    
            return (exchange, chain) -> {
                ServerHttpRequest request = exchange.getRequest();
                ServerHttpResponse response = exchange.getResponse();
                if(config.name.equals("zhangsan")) {
                    return chain.filter(exchange.mutate().request(request).build());
                } else {
    
                    byte[] bits = WARNING_MSG.getBytes(StandardCharsets.UTF_8);
                    DataBuffer buffer = response.bufferFactory().wrap(bits);
                    //指定编码，否则在浏览器中会中文乱码
                    response.getHeaders().add("Content-Type", "text/plain;charset=UTF-8");
                    return response.writeWith(Mono.just(buffer));
                }
            };
    
        }
    
        public static class Config {
    
            private String name;
    
            public void setName(String name) {
                this.name = name;
            }
    
            public String getName() {
                return name;
            }
        }
    }

修改service-gateway服务application.yml配置文件的路由配置，如下：

spring:
      cloud:
        gateway:
          routes:
          - id: hello
            predicates:   #断言
            - Path=/hello
            uri: http://localhost:8080  #目标服务地址
            filters:
            - AccessAuth=lisi

启动服务，在浏览器访问在浏览器访问[http://localhost/hello?name=xiaoming][http_localhost_hello_name_xiaoming],返回如下：

访问未授权

若将service-gateway服务application.yml配置文件的路由配置修改，如下：

spring:
      cloud:
        gateway:
          routes:
          - id: hello
            predicates:   #断言
            - Path=/hello
            uri: http://localhost:8080  #目标服务地址
            filters:
            - AccessAuth=zhangsan

重新启动服务，从浏览器再次访问[http://localhost/hello?name=xiaoming][http_localhost_hello_name_xiaoming]，返回如下：

hello, xiaoming, 我是服务提供者:端口为：8080

本文代码git地址 [https://gitee.com/xmingtx/springcloud-lesson.git][https_gitee.com_xmingtx_springcloud-lesson.git]

[https_ke.qq.com_course_2805647_tuin_a3e3fb1_from_uin_171851697_from_1000201007]: https://ke.qq.com/course/2805647?tuin=a3e3fb1&from_uin=171851697&from=1000201007
[http_www.51ufo.cn_E5_BE_AE_E6_9C_8D_E5_8A_A1_E5_88_86_E5_B8_83_E5_BC_8F_2020_07_11_SpringCloud_E5_85_A5_E9_97_A820-_E8_87_AA_E5_AE_9A_E4_B9_89Spring-Cloud-Gateway_E8_BF_87_E6_BB_A4_E5_99_A8_E5_B7_A5_E5_8E_82.html]: http://www.51ufo.cn/%E5%BE%AE%E6%9C%8D%E5%8A%A1/%E5%88%86%E5%B8%83%E5%BC%8F/2020/07/11/SpringCloud%E5%85%A5%E9%97%A820-%E8%87%AA%E5%AE%9A%E4%B9%89Spring-Cloud-Gateway%E8%BF%87%E6%BB%A4%E5%99%A8%E5%B7%A5%E5%8E%82.html
[http_localhost_hello_name_xiaoming]: http://localhost/hello?name=xiaoming
[https_gitee.com_xmingtx_springcloud-lesson.git]: https://gitee.com/xmingtx/springcloud-lesson.git