SpringCloud Alibaba - Gateway统一网关、断言工厂、过滤器工厂、全局过滤器、跨域问题

陈亦康

已于 2024-05-31 15:17:57 修改

阅读量1.2k

点赞数 4

分类专栏： SpringCloud & Alibaba 文章标签： spring cloud gateway java

于 2023-07-02 07:00:00 首次发布

本文链接：https://blog.csdn.net/CYK_byte/article/details/131493162

版权

SpringCloud & Alibaba 专栏收录该内容

32 篇文章 29 订阅

订阅专栏

一、什么是网关？为什么选择 Gateway?

二、Gateway 网关

2.1、搭建网关服务

1.创建新的module，引入SpringCloudGateway的依赖和nacos的服务发现依赖

2.编写nacos地址和路由配置

2.2、路由断言工厂PredicateFactory

2.3、路由过滤器 GatewayFilter

1.具体实现

2.过滤器的作用是什么

3.defaultFilters的作用是什么

2.4、全局过滤器 GlobalFilter

一、什么是网关？为什么选择 Gateway?

网关功能如下：

身份认证和权限校验
服务路由、负载均衡
请求限流

在 Spring Cloud 中网关的实现包含两种：

Gateway（推荐）：是基于 Spring5 中提供的 WebFlux ，属于响应式编程的实现，具备更好的性能，因此作为比较推荐实现网关的方式。
Zuul：是基于 Servlet 的实现，属于阻塞式编程

二、Gateway 网关

2.1、搭建网关服务

主要分为以下几个步骤：

1.创建新的module，引入SpringCloudGateway的依赖和nacos的服务发现依赖

<!--网关依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服务发现依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> 
</dependency>

高版本错误：

a）如果使用的是 springcloud高版本（例如 2020.1.0），那么 gateway 中的 ribbon 负载均衡已经被剔除了，因此需要引入 springcloud loadbalencer 作为 gateway 的负载均衡.

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-loadbalancer</artifactId>
        </dependency>

b）引入此依赖后，可能还会报 cache 的警告，引入一下两个依赖即可

        <dependency>
            <groupId>com.github.ben-manes.caffeine</groupId>
            <artifactId>caffeine</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
        </dependency>

2.编写nacos地址和路由配置

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 地址
    gateway:
      routes:  # 网关路由配置
        - id: user-service # 路由 id，自定义，只要唯一即可
          uri: lb://userservice # 路由的目标地址 lb 就是负载均衡，后面跟微服务名
          predicates: #路由断言
            - Path=/api/** # 这个是按照路径匹配，只要以 /api/ 开头就符合要求
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
          filters:
            - StripPrefix= 1 #去掉指定数量前缀路由

路由配置解释如下：

路由id：路由的唯一标示（自定义）
路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
路由断言（predicates）：路由的规则（匹配的才被 gateway 拦截下来）.
路由过滤器（filters）：对请求或响应做处理，例如 StripProfix 就是去掉指定数量的前缀路由，例如请求是 api/user/login，filters 处理为 StripProfix = 1（去掉一个前缀），那么处理后请求就是 /user/login.

工作原理：

2.2、断言 Predicate

2.2.1、predicate 是什么

断言（predicate）就是指当请求到达网关时，网关会做一个前置处理（后置处理是 filter 过滤，后面会详细讲），满足断言的请求才能放行通过，不满足断言就立即返回.

这就像是你进入某一个公司大厦的之前，会先经过扫脸的门禁，只有脸符合要求的人才能进入.

2.2.2、常用 predicate 类型

路径断言：例如 - Path=/user，就表示请求是 /user 的请求才能放行通过. 再例如 -Path=/user/** 表示以 /user/ 开头的请求都放行通过.
时间断言：- After 表示改路由规则必须再指定之家你之后才能生效，例如 After=2023-11-06T15:14:47.433+08:00[Asia/Shanghai]，这里是引用上海时间，表示只有再 2023-11-06 15:14:47 之后的请求才能生效（比如，双十一场景，开放降价通道）.
时间断言：- Before 表示改路由规则必须要再指定时间之前才有效（类比上面的栗子）.
时间断言：-Between 表示路由规则再某个时间段内有效，例如 - Between=2023-11-06T15:14:47.433+08:00[Asia/Shanghai], 2023-11-06T19:20:35.433+08:00[Asia/Shanghai]
Cookie 断言：- Cookie 表示携带指定 cookie 的请求才能放行. 例如 - Cookie=name,cyk 就表示只有携带 Cookie 键值对为 “name=cyk” 才能放行通过（如果有多个 Cookie，需要另起几行 -Cookie）. 例如
请求头断言：- Header 表示请求必须含有指定的请求头才放行. 例如 -Header=token,cyk （表示请求头中需要有 token=cyk 键值对。注意：这里是支持正则表达式的）
请求方式断言：- Method 表示限定请求方式. 例如 -Method=GET 表示只能使用 GET 请求.

例如配置：

spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: localhost:8890
    gateway:
      routes:
        - id: user-service
          uri: lb://user
          predicates:
            - Path=/user/get # 只有 /user/get 路径可以通过
            - After=2023-11-06T21:22:10.433+08:00[Asia/Shanghai] # 时间断言
            - Cookie=name,cyk # cookie 中必须携带 name=cyk 键值对
            - Header=token,cyk # header 中必须携带 token-cyk 键值对
            - Method=GET # 请求方式必须是 GET

Ps：Spring提供了11种基本的Predicate，并不需要都记下来，需要的时候去官网上 copy 即可

2.3、过滤器 Filter

2.3.1、内置 GatewayFilter

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

我们只需要记住以下几个常用的即可

1. AddRequestHeader：给当前请求添加一个请求头，例如 - AddRequestHeader=color, red 就表示给请求头总加入一个键值对 color=red.

2. AddRequestParameter：表示给请求加一个参数，例如 - AddRequestParameter=name, cyk 也就意味着后端对应的接口因该提供一个参数去接收

    @GetMapping("/get")
    public String user(String name) {
        System.out.println("拿到网关过滤器添加的参数：name=" + name);
        return "user ok! port=" + port;
    }

3. AddResponseHeader：给响应结果中添加一个响应头，例如 - AddResponseHeader=name,cyk 那么后端在返回响应的时候就会在响应头中添加 name=cyk 的键值对.

4. PrefixPath：表示给请求的 url 中添加前缀，例如 - PrefixPath=/user ，那么如果你原本的请求是路径是 localhost:8080/list ，那么经过 PrefixPath 处理之后，就会变成localhost:8080/user/list

5. StripPrefix：表示给请求的 url 中去表指定的 n 个前缀路由，例如 - StripPrefix=2 那么如果你原本的请求是路由是 /user/list/get ，那么经过 StripPrefix 处理后，就会变成 /get.

Ps：Spring提供了31种不同的路由过滤器工厂，这些需要什么都可以直接去官网上copy，不用刻意去记~

案例如下

    gateway:
      routes:
        - id: user-service
          uri: lb://user
          predicates:
#            - Path=/user/get # 只有 /user/get 路径可以通过
#            - After=2023-11-06T21:22:10.433+08:00[Asia/Shanghai] # 时间断言
#            - Cookie=name,cyk # cookie 中必须携带 name=cyk 键值对
#            - Header=token,cyk # header 中必须携带 token-cyk 键值对
#            - Method=GET # 请求方式必须是 GET
          filters: # 过滤器
            - AddRequestHeader=color, red
            - AddRequestParameter=name, cyk
      default-filters: # 默认过滤器，会对所有的路由请求都生效
        - AddRequestHeader=name, lyj! # 添加请求头

2.3.2、自定义全局 filter

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

a）具体实现

实现 GlobalFilter 接口，重写 filter 方法
添加 @Order 注解或实现 Ordered 接口
编写处理逻辑

b）具体代码

/**
 * 自定义全局网关 filter
 */
