统一网关Gateway、路由断言工厂、路由过滤器及跨域问题处理

╰+攻爆jí腚メ 2024-03-31 08:42 33阅读 0赞

**目录**

一、搭建网关服务

二、路由断言工程Route Predicate Factory

三、路由过滤器

四、全局过滤器GlobalFilter

过滤器执行顺序

五、跨域问题处理

--------------------

## 一、搭建网关服务 ##

网关的作用：

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

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

<dependency>
 <groupId>com.alibaba.cloud</groupId>
 <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
 </dependency>
 
 <dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-starter-gateway</artifactId>
 </dependency>

2、编写路由配置及nacos地址：

server:
      port: 10010
    spring:
      application:
        name: gateway
      cloud:
        nacos:
          server-addr: localhost:8848 # nacos地址
        gateway:
          routes:
            - id: user-service  # 路由标识，必须唯一
              uri: lb://userservice # 路由的目标地址
              predicates: # 路由断言，判断请求是否符合规则
                - Path=/user/** # 路径断言， 判断路径是否是以/user开头，如果是泽符合

## 二、路由断言工程Route Predicate Factory ##

网关路由可以配置的内容包括：

> 路由id：路由唯一 标示
> 
> uri：路由目的地，至此lb和http两种
> 
> predicates：路由断言，判断请求是否符合要求，符合则转发到路由目的地
> 
> filters：路由过滤器，处理请求或响应

Spring提供了11种基本的Predicate工厂：

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td style="text-align:center;">名称</td> 
 <td style="text-align:center;width:112px;">说明</td> 
 <td style="text-align:center;width:291px;">示例</td> 
 </tr> 
 <tr> 
 <td> After </td> 
 <td style="width:112px;"> 是某个时间点后的请求 </td> 
 <td style="width:291px;"> - After=2037-01-20T17:42:47.789-07:00[America/Denver] </td> 
 </tr> 
 <tr> 
 <td> Before </td> 
 <td style="width:112px;"> 是某个时间点之前的请求 </td> 
 <td style="width:291px;"> - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] </td> 
 </tr> 
 <tr> 
 <td> Between </td> 
 <td style="width:112px;"> 是某两个时间点之前的请求 </td> 
 <td style="width:291px;"> - Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver] </td> 
 </tr> 
 <tr> 
 <td> Cookie </td> 
 <td style="width:112px;"> 请求必须包含某些cookie </td> 
 <td style="width:291px;"> - Cookie=chocolate, ch.p </td> 
 </tr> 
 <tr> 
 <td> Header </td> 
 <td style="width:112px;"> 请求必须包含某些header </td> 
 <td style="width:291px;"> - Header=X-Request-Id, \d+ </td> 
 </tr> 
 <tr> 
 <td> Host </td> 
 <td style="width:112px;"> 请求必须是访问某个host（域名） </td> 
 <td style="width:291px;"> - Host=**.somehost.org,**.anotherhost.org </td> 
 </tr> 
 <tr> 
 <td> Method </td> 
 <td style="width:112px;"> 请求方式必须是指定方式 </td> 
 <td style="width:291px;"> - Method=GET,POST </td> 
 </tr> 
 <tr> 
 <td> Path </td> 
 <td style="width:112px;"> 请求路径必须符合指定规则 </td> 
 <td style="width:291px;"> - Path=/red/{segment},/blue/** </td> 
 </tr> 
 <tr> 
 <td> Query </td> 
 <td style="width:112px;"> 请求参数必须包含指定参数 </td> 
 <td style="width:291px;"> - Query=name, Jack或者- Query=name </td> 
 </tr> 
 <tr> 
 <td> RemoteAddr </td> 
 <td style="width:112px;"> 请求者的ip必须是指定范围 </td> 
 <td style="width:291px;"> - RemoteAddr=192.168.1.1/24 </td> 
 </tr> 
 <tr> 
 <td> Weight </td> 
 <td style="width:112px;"> 权重处理 </td> 
 <td style="width:291px;">&nbsp;</td> 
 </tr> 
 </tbody> 
</table>

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

## 三、路由过滤器 ##

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

过滤器工厂GatewayFilterFactory：

Spring中提供了31种不同的路由过滤器工程，可进入Spring官网进行查阅学习：

[Spring Cloud Gateway![icon-default.png_t_M85B][]https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/\#gateway-request-predicates-factories][Spring Cloud Gateway_icon-default.png_t_M85B_https_docs.spring.io_spring-cloud-gateway_docs_current_reference_html_gateway-request-predicates-factories]**案例：**给所有进入userservice的请求添加一个请求头

> 实现方式：在gateway中修改application.yml文件，给userservice的路由添加过滤器：

spring:
      application:
        name: gateway
      cloud:
        nacos:
          server-addr: localhost:8848 # nacos地址
        gateway:
          routes:
            - id: user-service  # 路由标识，必须唯一
              uri: lb://userservice # 路由的目标地址
              predicates: # 路由断言，判断请求是否符合规则
                - Path=/user/** # 路径断言， 判断路径是否是以/user开头，如果是泽符合
            - id: order-service
              uri: lb://orderservice
              predicates:
                - Path=/order/**
                - After=2031-04-13T15:14:47.433-08:00[Asia/Shanghai]
          default-filters:
            - AddRequestHeader=Truth,Itcast is freaking aowsome!

过滤器的**作用**：

> 对路由的请求或响应做加工处理，比如添加请求头
> 
> 配置在路由下的过滤器只对当前路由的请求生效

## 四、全局过滤器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);
 }

**案例：**定义全局过滤器，拦截并判断用户身份

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

> 参数中是否有authorization
> 
> authorization参数值是否为admin

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

自定义过滤器类，实现GlobalFilter接口，添加@Order注解：

//@Order(-1)
 @Component
 public class AuthorizeFilter implements GlobalFilter, Ordered {
 @Override
 public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
 //1、获取请求参数
 ServerHttpRequest request = exchange.getRequest();
 MultiValueMap<String, String> params = request.getQueryParams();
 //2、获取参数中的authorization参数
 String auth = params.getFirst("authorization");
 //3、判断参数值是否等于 admin
 if("admin".equals(auth)){
 //4、是，放行
 return chain.filter(exchange);
 }
 //5、否，拦截
 //5.1设置状态码
 exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
 //5.2拦截请求
 return exchange.getResponse().setComplete();
 }
 
 @Override
 public int getOrder() {
 return -1;
 }
 }

全局过滤器作用：对所有路由都生效的过滤器，并且可以自定义处理逻辑

实现全局过滤器的步骤：

> 1、实现GlobalFilter接口
> 
> 2、添加@Order注解或实现Order接口
> 
> 3、编写处理逻辑

### 过滤器执行顺序 ###

请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行过滤器

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

## 五、跨域问题处理 ##

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

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

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

解决方案：CORS

网关处理跨域采用的同样是CORS方案，并只需要简单配置即可实现：

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

[icon-default.png_t_M85B]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/dd4384bc0d4d467f9da486a968f60272.png
[Spring Cloud Gateway_icon-default.png_t_M85B_https_docs.spring.io_spring-cloud-gateway_docs_current_reference_html_gateway-request-predicates-factories]: https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories