Spring Cloud Gateway自定义路由断言工厂

迈不过友情╰ 2023-02-26 04:21 22阅读 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%A818-Spring-Cloud-Gateway%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%AF%E7%94%B1%E6%96%AD%E8%A8%80%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_A818-Spring-Cloud-Gateway_E8_87_AA_E5_AE_9A_E4_B9_89_E8_B7_AF_E7_94_B1_E6_96_AD_E8_A8_80_E5_B7_A5_E5_8E_82.html]

自定义路由断言工厂需要继承 AbstractRoutePredicateFactory 类，重写 apply 方法的逻辑和shortcutFieldOrder方法。

在 apply 方法中可以通过 exchange.getRequest() 拿到 ServerHttpRequest 对象，从而可以获取到请求的参数、请求方式、请求头等信息。

apply 方法的参数是自定义的配置类，在使用的时候配置参数，在 apply 方法中直接获取使用。

命名需要以 RoutePredicateFactory 结尾，比如 CheckAuthRoutePredicateFactory，那么在使用的时候 CheckAuth 就是这个路由断言工厂的名称。代码如下所示。

@Slf4j
    @Component
    public class CheckAuthRoutePredicateFactory extends AbstractRoutePredicateFactory<CheckAuthRoutePredicateFactory.Config> {
    
    
        public CheckAuthRoutePredicateFactory() {
            super(Config.class);
            log.info("Loaded RoutePredicateFactory [CheckAuth]");
        }
    
        @Override
        public List<String> shortcutFieldOrder() {
            return Arrays.asList("name");
        }
    
    
        @Override
        public Predicate<ServerWebExchange> apply(Config config) {
    
            return exchange -> {
                if (config.getName().equals("zhangsan")) {
                    return true;
                }
                return false;
            };
        }
    
    
        public static class Config {
    
            private String name;
    
            public void setName(String name) {
                this.name = name;
            }
    
            public String getName() {
                return name;
            }
        }
    
    }

在application.yml中添加路由配置，如下：

spring:
      cloud:
        gateway:
          routes:
          - id: customer_route
            predicates:
            - CheckAuth=zhangsan
            uri: http://51ufo.cn

本文代码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_A818-Spring-Cloud-Gateway_E8_87_AA_E5_AE_9A_E4_B9_89_E8_B7_AF_E7_94_B1_E6_96_AD_E8_A8_80_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%A818-Spring-Cloud-Gateway%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%AF%E7%94%B1%E6%96%AD%E8%A8%80%E5%B7%A5%E5%8E%82.html
[https_gitee.com_xmingtx_springcloud-lesson.git]: https://gitee.com/xmingtx/springcloud-lesson.git