Gateway网关（二）路由、 断言、 过滤和实战+源码

Gateway网关（二）路由、 断言、 过滤 +实战（源码）

前言

今天给大家讲解一下Gateway三大核心：Route(路由)、Predicate(断言)和Filter(过滤)，然后给大家演示代码实操。

Route(路由)：路由是构建网关的基本模块，它由ID，目标URL，一系列的断言和过滤器组成，如断言为true则匹配路由。

Predicate(断言)：断言是JDK8的新特性，可以参考java.util.function.Predicate。断言是编程术语，表示为一些布尔表达式，程序员相信在程序中的某个特定点该表达式值为真，可以在任何时候启用和禁用断言验证，因此可以在测试时启用断言而在部署时禁用断言。同样，程序投入运行后，最终用户在遇到问题时可以重新启用断言。开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由。

Filter(过滤)：指的是Spring框架中GatewayFilter的实例，使用过滤器，可以在请求被路由前或之后对请求进行修改。

以下这张图来源于网络：

web请求，通过一些匹配条件，定位到真正的服务节点，并在这个转发过程的前后，进行精细化的控制。Predicate就是我们匹配的条件，而Filter，可以理解为一个无所不能的拦截器，再加上目标URI，就可以实现一个具体的路由了。

Predicate

Route Predicate Factories：

1. Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。
2. Spring Cloud Gateway包括许多内置的Route PredicateIJ 。所有这些Predicate都 与HTTP请求的不同属性匹配。多个Route PredicateI厂可以进行组合
3. Spring Cloud Gateway创建Route对象时，使用RoutePredicateFactory创建Predicate对象，Predicate 对象可以赋值给Route。Spring Cloud Gateway包含许多内置的Route Predicate Factories.
4. 所有这些谓词都匹配HTTP请求的不同属性。多种谓词工厂可以组合，并通过逻辑and.

具体了解可以阅读官网：https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/3.0.0.M1/reference/html/#gateway-request-predicates-factories

Gateway实战

首先说一下，写到这里的时候，发现网上已经有很多类似的文章了，其实都出自于同一个老师，他们给的代码都很凌乱，平常人根本就运行不了，看了也是白看，起不来任何作用，西柚仔在讲解之后，也附上源码，可以说是很良心了，为了大家都能拿到源码都能运行，项目里会放上sql文件和在README.md说明需要改动的地方，确保大家学完之后也能运行实操，不浮躁不随波逐流，做个有良心的博主。

实战前提，项目已经有了一下几个模块：

红色为已有模块，绿色为准备带大家实操的模块。

cloud-gateway-gateway9527文件结构：

初步实操步骤：

• 新建模块：cloud-gateway-gateway9527
• 加入pom.xml中加入依赖坐标

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

第一个依赖是gateway所需要的，第二个是连接eureka注册中心所需要的，第三个是糊涂工具包，平时都会带上，用作一些常规操作，官网：https://www.hutool.cn/

• 新建application.yml文件

担心代码块的注释会扰乱结构，灰色为注释内容，附上一张原版图

server:
  port: 9527
spring:
  application:
    name: cloud-gateway-service
  cloud:
    gateway:
      routes:
        - id: payment_routh   #定义这个路由的ID（只要唯一存在就可以）
#          uri: http://localhost:8001 #如果只有一个提供者，便可这样写（提供者的IP地址+端口号）
          uri: lb://cloud-payment-service #这是负载均衡的写法，lb是开启负载均衡功能，会按照这个微服务名称取找多个微服务，默认的是轮询规则
          predicates:
            - Path=/payment/get/**  #这个是配置请求地址，**表示路径下的所有请求
        - id: payment_routh2
#          uri: http://localhost:8001
          uri: lb://cloud-payment-service
          predicates:
            - Path=/payment/lb/**
      discovery:
        locator:
          enabled: true  #开启从注册中心动态生成路由的功能，用微服务名进行路由

eureka:
  instance:
    hostname: cloud_gateway_service #这个是注册中心微服务名称，告知在哪个注册中心注册，
  client:
    service-url:
      defaultZone: http://www.eureka7001.com:7001/eureka/ #告知注册中心的地址，eureka7001.com是我在window系统中自行配置的虚拟路径，你们把他改成localhost即可
    register-with-eureka: true  #设置开启在注册中心注册
    fetch-registry: true  #设置去注册中心获取其他服务的地址

• 新建GateWayMain9527主启动类

@SpringBootApplication  //这个是开启springboot
@EnableEurekaClient   //开启eureka注册
public class GateWayMain9527 {
    public static void main(String[] args) {
        SpringApplication.run(GateWayMain9527.class,args);
    }
}

配置完这里，已经是可以访问刚刚在application.yml配置的请求路径了，首先开启微服务，同时启动下图这几个微服务

在application.yml配置了9527端口访问http://localhost:9527/payment/get/31和http://localhost:9527/payment/load/balanced两个请求，这两个请求的服务都来自于Payment8001微服务提供者，详细的可以到下面码云链接下载源码查看理解。

访问http://localhost:9527/payment/get/31后出现字符串，说明部署已经成功。

我们再去访问http://localhost:9527/payment/load/balanced

第一次访问是8001

第二次访问是8002

原因：我们在cloud-provider-payment8001和cloud-provider-payment8002两个微服务提供者都部署了相同的业务代码，然后在gateway中配置了负载均衡，所以会轮询规则去访问两个微服务。

以上就是基本的gateway配置步骤了，这是配置方式之一：在配置文件yml中配置，以下为大家演示第二种配置方式：代码中注入RouteLocator的Bean。

• 在包下新建一个GateWayConfig类

@Configuration  //不要忘了这个注解
public class GateWayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {

        //从RouteLocatorBuilder中获取路由，准备下面的配置
        RouteLocatorBuilder.Builder routes = builder.routes();
		//这里其实是一个Lambda 表达式表达式，第一个参数是给这个路由起一个唯一的ID名，第二个是配置这个域名下访问的路径，第二个是配置需要跳转到哪个地址
        routes.route("path_route",r->r.path("/guonei").uri("https://www.baidu.com/"));
		//开始构建
        return routes.build();
    }
}

这时候我们重启以下微服务GatewayMain9527，然后访问http://localhost:9527/my/qq即可实现跳转（注意：很多网站都设置了防火墙，所以不让你随便跳转，这里只做演示）

接下来演示Filter的功能，新建一个MyGateWayFilter类实现GlobalFilter和Ordered两个接口

@Component
public class MyGateWayFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("**************come in MylogGateWayGilter:  " + new Date());
        //从请求中获取uname
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        //判断是否为空
        if (uname == null) {
            System.out.println("********用户名为空，非法用户。");
            //为空时，设置状态码，告知没有权限
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            //拒绝访问
            return exchange.getResponse().setComplete();
        }
        //同意访问
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

这时候我们重启以下微服务GatewayMain9527，然后访问http://localhost:9527/payment/get/31，是无法访问的

当我们带上uname参数时，就可以访问了，所以Filter可以帮助我们完成很多业务需求，只要按照需求自定义规则。

结尾

大家学到这里也就累了，在本篇文章中就不继续往下写了，下一章会为大家详细讲解以下Predicate和Filter，如果有兴趣可以持续关注西柚仔，以下附上码云源码地址（为确保运行成功，请先阅读项目中的README.md，mysql文件放在项目里）：https://gitee.com/oreo_team/Cloud2020-Gateway

谢谢大家支持！