ITPub博客

首页 > 架构设计 > 软件结构 > (41)java Spring Cloud企业快速开发架构之SpringCloud-Gateway的常用路由断言工厂

(41)java Spring Cloud企业快速开发架构之SpringCloud-Gateway的常用路由断言工厂

原创 软件结构 作者:JIAN2 时间:2021-09-26 11:22:28 0 删除 编辑

SpringCloud Gateway 内置了许多路由断言工厂,可以通过配置的方式直接使用,也可以组合使用多个路由断言工厂。接下来为大家介绍几个常用的路由断言工厂类。

需要框架源码的朋友可以看我个人简介联系我。


 1)Path 路由断言工厂
Path 路由断言工厂接收一个参数,根据 Path 定义好的规则来判断访问的 URI 是否匹配。

spring:  cloud:    gateway:      routes:        - id: host_route    uri: http://minglisoft.cn    predicates:      - Path=/blog/detail/{segment}

如果请求路径为 /blog/detail/xxx,则此路由将匹配。也可以使用正则,例如 /blog/detail/** 来匹配 /blog/detail/ 开头的多级 URI。

我们访问本地的网关: http://localhost:2001/blog/detail/36185 ,可以看到显示的是  http://minglisoft.cn/blog/det... 对应的内容。

2)Query 路由断言工厂
Query 路由断言工厂接收两个参数,一个必需的参数和一个可选的正则表达式。

spring:  cloud:    gateway:      routes:        - id: query_route      uri: http://minglisoft.cn      predicates:        - Query=foo, ba.

如果请求包含一个值与 ba 匹配的 foo 查询参数,则此路由将匹配。bar 和 baz 也会匹配,因为第二个参数是正则表达式。

测试链接: http://localhost:2001/?foo=baz。

3)Method 路由断言工厂
Method 路由断言工厂接收一个参数,即要匹配的 HTTP 方法。

spring:
  cloud:
    gateway:
      routes:
        - id: method_route
  uri: http://baidu.com  predicates:
    - Method=GET

4)Header 路由断言工厂
Header 路由断言工厂接收两个参数,分别是请求头名称和正则表达式。

spring:  cloud:    gateway:      routes:        - id: header_route  uri: http://example.org  predicates:    - Header=X-Request-Id, \d+

如果请求中带有请求头名为 x-request-id,其值与 \d+ 正则表达式匹配(值为一个或多个数字),则此路由匹配。

如果你想学习更多路由断言工厂的用法,可以参考官方文档进行学习。

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

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

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

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

@Componentpublic class CheckAuthRoutePredicateFactory        extends AbstractRoutePredicateFactory<CheckAuthRoutePredicateFactory.Config> {
    public CheckAuthRoutePredicateFactory() {
        super(Config.class);
    }
  @Override    public Predicate<ServerWebExchange> apply(Config config) {
        return exchange -> {
            System.err.println("进入了CheckAuthRoutePredicateFactory\t" + config.getName());
            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;
        }
    }
}

使用示例如下所示:

spring:  cloud:    gateway:      routes:  - id: customer_route  uri: http://minglisoft.cn  predicates:    - name: CheckAuth  args:    name: zhangsan


来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/70006413/viewspace-2793751/ ,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论
华为资深架构师,曾参与华为数据中心迁移解决方案!有需要了解分布式微服务电商源码的朋友可以+我 v ❤: haiwabbc2 , 10余年互联网研发行业经验!博客里面是个人的一点技术总结,希望能够帮助到更多的IT朋友成长!

注册时间:2021-09-06

  • 博文量
    1404
  • 访问量
    622763