@Configuration
public class HandlerGlobalFilter implements GlobalFilter, Ordered {

    /**
     * 类似 javaweb doFilter
     * @param exchange 交换 request response，封装了 request response
     * @param chain 决定是否继续向后执行
     * @return
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //获取封装 HttpRequest 后的对象
        ServerHttpRequest request = exchange.getRequest();
        //获取封装 HttpResponse 后的对象
        ServerHttpResponse response = exchange.getResponse();
        System.out.println("-------请求到来，经过全局 Filter 处理-------");
        //对请求做处理......
        Mono<Void> filter = chain.filter(exchange);//放行 filter 向后执行：也就意味接下来进入到具体的微服务中(例如 user 微服务)
        //对响应做处理......
        System.out.println("-------响应回来，经过全局 Filter 处理-------");
        return filter;
    }

    /**
     * order 排序
     * @return 返回一个 int 数字，用来指定 filter 执行顺序，默认按照自然数由小到大顺序排序(越小越先执行)
     *  -1 特殊，表示在所有 filter 执行之前执行
     */
    @Override
    public int getOrder() {
        return -1;
    }

}

c）执行结果

d）执行顺序

2.3.3、过滤器执行顺序

请求进入网关会碰到三类过滤器（当前路由的过滤器、DefaultFilter、GlobalFilter），然后合并到一个过滤器集合中，排序后一次执行每一个过滤器，那么他的一个执行顺序是怎样的呢？

执行规则

1.order值越小，优先级越高（GlobalFilter由我们自定义，路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增）

2.当order值一样时，顺序是defaultFilter > 路由过滤器 > 全局过滤器。

2.5、Gateway 跨域问题处理

跨域：域名不一致就是跨域，主要包括：

域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
域名相同，端口不同：localhost:8080和localhost8081

详细如下：

跨域流程如下：

因此如果非简单请求，就需要进行配置，来允许跨域请求.

解决如下：

a）方式一：通过配置 nginx 反向代理，使得发起请求，和接收请求的域一样

b）方式二：后端配置

网关处理跨域采用的同样是CORS方案，并且只需要简单配置即可实现（这些东西不用记住，需要的时候 CV 就可以）

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求(2.4版本以后需要更改为 allowedOriginPatterns ) 
              - "http://localhost:8090"
              - "http://www.cyk.com"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期（为例减少性能损耗，在有效时间内，浏览器将不在发起询问，直接放行通过）

当然也可以不用分的这么细，可以直接用下面整个通用的配置即可.

spring:
  cloud:
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            allowedMethods: "*"
            allowedHeaders: "*"
            allowedOriginPatterns: "*"
            allowCredentials: true

陈亦康

关注

4
点赞
踩
6

收藏

觉得还不错? 一键收藏
打赏
0
评论
SpringCloud Alibaba - Gateway统一网关、断言工厂、过滤器工厂、全局过滤器、跨域问题

是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能，因此作为比较推荐实现网关的方式。是基于Servlet的实现，属于阻塞式编程。
复制链接

扫一扫