SpringCloud - gateway

gateway 入门
路由断言工厂 Route Predicate Factories
过滤器工厂 GateWayFilter Factories
GlobalFilter 全局过滤器
过滤器执行顺序
跨域问题

gateway 入门

为什么需要 gateway？

SpringCloud 中网关的实现包括两种：

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

基于SpringCloudGateway 快速入门：
1.新建gateway 模块(springboot项目，需要些启动类)，引入依赖

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

2.application.yml 配置路由规则：

server:
  port: 10010  # 网关的端口

spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 # nacos 地址
    gateway:
      routes: # 网关路由配置
        - id: user-service  # 路由id，自定义，只需要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的具体目标地址，这样配置也是可以
          uri: lb://userservice # 路由的目标地址，lb为负载均衡的意思，后面跟服务的名称
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言，判断路径是否是以/user开头，如果是则符合
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**

首次访问网关，网关服务会拉取相关服务地址进行路由：

流程：

路由断言工厂 Route Predicate Factories

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

路由id：路由唯一标识
uri：路由目的地，支持lb和http
predicate：路由断言，判断请求是否符合要求，符合则转发路由目的地
filters：路由过滤器，处理请求或响应

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory 读取处理，转变为路由判断的条件
例如Path = /user/** 是按照路径配置，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory 类来处理
像这样的断言工厂在SpringCloudGateway 中还有十几个：

官方文档：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

过滤器工厂 GateWayFilter Factories

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

SpringCloud 提供的有30多种：

官方文旦: https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

案例：添加一个请求头，在Controller 层获取到该请求头

gateway中的application.yaml 中配置过滤器：

server:
  port: 10010

spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 # nacos 地址
    gateway:
      routes:
        - id: user-service  
          # uri: http://127.0.0.1:8081 
          uri: lb://userservice 
          predicates: 
            - Path=/user/** 
          filters:
            - AddRequestHeader=Name,chuangzhou  # 为userservice中的每个请求添加一个请求头
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**

user-service Controller 层中使用 @RequestHeader 来获取添加的请求头信息：

    @GetMapping("/{id}")
    public User queryById(@PathVariable("id") Long id,
                          @RequestHeader(value = "name", required = false) String requestHeanderName) {

        log.info("接收请求头中的name为: {}", requestHeanderName);
        return userService.queryById(id);
    }

也可以为网关中所有的微服务配置过滤器(default-filters)：

spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 # nacos 地址
    gateway:
      routes:
        - id: user-service  
          # uri: http://127.0.0.1:8081 
          uri: lb://userservice 
          predicates: 
            - Path=/user/** 
          filters:
            - AddRequestHeader=Name,chuangzhou  # 为userservice中的每个请求添加一个请求头
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
      default-filters:
        - AddRequestHeader=Name,chuangzhou

GlobalFilter 全局过滤器

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

案例：判断请求参数是否是满足下面条件：

参数中是否有authorization
authorization 参数值是否为admin
如果同时满足则放行，否则拦截

package com.chuangzhou.filter;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

//@Order(-1)
@Component
public class AuthorizationFilter implements GlobalFilter , Ordered {
    /**
     * 处理当前请求，有必要的话通过{@link GatewayFilterChain} 将请求交给下一个过滤器处理
     * @param exchange 请求上下文，里面可以获取Request、Response 等信息
     * @param chain 用来把请求委托给下一个过滤器
     * @return {@code Mono<Void>} 返回标识当前过滤器业务结束
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //获取请求对象
        ServerHttpRequest request = exchange.getRequest();
        //获取请求参数
        MultiValueMap<String, String> queryParams = request.getQueryParams();
        String authorization = queryParams.getFirst("authorization");
        if ("admin".equals(authorization)){
            //放行
            return chain.filter(exchange);
        }

        //设置返回状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

authorization != admin 被拦截：

authorization = admin 放行：

注意：

过滤器的执行顺序可以通过 @order 注解或者实现 Ordered 接口来控制

数字越小越优先执行

默认为最小，Integer的最大值

过滤器执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobaFilter
请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链中，排序后依次执行每个过滤器

过滤器执行顺序：

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

可以通过参考下面几个类的源码来查看：

跨域问题

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

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

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

解决方案：CORS

什么是CORS 可参考：

https://zhuanlan.zhihu.com/p/24411090

案例：

利用live-server 启动一个服务器：

什么live-server？ => https://blog.csdn.net/qq_45503196/article/details/127491046

打开浏览器，访问：http://127.0.0.1:8090/

产生跨越问题：

解决：
gateway - application.yml 中加入以下配置：

spring:
    gateway:
      routes: # 网关路由配置
        - id: user-service  # 路由id，自定义，只需要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的具体目标地址，这样配置也是可以
          uri: lb://userservice # 路由的目标地址，lb为负载均衡的意思，后面跟服务的名称
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言，判断路径是否是以/user开头，如果是则符合
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
      default-filters:
        - AddRequestHeader=Name,chuangzhou
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':   # 设置拦截哪些请求,/** 标识拦截一切请求
            allowedOrigins:  # 允许哪些网站的跨域请求
              - "http://127.0.0.1:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

记录遇到的问题：

allowedOrigins: 配置为 localhost:8090

但是浏览器访问的是：http://127.0.0.1:8090/

请求接口一直报错：

修改配置为：http://127.0.0.1:8090/ 后，请求成功：

posted @ 2023-09-09 21:39 chuangzhou 阅读(38) 评论(0) 编辑收藏举报

刷新页面返回顶部

认真的活在当下