目录

Gateway网关

流水不争先,争得是滔滔不绝

为什么需要网关

网关的功能:

  • 对用户请求做身份认证和权限校验
  • 将用户请求路由到微服务、并实现负载均衡
  • 对用户请求做限流

架构图:

https://s2.loli.net/2022/11/28/jcGEoaOyQvHDW1M.png

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

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

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

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

  • Gateway
  • Zuul

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

搭建网关服务

搭建网关服务的步骤

1、创建新的module,引入Spring Cloud Gateway的依赖和Nacos的服务发现依赖:

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

2、编写路由配置及Nacos地址:

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

然后访问地址:http://localhost:10086/user/1 和 http://localhost:10086/order/101

访问http://localhost:10086/user/1时,符合/user/**的规则,请求会转发到http://userservice/user/1

访问http://localhost:10086/order/101 时,符合/order/**的规则,请求会转发到http://orderservice/order/101

整个访问流程如下:

https://s2.loli.net/2022/11/28/8UgauBjJ4HMy6Di.png

总结

路由配置包括:

1、路由id:路由的唯一标识

2、路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡

3、路由断言(predicates):判断路由的规则

4、路由过滤器(filters):对请求或响应做处理

路由断言工厂

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

例如 Path=/user/** 是按照路径匹配,这个规则是由PathPoutePredicateFactory类来处理的。

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

https://s2.loli.net/2022/11/28/Plphsng6ymFki9J.png

详细说明和示例可以看官方文档:Spring Cloud Gateway Route Predicate Factories

路由过滤器

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

Spring提供了30多种不同的路由过滤器工厂:Spring Cloud GatewayFilter Factories

以 AddRequestHeader 为例来添加路由过滤:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
spring:
  application:
    name: gateway #服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 #nacos地址
    gateway:
      routes: 
        - id: user-service 
          uri: lb://userservice 
          predicates: 
            - Path=/user/** 
          filters: #过滤器
            - AddRequestHeader=MyWife, songzhixiao #添加请求头

过滤器写在userservice路由下,表示这个过滤器只对userservice的请求有效。

如果要对所有的路由都生效,那么需要配置默认过滤器:

1
2
3
4
spring:
    gateway:
      default-filters: #配置默认过滤器
        - AddRequestHeader=MyWife, songzhixiao

全局过滤器

全局过滤器:Spring Cloud Gateway Global Filters

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。

区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

1.自定义全局过滤器

实现:

在Gateway中定义一个过滤器,实现GlobalFilter接口,然后设置过滤器执行顺序。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
@Order(0) //设置过滤器执行顺序
@Component
public class AuthorizeFilter implements GlobalFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 获取auth参数
        String auth = params.getFirst("auth");
        // 校验
        if("haha".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        //拦截
        //1.设置状态码,UNAUTHORIZED-->401
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        //2.拦截
        return exchange.getResponse().setComplete();
    }
}

2.过滤器执行顺序

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

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

https://s2.loli.net/2022/11/28/g1kuD4dinJaMFOj.png

过滤器执行顺序

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

跨域问题

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

  • 域名不同:www.taobao.com和www.taobao.org
  • 域名相同,端口不同:localhost:8080和localhost:8081

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

解决方案:CORS,只需要在Gateway的application.yml配置就可以了:

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