关于
山间木匠

【Spring Cloud 微服务教程】 spring cloud Gateway 路由断言工厂

2020/05/12

Gateway 路由断言工厂

概述

Spring cloud gateway是spring官方基于Spring 5.0、Spring Boot2.0和Project Reactor等技术开发的网关，Spring Cloud Gateway旨在为微服务架构提供简单、有效和统一的API路由管理方式，Spring Cloud Gateway作为Spring Cloud生态系统中的网关，目标是替代Netflix Zuul，其不仅提供统一的路由方式，并且还基于Filer链的方式提供了网关基本的功能，例如：安全、监控/埋点、限流等。

Spring Cloud Gateway 依赖 Spring Boot 和 Spring WebFlux，基于 Netty 运行。它不能在传统的 servlet 容器中工作，也不能构建成 war 包。

核心概念

网关提供 API 全托管服务，丰富的API管理功能，辅助企业管理大规模的API，以降低管理成本和安全风险，包括协议适配、协议转发、安全策略、防刷、流量、监控日志等贡呢。一般来说网关对外暴露的URL或者接口信息，我们统称为路由信息。如果研发过网关中间件或者使用过Zuul的人，会知道网关的核心是Filter以及Filter Chain（Filter责任链）。Sprig Cloud Gateway也具有路由和Filter的概念。下面介绍一下Spring Cloud Gateway中几个重要的概念。

  • 路由（Route）：路由是网关最基础的部分，路由信息有一个ID、一个目的URL、一组断言和一组Filter组成。如果断言路由为真，则说明请求的URL和配置匹配
  • 断言（Predicate），Java8中的断言函数。Spring Cloud Gateway中的断言函数输入类型是Spring5.0框架中的ServerWebExchange。Spring Cloud Gateway中的断言函数允许开发者去定义匹配来自于http request中的任何信息，比如请求头和参数等。
  • 过滤器(Filter):一个标准的Spring webFilter。Spring cloud gateway中的filter分为两种类型的Filter，分别是Gateway Filter和Global Filter。过滤器Filter将会对请求和响应进行修改处理。

工作原理图

img

Gateway 的客户端会向 Spring Cloud Gateway 发起请求，请求首先会被 HtpWebHandlerAdapter 进行提取组装成网关的上下文，然后网关的上下文会传递到DispatcherHandler. DispatcherHandler 是所有请求的分发处理器，DispatcherHandler主要负责分发请求对应的处理器，比如将请求分发到对应RoutePredicate- HandlerMapping (路由断言处理映射器)。路由断言处理映射器主要用于路由的查找，以及找到路由后返回对应的FilteringWebHandler。FilteringWebHandler 主要负责组装Filter链表并调用 Filter 执行- - 系列的Filter处理，然后把请求转到后端对应的代理服务处理，处理完毕之后，将 Response 返回到Gateway客户端。

服务端

1、创建应用

创建一个命名为： gateway-cloud-server-example 的 Spring cloud 应用，作为gateway 请求的服务端测试。

2、添加依赖

    <properties>
        <java.version>1.8</java.version>
        <spring.cloud.alibaba.version>2.1.2.RELEASE</spring.cloud.alibaba.version>
        <spring.cloud.version>Greenwich.RELEASE</spring.cloud.version>
    </properties>   
	<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>

    <dependencyManagement>

        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring.cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring.cloud.alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

        </dependencies>
    </dependencyManagement>

3、增加配置

在 application.yml 中配置 的地址：

server:
  port: 8090
spring:
  application:
    name: gateway-server
  cloud:
    # nacos 服务端地址
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

4、加注解

在启动类上加入注解@EnableDiscoveryClient。

5、控制类

@RestController
@RequestMapping("/route")
public class RouteTestController {

    @GetMapping(value = "")
    public String hello() {
        return "8090:hello";
    }

    @GetMapping(value = "/sayHello/{name}")
    public String sayHello(@PathVariable String name) {
        return "8090:sayHello:"+name;
    }

}

客户端

1、创建应用

创建一个命名为： gateway-cloud-client-route-example 的 Spring cloud 应用，作为 gateway 路由相关测试。

2、添加依赖

    <properties>
        <java.version>1.8</java.version>
        <spring.cloud.alibaba.version>2.1.2.RELEASE</spring.cloud.alibaba.version>
        <spring.cloud.version>Greenwich.RELEASE</spring.cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- gateway -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!-- nacos -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>
 	<dependencyManagement>

        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring.cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring.cloud.alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

        </dependencies>
    </dependencyManagement>

3、增加配置

在 application.yml 中配置 的地址：

server:
  port: 8091
