Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

网关的作用

Gateway网关是我们所有微服务的统一入口。

网关的核心功能特性

  • 请求路由

  • 权限控制

  • 限流

架构图:

image-20210714210131152.png

权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。

路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。

限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。

在SpringCloud中网关的实现包括两种:

  • gateway

  • zuul

Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。

zuul

Zuul是基于Servlet的实现,属于阻塞式编程

springcloud-gateway

该项目借助Spring WebFlux的能力,打造了一个API网关。旨在提供一种简单而有效的方法来作为API服务的路由,并为它们提供各种增强功能,例如:安全性,监控和可伸缩性。

入门使用

依赖

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

配置文件

网关配置

spring:
  cloud:
    gateway:
      discovery:
        locator:
          # 是否和服务注册与发现组件结合,设置为 true 后可以直接使用应用名称调用服务
          enabled: true
      enabled: true
      # 网关路由配置
      routes:
        # 路由可以配置多个
        - id: user-service # 路由id,自定义,全局唯一
          uri: lb://user-service # 路由的目标地址,lb就是负载均衡,后面跟服务名称
          predicates: # 路由规则(路由断言)也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只有以/user/开头就符合要求
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**

nacos配置

。。。。。。。。。。省略

代码配置

这里也不知道为什么,新版默认负载均衡为loadBalance,在和nacos结合使用时。如果不显示的配置每个服务对应的配置。会导致nacos负载均衡策略在创建时无法获取对应的服务名

现象如下:

image-pqdb.png初步看到的原因是因为,没有显示声明指定服务的负载均衡配置,导致服务对应的spring上下文中没有对应的bean,所以去父级中查找。而父级中的负载均衡策略是没有name。

这个父级上下文bean的来源是因为自定义的负载均衡策略打了@Component注解,导致spring应用最顶级的上下文再启动时就加载了一个负载均衡的bean,这个bean是有问题的,每个服务无法使用。

额外添加上缺失服务的配置就正常了。

@Configuration
public class MyRemoteServiceLoadBalancerConfiguration {


    @Bean("userServiceLoadBalancer")
    public LoadBalancerClientSpecification userServiceLoadBalancer(){
        LoadBalancerClientSpecification myLoadBalancer = new LoadBalancerClientSpecification();
        myLoadBalancer.setName("user-service");
        myLoadBalancer.setConfiguration(new Class[]{NacosLoadBalancerClientConfiguration.class});
        return myLoadBalancer;
    }

    @Bean("orderServiceLoadBalancer")
    public LoadBalancerClientSpecification orderServiceLoadBalancer(){
        LoadBalancerClientSpecification myLoadBalancer = new LoadBalancerClientSpecification();
        myLoadBalancer.setName("order-service");
        myLoadBalancer.setConfiguration(new Class[]{NacosLoadBalancerClientConfiguration.class});
        return myLoadBalancer;
    }
}

最根本的解决之道是,移除自定义负载均衡策略的@Component注解,因为每个服务对应的上下文再第一次加载时,会注册以及初始化对应的bean。这里的setConfiguration(new Class[]{NacosLoadBalancerClientConfiguration.class});就相对于注册了一个bean给服务对应的上下文。

再移除注解后,如果没有显示配置,则会读取默认配置,创建一个RoundRobinLoadBalancer的负载均衡策略。

predicates-路由断言

们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件

例如Path=/user/**是按照路径匹配,这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来

处理的,像这样的断言工厂在SpringCloudGateway还有十几个:

名称

说明

示例

After

是某个时间点后的请求

- After=2037-01-20T17:42:47.789-07:00[America/Denver]

Before

是某个时间点之前的请求

- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]

Between

是某两个时间点之前的请求

- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]

Cookie

请求必须包含某些cookie

- Cookie=chocolate, ch.p

Header

请求必须包含某些header

- Header=X-Request-Id, \d+

Host

请求必须是访问某个host(域名)

- Host=.somehost.org,.anotherhost.org

Method

请求方式必须是指定方式

- Method=GET,POST

Path

请求路径必须符合指定规则

- Path=/red/{segment},/blue/**

Query

请求参数必须包含指定参数

- Query=name, Jack或者- Query=name

RemoteAddr

请求者的ip必须是指定范围

- RemoteAddr=192.168.1.1/24

Weight

权重处理,整数和权重按组计算

- id: weight_high
uri: https://weighthigh.org

predicates:

- Weight=group1, 8

- id: weight_low

uri: https://weightlow.org

predicates:

- Weight=group1, 2

XForwardedRemoteAddr

远程地址,允许根据 HTTP 标头筛选请求。X-Forwarded-For

- XForwardedRemoteAddr=192.168.1.1/24

官网断言说明:Spring Cloud Gateway

filter-过滤器

GatewayFilter-网关过滤器

GatewayFilter是网关中提供的一种默认1过滤器,可以对进入网关的请求和微服务返回的响应做处理。默认的配置通过GatewayFilterFactory来生成一个对应的GatewayFilter

执行调用机制和mvc的拦截器类似

Spring提供了31种不同的路由过滤器工厂。例如:

名称

说明

AddRequestHeader

给当前请求添加一个请求头

RemoveRequestHeader

移除请求中的一个请求头

AddResponseHeader

给响应结果中添加一个响应头

RemoveResponseHeader

从响应结果中移除有一个响应头

RequestRateLimiter

限制请求的流量

官网过滤器说明:Spring Cloud Gateway

如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=Truth, Itcast is freaking awesome! 

过滤器的作用

① 对路由的请求或响应做加工处理,比如添加请求头

② 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用

① 对所有路由都生效的过滤器

GlobalFilter-全局过滤器

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

public interface GlobalFilter {
    /**
     *  处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文,里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

该过滤器在构建执行链的时候,通过适配器模式交给了GatewayFilterAdapter,最终变为了GatewayFilter。

通过FilteringWebHandler委派完成GatewayFilter实例链和GatewayFilterFactory实例调用


过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:

image-20210714214228409.png排序的规则

  • 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前

  • GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定

  • 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。

  • 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

详细内容,可以查看源码:

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链


网关跨域问题

什么是跨域问题

跨域:域名不一致就是跨域,主要包括:

  • 域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

  • 域名相同,端口不同:localhost:8080和localhost:8081

跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题

解决方案:CORS

解决跨域问题

网关处理跨域采用的同样是cors方案

在gateway服务的application.yml文件中,添加下面的配置:

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]': #哪些请求允许跨域
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

原理分析

Spring Cloud Gateway 原理介绍和应用 - 知乎 (zhihu.com)