【SpringCloud】Gateway网关

淡淡的烟草味﹌ 2023-10-10 19:38 58阅读 0赞

#### 文章目录 ####

*  1、网关的作用
 *  2、搭建网关服务
 *  3、路由断言
 *  4、GatewayFilter
 *  5、全局过滤器
 *  6、过滤器的执行顺序
 *  7、限流过滤器
 *  8、跨域问题处理

## 1、网关的作用 ##

服务就像一个景点，如果人人可以访问，不管是游客还是搞破坏的人都放进来，那一定出事。由此，景区增加了统一入口，设保安，给游客指路，并对每日访客流量进行控制。对应网关的功能：

*  `身份认证和权限校验`：无权限拒绝访问（无门票拒绝入内）
 *  `服务路由、负载均衡`：路由到哪个服务，服务有多个实例时，要负载均衡（给游客带路，并带到不拥挤的服务点）
 *  `请求限流`：对微服务的一种保护（景点最大游客数）

![在这里插入图片描述][7546505215ff4182af742f8be063310f.png]

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

*  `STEP1：`创建新的模块，起名gateway，引入SpringCloudGateway的依赖和nacos的服务发现依赖

<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>

*  `STEP2：`在application.yaml中编写路由配置及nacos配置

server:
      port: 10010 # 网关端口
    spring:
      application:
        name: gateway  # 服务名称
      cloud:
        nacos:
          server-addr: localhost:8848  # nacos地址
        gateway:
          routes:  # 网关路由配置
            - id: user-service # 路由id，自定义，只要唯一即可
              # uri: http://127.0.0.1:8081 # 路由的目标地址http就是固定地址
              uri: lb://userservice # 路由的目标地址lb就是负载均衡，loadBalance后面跟服务名称
              predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
                - Path=/user/**  # 这个是按照路径匹配，只要以/user/开头就符合要求,就转发到userservice
            - id: order-service
              uri: lb://ordeservice
              predicates:
                - Path=/order/**

参数含义：
    路由id: 路由唯一标识
    uri: 路由目的地，支持lb和http两种
    predicates: 路由断言，判断请求是否符合要求。并根据规则转发到路由目的地
    filters: 路由过滤器，处理请求或者响应

*  `STEP3：`启动gateway服务，请求从网关被路由到了对应的微服务，网关搭建成功

![在这里插入图片描述][03c2b99ca3234e21add456335c22274a.png]

调用以上接口，实际的具体流程如下：

![在这里插入图片描述][efd8a91ef9f04a009e9bb40cb5e2422d.png]

## 3、路由断言 ##

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

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

我们在上面gateway的配置文件中写的predicate只是字符串，这些字符串会被Predicate Factory（路由工厂）读取并处理，然后转化为路由判断条件。

例如Path=/user/**是按照路径匹配：
    这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的。

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

![在这里插入图片描述][0129e54c5cbe492895feacf6b475f24a.png]  
可以看到，这些断言条件，可以限制访问者的网段范围、域名、访问时间、访问方式、访问路径等

举例：

![在这里插入图片描述][2b2ebe5332ca4e8fa5366bb19f32cd55.png]

加了这个断言，就像景点加了上班时间，必须八点以后来order服务才有人接待你，提前来的没人鸟你。（404）

![在这里插入图片描述][69bd053879e4452fa83a988627ec67db.png]

## 4、GatewayFilter ##

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

![在这里插入图片描述][13b2997504a24a238a0bdde44c4f5494.png]

Spring提供了31种不同的路由过滤器工厂。例如：

![在这里插入图片描述][3f323e8e65c14e9b9141050c3f11cc13.png]

所有过滤器参考SpringGateway的文档：[https://docs.spring.io/spring-cloud-gateway/docs/][https_docs.spring.io_spring-cloud-gateway_docs]

![在这里插入图片描述][789e222bff944d40b1f1c55935d6382f.png]

示例：给所有进入userservice的请求添加一个请求头：user= currrent user is code-9527

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

spring:
      cloud:
        gateway:
      routes: # 网关路由配置       
        - id: user-service         
          uri: lb://userservice         
          predicates:
            - Path=/user/**         
          filters: # 过滤器
            - AddRequestHeader=auhtor, author is code-9527 # 添加请求头

修改user service的接口，用@RequestHeader注解拿请求头中的信息：

@GetMapping("/{id}")
    public User queryById(@PathVariable("id") Long id,
    					  @RequestHeader(value = "author",required=false) String author ){
        
    
    	System.out.println("author:" + author);
    	return userservice.queryById(id);
    }

重启gateway和userservice，再通过网关调用这个接口，IDEA控制台输出：

author：author is code-9527

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

![在这里插入图片描述][aa2944b570cf47a5b6fc61cf3c734527.png]

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

> defaultFilters的作用是什么？  
>   
> ➢ 对所有路由都生效的过滤器

## 5、全局过滤器 ##

> 全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。不同的是，这里的逻辑是你自己写代码定义的，而不是官方写好的。定义方式是实现GlobalFilter接口。

![在这里插入图片描述][7d16cda5b9ee4df3ab1497d84f2f4a5b.png]

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

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

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

自定义类，实现GlobalFilter接口，重写filter方法：

![在这里插入图片描述][d61f2e3a8192465baac456a959a7db30.png]  
@Order注解是用来说明该过滤器执行的顺序，数字越小，优先级越高，越先执行。不加这个注解，就要再实现Ordered接口，重写getOrder方法

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

此时，再访问，报错401  
![在这里插入图片描述][48a83e23337042d1aed2efaa20535773.png]  
加上authorization，访问成功：

![在这里插入图片描述][134452b72d0f46aa89ee0fca3c56c5d1.png]

## 6、过滤器的执行顺序 ##

> 请求进入网关会碰到三类过滤器：当前路由id下的过滤器、全局的DefaultFilter、自定义的GlobalFilter。

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

![在这里插入图片描述][b66d7fd16215446591fb8832ceeca798.png]

过滤器执行顺序：

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

## 7、限流过滤器 ##

> 限流：对应用服务器的请求做限制，避免因过多请求而导致服务器过载甚至宕机。

限流算法常见的包括两种：

*  计数器算法，又包括窗口计数器算法、滑动窗口计数器算法
 *  漏桶算法(Leaky Bucket)
 *  令牌桶算法（Token Bucket）

限流过滤器-计数器算法

固定窗口计数器算法概念如下：

*  `将时间划分为多个窗口`
 *  在每个窗口内每有一次请求就将计数器加一，当时间到达下一个窗口时，计数器重置
 *  如果计数器超过了限制数量，则本窗口内所有的请求都被丢弃

![在这里插入图片描述][4579b72256f046b0a1ee8cbabc0470f1.png]

限流过滤器-漏桶算法

*  将每个请求视作"水滴"放入"漏桶"进行存储
 *  "漏桶"以固定速率向外"漏"出请求来执行，如果"漏桶"空了则停止"漏水”
 *  如果"漏桶"满了则多余的"水滴"会被直接丢弃

![在这里插入图片描述][e64a555e579d4247827a350034017a13.png]

像极了景点加个强制排队的围栏，不要一下全部涌向服务窗口，而是以固定的速率和人数

限流过滤器-令牌桶算法

*  以固定的速率生成令牌，存入令牌桶中，如果令牌桶满了以后，多余令牌丢弃
 *  请求进入后，必须先尝试从桶中获取令牌，获取到令牌后才可以被处理
 *  如果令牌桶中没有令牌，则请求等待或丢弃

![在这里插入图片描述][eeb43f975f274aa198a770da5da10cc6.png]

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

> 跨域：域名不一致就是跨域，主要包括：  
>   
> ➢域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com  
> ➢域名相同，端口不同：localhost:8080和localhost8081

但注意，不是跨域就一定有问题，如本地的order和user服务，端口就不同。

> 跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题  
> ![在这里插入图片描述][f68d5e23a1124bb1ba9ff6e8cd5f812c.png]

解决方案：CORS ，即浏览器去问一下服务器：你允许跨域访问吗

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

![在这里插入图片描述][eebe8f3bd6df432d8eba01cfe3415670.png]

maxAge即跨域检测有效期，有效期内，浏览器将不再对服务端发起询问，而是直接放行。`allowedOrigins则是写你允许跨域请求的网站都有哪些。`

总结，SpringCloud Gateway中CORS跨域要配置的参数包括：

*  允许哪些域名跨域？
 *  允许哪些请求头？
 *  允许哪些请求方式？
 *  是否允许使用cookie？
 *  有效期是多久？

[7546505215ff4182af742f8be063310f.png]: https://img-blog.csdnimg.cn/7546505215ff4182af742f8be063310f.png
[03c2b99ca3234e21add456335c22274a.png]: https://img-blog.csdnimg.cn/03c2b99ca3234e21add456335c22274a.png
[efd8a91ef9f04a009e9bb40cb5e2422d.png]: https://img-blog.csdnimg.cn/efd8a91ef9f04a009e9bb40cb5e2422d.png
[0129e54c5cbe492895feacf6b475f24a.png]: https://img-blog.csdnimg.cn/0129e54c5cbe492895feacf6b475f24a.png
[2b2ebe5332ca4e8fa5366bb19f32cd55.png]: https://img-blog.csdnimg.cn/2b2ebe5332ca4e8fa5366bb19f32cd55.png
[69bd053879e4452fa83a988627ec67db.png]: https://img-blog.csdnimg.cn/69bd053879e4452fa83a988627ec67db.png
[13b2997504a24a238a0bdde44c4f5494.png]: https://img-blog.csdnimg.cn/13b2997504a24a238a0bdde44c4f5494.png
[3f323e8e65c14e9b9141050c3f11cc13.png]: https://img-blog.csdnimg.cn/3f323e8e65c14e9b9141050c3f11cc13.png
[https_docs.spring.io_spring-cloud-gateway_docs]: https://docs.spring.io/spring-cloud-gateway/docs/4.0.7-SNAPSHOT/reference/html/#global-filters
[789e222bff944d40b1f1c55935d6382f.png]: https://img-blog.csdnimg.cn/789e222bff944d40b1f1c55935d6382f.png
[aa2944b570cf47a5b6fc61cf3c734527.png]: https://img-blog.csdnimg.cn/aa2944b570cf47a5b6fc61cf3c734527.png
[7d16cda5b9ee4df3ab1497d84f2f4a5b.png]: https://img-blog.csdnimg.cn/7d16cda5b9ee4df3ab1497d84f2f4a5b.png
[d61f2e3a8192465baac456a959a7db30.png]: https://img-blog.csdnimg.cn/d61f2e3a8192465baac456a959a7db30.png
[48a83e23337042d1aed2efaa20535773.png]: https://img-blog.csdnimg.cn/48a83e23337042d1aed2efaa20535773.png
[134452b72d0f46aa89ee0fca3c56c5d1.png]: https://img-blog.csdnimg.cn/134452b72d0f46aa89ee0fca3c56c5d1.png
[b66d7fd16215446591fb8832ceeca798.png]: https://img-blog.csdnimg.cn/b66d7fd16215446591fb8832ceeca798.png
[4579b72256f046b0a1ee8cbabc0470f1.png]: https://img-blog.csdnimg.cn/4579b72256f046b0a1ee8cbabc0470f1.png
[e64a555e579d4247827a350034017a13.png]: https://img-blog.csdnimg.cn/e64a555e579d4247827a350034017a13.png
[eeb43f975f274aa198a770da5da10cc6.png]: https://img-blog.csdnimg.cn/eeb43f975f274aa198a770da5da10cc6.png
[f68d5e23a1124bb1ba9ff6e8cd5f812c.png]: https://img-blog.csdnimg.cn/f68d5e23a1124bb1ba9ff6e8cd5f812c.png
[eebe8f3bd6df432d8eba01cfe3415670.png]: https://img-blog.csdnimg.cn/eebe8f3bd6df432d8eba01cfe3415670.png