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

为什么需要网关

Gateway网关是我们服务的守门神,所有微服务的统一入口。
网关的核心功能特性

  • 请求路由和负载均衡

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

  • 权限控制

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

  • 限流

当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
架构图:
image-20210714210131152.png
在SpringCloud中网关的实现包括两种

  • gateway
  • zuul

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

创建网关

新建一个maven模块

1.引入依赖

  1. <!--网关-->
  2. <dependency>
  3. <groupId>org.springframework.cloud</groupId>
  4. <artifactId>spring-cloud-starter-gateway</artifactId>
  5. </dependency>
  6. <!--nacos服务发现依赖-->
  7. <dependency>
  8. <groupId>com.alibaba.cloud</groupId>
  9. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  10. </dependency>

:::danger 不能引入spring-boot-starter-web依赖。
因为我使用了spring cloud gateway,它是基于webflux的,如果非要web支持的话需要导入spring-boot-starter-webflux而不是spring-boot-start-web。
而spring-cloud-starter-gateway依赖了spring-boot-starter-webflux。 :::

2.添加启动类

  1. package cn.itcast.gateway;
  2. @SpringBootApplication
  3. public class GatewayApplication {
  4. public static void main(String[] args) {
  5. SpringApplication.run(GatewayApplication.class, args);
  6. }
  7. }

3.编写基本配置和路由规则

  1. server:
  2. port: 10010 # 网关端口
  3. spring:
  4. application:
  5. name: gateway # 服务名称
  6. cloud:
  7. nacos:
  8. server-addr: localhost:8090 # nacos地址
  9. gateway:
  10. routes: # 网关路由配置,是个list
  11. - id: user-service # 路由id,自定义,只要唯一即可
  12. # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
  13. uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
  14. predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
  15. - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求

我们将符合Path规则的一切请求,都代理到 uri参数指定的地址。
本例中,我们将 /user/**开头的请求,代理到lb://userservice,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
路由的配置包括:

  1. 路由id:路由的唯一标示
  2. 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
  3. 路由断言(predicates):判断路由的规则,
  4. 路由过滤器(filters):对请求或响应做处理 :::danger 注意:predicates断言里面,一种断言只能写一次,多个同类型的断言用英文逗号隔开
    例如:
    - Path=/user/,/goods/
    不能写成这样
    ~~ - Path=/user/
    - Path=/goods/
    ~~
    这种约定,用于下面的断言工厂和过滤器工厂。错误写法直接报错,404 :::

    4.启动gateway测试

    gateway模块里面就只有一个启动类和配置文件。
    启动后,访问http://localhost:10010/user/3,就会自动转发到userservice服务。上面路由规则没有写order,所以网关无法路由order。

    网关路由流程图

    image-20210714211742956.png

    断言工厂

    我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件。
    例如Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的,像这样的断言工厂在SpringCloudGateway还有十几个
    可以去看官方文档Route Predicate Factories
名称 说明 示例
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 权重处理 - Weight=group1, 2

过滤器工厂

GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:

image-20210714212312871.png

路由过滤器的种类

SpringCloud Gateway提供了31种不同的路由过滤器工厂。官方文档GatewayFilter Factories
怎么用的,官方文档有,使用场景就是给请求头加东西啊,限制请求流量啊,给响应头加东西之类的。

例子:请求头过滤器

当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效

  1. spring:
  2. cloud:
  3. gateway:
  4. routes:
  5. - id: user-service
  6. uri: lb://userservice
  7. predicates:
  8. - Path=/user/**
  9. filters: # 过滤器
  10. - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

默认过滤器

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

  1. spring:
  2. cloud:
  3. gateway:
  4. routes:
  5. - id: user-service
  6. uri: lb://userservice
  7. predicates:
  8. - Path=/user/**
  9. default-filters: # 默认过滤项
  10. - AddRequestHeader=Truth, Itcast is freaking awesome!

全局过滤器

SpringCloud Gateway提供了31种过滤器,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。
定义方式是实现GlobalFilter接口。

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

例子:自定义全局过滤器

需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:

  • 参数中是否有authorization,
  • authorization参数值是否为admin

如果同时满足则放行,否则拦截

  1. package cn.itcast.gateway;
  2. //过滤器的顺序,值越小越先执行
  3. @Order(-1)
  4. @Component
  5. public class AuthorizeFilter implements GlobalFilter {
  6. @Override
  7. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  8. // 1.获取请求参数
  9. MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
  10. // 2.获取authorization参数
  11. String auth = params.getFirst("authorization");
  12. // 3.校验
  13. if ("admin".equals(auth)) {
  14. // 放行
  15. return chain.filter(exchange);
  16. }
  17. // 4.拦截
  18. // 4.1.禁止访问,设置状态码
  19. exchange.getResponse().setStatusCode(HttpStatus.BAD_REQUEST);
  20. // 4.2.结束处理
  21. return exchange.getResponse().setComplete();
  22. }
  23. }

过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
image-20210714214228409.png
排序的规则是什么呢?

  • 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前
  • GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
  • 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
  • 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

    跨域问题

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

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

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

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

  1. spring:
  2. cloud:
  3. gateway:
  4. globalcors: # 全局的跨域处理
  5. add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
  6. corsConfigurations:
  7. '[/**]':
  8. allowedOrigins: # 允许哪些网站的跨域请求
  9. - "http://localhost:8090"
  10. allowedMethods: # 允许的跨域ajax的请求方式
  11. - "GET"
  12. - "POST"
  13. - "DELETE"
  14. - "PUT"
  15. - "OPTIONS"
  16. allowedHeaders: "*" # 允许在请求中携带的头信息
  17. allowCredentials: true # 是否允许携带cookie
  18. maxAge: 360000 # 这次跨域检测的有效期