服务网关——Gateway

前言

之前的一篇文章中，讲解的zuul网关的使用-服务网管-zuul，但是zuul1.0由于其阻塞式IO模型和没有长连接等缺陷，已经被淘汰，而zuul2.0虽然完善了这些缺点，但是目前并没有研发出来，在这期间spring cloud吸收的Netflix的思想，自己内部研发出了一款新的网管集成到spring cloud框架中使用，也就是本篇文章要讲的Gateway。

介绍

Gateway的特性

Gateway与zuul的区别

Gateway的 三大概念与工作流程

1、Route（路由）

路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如断言为true则匹配该路由到相关的微服务模块。

2、Predicate（断言）

开发人员对请求的HTTP的所有内容进行内容匹配，如果请求与断言相匹配成功则可以进行路由。

3、Filter（过滤）

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

工作流程

路由转发与执行过滤器链

实例

1、引入依赖

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
<!--        &lt;!&ndash;web启动器&ndash;&gt;-->
<!--        <dependency>-->
<!--            <groupId>org.springframework.boot</groupId>-->
<!--            <artifactId>spring-boot-starter-web</artifactId>-->
<!--        </dependency>-->
<!--        &lt;!&ndash;监控&ndash;&gt;-->
<!--        <dependency>-->
<!--            <groupId>org.springframework.boot</groupId>-->
<!--            <artifactId>spring-boot-starter-actuator</artifactId>-->
<!--        </dependency>-->
        <!--eureka client-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>com.zhyheima.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <!--热部署-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.18</version>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

注意：Gateway是基于webflux的，与spring mvc的web不兼容，所以不需要引入spring-boot-start-web依赖，否则会报错：
org.springframework.cloud.gateway.config.GatewayAutoConfiguration required a bean of type ‘org.springframework.http.codec.ServerCodecConfigurer’ that could not be found

如果非要web支持的话，需要引入spring-boot-starter-webflux而不是spring-boot-start-web。

2、yml配置

server:
  port: 9527

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true # 开启从注册中心动态创建路由的功能，利用微服务名称进行路由
      routes:
        - id: payment_route # 路由的id,没有规定规则但要求唯一,建议配合服务名
          #匹配后提供服务的路由地址
          uri: http://localhost:8002
          predicates:
            - Path=/payment/get/** # 断言，路径相匹配的进行路由
eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka
  instance:
    hostname: cloud-gateway-service

3、启动类

@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9527 {
    public static void main(String[] args) {
        SpringApplication.run(GateWayMain9527.class,args);
    }
}

启动服务提供者服务模块，进行测试
原来单纯访问服务提供者模块路径：http://localhost:8002/payment/get/1

使用网关后，我们在封装了原来路径的主机和端口号，使用了网关的主机和端口号：http://localhost:9527/payment/get/1

但是这并不是我们想要的，因为项目中使用了eureka注册中心，所有的服务都以服务名的形式在服务中心中进行了注册，而gateway就可以获得注册中心的服务列表，通过在yml的路由配置，查找列表进行服务匹配。
所以我们更改我们的配置写法：

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true # 开启从注册中心动态创建路由的功能，利用微服务名称进行路由
      routes:
        - id: payment_route # 路由的id,没有规定规则但要求唯一,建议配合服务名
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/** # 断言，路径相匹配的进行路由

结果：

自定义过滤器

路由过滤器可用于修改进入的HTTP请求和 返回的 HTTP响应，路由过滤器只能指定路由进行使用。
SpringCloud Gateway内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生。

我们 可以根据项目的业务 需求进行自定义过滤器，实现两个重要的接口：GlobalFilter, Ordered

@Component
@Slf4j
public class MyLogGatewayFilter implements GlobalFilter, Ordered {

    //重写方法进行条件过滤
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("come in global filter: {}", new Date());

        ServerHttpRequest request = exchange.getRequest();
        String uname = request.getQueryParams().getFirst("uname");
        if (uname == null) {
            log.info("用户名为null，非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        // 放行
        return chain.filter(exchange);
    }

    /**
     * 过滤器加载的顺序 越小,优先级别越高
     *
     * @return
     */
    @Override
    public int getOrder() {
        return 0;
    }
}