spring:
  application:
    name: gateway-route
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      routes:
        - id: path_route
          uri: http://localhost:8090
          predicates:
            - Path=/route
  • gateway 配置解释：
    • id: 路由名称，标识，唯一
    • uri：转发的目标地址
    • predicates: 路由规则
    • Path: 路径

gateway 配置文件等同于如下代码配置：

    @Bean
    public RouteLocator routeLocator(RouteLocatorBuilder routeLocatorBuilder){
        // 1 、简单路由
        return routeLocatorBuilder.routes()
                .route(r-> r.path("/route")
                        .uri("http://localhost:8090")
                        .id("path_route"))
                .build();
    }

4、加注解

在启动类上加入注解@EnableDiscoveryClient。

5、测试

分别启动服务端（8090）和客户端(8091)，客户端请求地址 http://localhost:8091/route，会转发到 http://localhost:8091/route。

6 、服务地址转发

server:
  port: 8091
spring:
  application:
    name: gateway-route
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      routes:
        # 通过IP 地址转发
        - id: path_route
          uri: http://localhost:8090
          predicates:
            - Path=/route
        #  通过服务地址
        - id: path_route_lb
          uri: lb://gateway-server
          predicates:
            - Path=/route/**
  • lb://gateway-server: gateway-server注册在 nacos 的服务名称，通过服务名称转发。
  • /route/**: /**表示多级路径(path)，如:route/say,route\hi\q 等。

谓词工厂

1、Before 路由断言工厂

Before 路由断言，请求的在当前时间（UTC）之前路由通过匹配，之后不能成功通过匹配。

        - id: path_route_before
          uri: http://blog.lixc.top/
          predicates:
            - Before=2020-05-10T14:45:39.145+08:00[Asia/Shanghai]

代码实现如下：

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {	
        ZonedDateTime datetime = LocalDateTime.now().plusDays(1).atZone(ZoneId.systemDefault());
        return builder.routes()
                .route("path_route_before", r -> r.before(datetime)
                        .uri("http://blog.lixc.top"))
                .build();
    }

2、After 路由断言工厂

After 路由断言，请求的在当前时间（UTC）之后路由通过匹配，之后不能成功通过匹配。

        # After 路由断言
        - id: path_route_after
          uri: http://blog.lixc.top/
          predicates:
            - After=2020-05-01T14:45:39.145+08:00[Asia/Shanghai]

3、Between路由断言工厂

Between，请求的在当前时间（UTC）在两者之间路由通过匹配，之后不能成功通过匹配。

        # path_route_between 路由断言
        - id: path_route_between
          uri: http://blog.lixc.top/
          predicates:
            - Between=2020-05-01T14:45:39.145+08:00[Asia/Shanghai],2020-05-10T14:45:39.145+08:00[Asia/Shanghai]

4、Cookie 路由断言工厂

Cookie 当请求有cokkie名称和对应的值，匹配成功转发微服务。

       # cookie_route 路由断言
       - id: cookie_route
          uri: lb://gateway-server
          predicates:
            # 当且仅当带有名为somecookie，并且值符合正则ch.p的Cookie时，才会转发到用户微服务
            - Cookie=somecookie, ch.p

5、Header 路由断言工厂

# header_route
- id: header_route
  uri: https://example.org
  predicates:
     #  当且仅当带有名为X-Request-Id，并且值符合正则\d+的Header时，匹配成功转发微服务
    - Header=X-Request-Id, \d+

6、host 路由断言工厂

# host_route
- id: host_route
  uri: https://blog.lixc.top
  predicates:
    # 当且仅当名为Host的Header符合**.somehost.org或**.anotherhost.org时，匹配成功转发微服务
    - Host=**.somehost.org,**.anotherhost.org

7、Method 路由断言工厂

        # method_route
        - id: method_route
          uri: https://blog.lixc.top
          # 当且仅当HTTP请求方法是GET POST 时，才会转发用户微服务
          predicates:
            - Method=GET,POST

8、path 路由断言工厂

# path
- id: path_route
  uri: http://localhost:8090
  predicates:
 #  当且仅当访问路径是/route/**，才会转发用户微服务
    - Path=/route/**

文章参考

  • https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway

代码示例

本文示例代码访问下面查看仓库：

其中，本文示例代码名称：

  • gateway-cloud-server-example：gateway 服务端
  • gateway-cloud-client-route-example : Gateway 路由断言工厂


微信扫描二维码，关注一个有故事的程序员

（转载本站文章请注明作者和出处 山间木匠-mtcarpenter）

Post Directory

扫码关注公众号：山间木匠
发送 290992
即可立即永久解锁本站全部文章