SpringCloud系列教程（八）：服务网关Gateway

上一节演示了SpringCloud的网关服务，从application.yml里我们可以看到gateway的主要配置有id，uri和predicates，其中predicates的配置提供了我们一些网关逻辑，可以帮助我们进行路由规则的匹配，如果匹配不上一般就会出现404，这时候我们就要仔细检查配置是否出现了错误，所以称之为路由断言，断言就是匹配不上就报错。路由断言是通过各个断言工厂实现的，因此在SpringCloud的源码里我们能发现很多的断言工厂类，所以我猜SpringCloud很可能使用了设计模式里的抽象工厂模式。具体配置我们就看官方文档，不同版本也不完全一致，根据自己的需要查找对应版本的文档。我现在用的是这个版本地址：Spring Cloud Gateway

另外我们还缺少一个很重要的配置就是路由过滤器filter，它是用来对网关获取到的http请求做一些操作的，比如判断请求时间，判断请求路径等。同样过滤器也是通过多个过滤器工厂类实现的，官方文档地址：Spring Cloud Gateway

我们加一个filter，比如给nacos-client-demo的请求中加入请求头，并且在接口中获取到。

1、gateway-demo中修改application.yml文件，添加filter。

spring:
  main:
    # gateway组件中的spring-boot-starter-webflux和springboot作为web项目启动必不可少的spring-boot-starter-web出现冲突
    web-application-type: reactive
  application:
    name: gateway-demo
  cloud:
    nacos:
      server-addr: 192.168.3.54:80
      username: nacos
      password: nacos
      discovery:
        group: devops
        namespace: sit
      config:
        namespace: sit
        group: devops
    gateway:
      routes:
        - id: nacos-client-demo #指定服务名
          uri: lb://nacos-client-demo #去注册中心找这个服务名
          predicates: #断言，匹配访问的路径
            - Path=/nacos-client-demo/api/**    #服务访问路径
          filters: # 过滤器
            - AddRequestHeader=headername, I am a header! # 添加请求头
  config:
    import: nacos:${spring.application.name}?refresh=true
server:
  port: 8888

2、修改nacos-client-demo中的call接口，加入header参数。

    @RequestMapping(value = "/call", method = RequestMethod.GET)
    public String call(@RequestHeader String headername) {
        return "I am here!";
    }

3、重启并debug一下，观察是否把header从网关传递给了服务。

这样就成功验证了filter的作用，官方提供给了我们很多的过滤器，能满足绝大多数功能，不过还是经常会让我去自己完成过滤器的逻辑，所以我们要能做自己的过滤器。SpringCloud提供给我们两种过滤器，一种是全局过滤器GlobalFilter，声明之后自动生效，作用于全局；另一种是GatewayFilter，只能配置到具体路由上才会生效。

1、我们先做一个全局过滤器，创建新对象MyGlobalFilter，继承两个interface分别是GlobalFilter和Ordered。

package com.mj.gateway.filter;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //通过exchange就能获取到web请求
        String path = exchange.getRequest().getURI().getPath();
        System.out.println("MyGlobalFilter: "+path);
        //放到下一个filter中
        return chain.filter(exchange);
    }

    //继承Ordered类，用于排序，返回order值越小优先级越高
    @Override
    public int getOrder() {
        return 0;
    }
}

继承GlobalFilter这个接口就会重写一下它的filter方法，这个方法有两个参数，第一个参数就是http调用对象，从里面我们可以获取到所有的http信息，用来进行我们的逻辑判断，第二个参数是filter链，表示当前filter只是gateway中所有filter链路的一个节点而已，当我们写完逻辑后，要把当前filter扔回链路中，否则请求就中断了。

继承Ordered接口之后重写方法getOrder，表示让当前filter在所有filter链路中排第几个，返回值就是顺序，越小就越靠前，0就表示它是第一个filter。

2、启动后，调用任何一个接口，都会触发到全局连接器。

3、然后再去实现一下GatewayFilter，但是与全局构造器不同，对于GatewayFilter需要去实现的是一个工厂类，所以两种filter是不一样的，我们来创建一个新的类MyGatewayFilter。

package com.mj.gateway.filter;

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.OrderedGatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class MyGatewayFilterFactory extends AbstractGatewayFilterFactory<Object> {
    @Override
    public GatewayFilter apply(Object config) {
        return new OrderedGatewayFilter(new GatewayFilter() {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                //通过exchange就能获取到web请求
                String path = exchange.getRequest().getURI().getPath();
                System.out.println("MyGatewayFilter: "+path);
                //放到下一个filter中
                return chain.filter(exchange);
            }
        },1);
    }
}

在apply方法中返回一个OrderedGatewayFilter对象，这个对象接受一个GatewayFilter对象，然后给其排序，GatewayFilter里就简单了，和上面的全局filter一样，这里顺序设置成1，让它在全局filter之后执行。

4、由于GatewayFilter需要配置到具体路由规则里之后才会生效，所以我们要在application.yml里配置一下，这里要特别注意，我们的类名是MyGatewayFilterFactory，配置的时候Filter的名字就是My，好神奇的规则。。。。

spring:
  main:
    # gateway组件中的spring-boot-starter-webflux和springboot作为web项目启动必不可少的spring-boot-starter-web出现冲突
    web-application-type: reactive
  application:
    name: gateway-demo
  cloud:
    nacos:
      server-addr: 192.168.3.54:80
      username: nacos
      password: nacos
      discovery:
        group: devops
        namespace: sit
      config:
        namespace: sit
        group: devops
    gateway:
      routes:
        - id: nacos-client-demo #指定服务名
          uri: lb://nacos-client-demo #去注册中心找这个服务名
          predicates: #断言，匹配访问的路径
            - Path=/nacos-client-demo/api/**    #服务访问路径
          filters: # 过滤器
            - AddRequestHeader=headername, I am a header! # 添加请求头
            - My
  config:
    import: nacos:${spring.application.name}?refresh=true
server:
  port: 8888

5、最后测试一下call方法，并且看看两个Filter的执行顺序。

虽然两个Filter我们都实现了功能，但是呢，我们肯定发现怎么跟官方的配置不太一样呢？官方的上面带着参数，还用逗号隔开，而我们这个就孤零零的两个字母My（当然如果你在项目上一定会起一个好名字），所以我们还要加一下配置参数才行。

6、修改一下MyGatewayFilterFactory类，在里面加一个内部类Config，用来接收我们application.yml中的配置。

同时，给MyGatewayFilterFactory添加构造器，把内部类Config加到构造器中，这样就完成了MyGatewayFilterFactory和Config的融合。

配置参数可能会是多个，并且用逗号隔开，所以我们还要固定配置参数和Config中变量的关系，官方已经给我预留了一个方法叫shortcutFieldOrder，我们重写一下这个方法，把对应关系的逻辑加进去。

package com.mj.gateway.filter;

import lombok.Data;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.OrderedGatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.List;

@Component
public class MyGatewayFilterFactory extends AbstractGatewayFilterFactory<MyGatewayFilterFactory.Config> {
    @Override
    public GatewayFilter apply(Config config) {
        return new OrderedGatewayFilter(new GatewayFilter() {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                //通过exchange就能获取到web请求
                String path = exchange.getRequest().getURI().getPath();
                System.out.println("MyGatewayFilter: "+path);

                // 读取config信息
                System.out.println(config.toString());

                //放到下一个filter中
                return chain.filter(exchange);
            }
        },1);
    }

    //定义Config类，用来接收配置参数
    @Data
    public static class Config{
        private String a;
        private String b;
        private String c;

        @Override
        public String toString(){
            return getA()+"-"+getB()+"-"+getC();
        }
    }

    // 把Config类传入到拦截器类的构造器中，这样才能把配置参数转成Config对象，注意这时候泛型也要改成Config类
    public MyGatewayFilterFactory(){
        super(Config.class);
    }

    //规范配置参数和Config类中参数的对应顺序
    @Override
    public List<String> shortcutFieldOrder() {
        return List.of("a","b","c");
    }
}

7、修改application.yml，添加三个参数。

spring:
  main:
    # gateway组件中的spring-boot-starter-webflux和springboot作为web项目启动必不可少的spring-boot-starter-web出现冲突
    web-application-type: reactive
  application:
    name: gateway-demo
  cloud:
    nacos:
      server-addr: 192.168.3.54:80
      username: nacos
      password: nacos
      discovery:
        group: devops
        namespace: sit
      config:
        namespace: sit
        group: devops
    gateway:
      routes:
        - id: nacos-client-demo #指定服务名
          uri: lb://nacos-client-demo #去注册中心找这个服务名
          predicates: #断言，匹配访问的路径
            - Path=/nacos-client-demo/api/**    #服务访问路径
          filters: # 过滤器
            - AddRequestHeader=headername, I am a header! # 添加请求头
            - My=zhangsan,lisi,wangwu
  config:
    import: nacos:${spring.application.name}?refresh=true
server:
  port: 8888

8、重启网关服务，查看一下配置参数是否正确获取。