【SpringCloud-学习笔记】统一网关Gateway

清疚 2023-09-28 18:51 5阅读 0赞

## 一、为什么需要网关 ##

网关功能：

*  身份认证和权限校验
 *  服务路由、负载均衡
 *  请求限流  
    ![在这里插入图片描述][82477c0631b548768934f6c7c315e4ba.png]

## 二、网关的技术实现 ##

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

*  gateway
 *  zuul

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

## 三、总结 ##

网关的作用：

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

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

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

搭建网关服务的步骤：

1.  创建新的module，引入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>

1.  编写路由配置及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就是负载均衡，后面跟服务名称
              predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
                - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

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

## 二、总结 ##

网关搭建步骤：

1.  创建项目，引入nacos服务发现和gateway依赖
2.  配置application.yml，包括服务基本信息、nacos地址、路由  
    路由配置包括：
3.  路由id：路由的唯一标示
4.  路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
5.  路由断言（predicates）：判断路由的规则，
6.  路由过滤器（filters）：对请求或响应做处理

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

## 一、路由断言工厂Route Predicate Factory ##

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

*  路由id：路由唯一标示
 *  uri：路由目的地，支持lb和http两种
 *  predicates：路由断言，判断请求是否符合要求，符合则转发到路由目的地
 *  filters：路由过滤器，处理请求或响应
 *  我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件
 *  例如Path=/user/\*\*是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的
 *  像这样的断言工厂在SpringCloudGateway还有十几个

Spring提供了11种基本的Predicate工厂：  
![在这里插入图片描述][aa42ad6bd4734928a6a8e3bcbb965591.png]

## 二、总结 ##

*  PredicateFactory的作用是什么？  
    读取用户定义的断言条件，对请求做出判断
 *  Path=/user/\*\*是什么含义？  
    路径是以/user开头的就认为是符合的

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

## 一、路由过滤器 GatewayFilter ##

GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：  
![在这里插入图片描述][8e6cf6e9e5cb4bb68d6f882ef3e047d8.png]

## 二、过滤器工厂 GatewayFilterFactory ##

Spring提供了31种不同的路由过滤器工厂。例如：  
![在这里插入图片描述][615205b1099e4d55b66bceb717d7c7cc.png]

## 三、案例：给所有进入userservice的请求添加一个请求头 ##

给所有进入userservice的请求添加一个请求头  
给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!

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

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

## 四、默认过滤器 ##

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

spring:
      application:
        name: gateway # 服务名称
      cloud:
        nacos:
          server-addr: localhost:8848 # nacos地址
        gateway:
          routes: # 网关路由配置
            - id: user-service 
              uri: lb://userservice  
              predicates: 
                - Path=/user/** 
            - id: order-service
              uri: lb://orderservice
              predicates:
                - Path=/order/**
          default-filters: # 默认过滤器，会对所有的路由请求都生效
            - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

## 五、总结 ##

过滤器的作用是什么？

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

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

## 一、全局过滤器 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  
    如果同时满足则放行，否则拦截

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

@Order(-1)
    @Component
    public class AuthorizeFilter implements GlobalFilter {
        
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        
            // 1.获取请求参数
            MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
            // 2.获取authorization参数
            String auth = params.getFirst("authorization");
            // 3.校验
            if ("admin".equals(auth)) {
        
                // 放行
                return chain.filter(exchange);
            }
            // 4.拦截
            // 4.1.禁止访问
            exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
            // 4.2.结束处理
            return exchange.getResponse().setComplete();
        }
    }

## 三、总结 ##

*  全局过滤器的作用是什么？  
    对所有路由都生效的过滤器，并且可以自定义处理逻辑
 *  实现全局过滤器的步骤？
    
     *  实现GlobalFilter接口
     *  添加@Order注解或实现Ordered接口
     *  编写处理逻辑

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

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

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter  
请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器  
![在这里插入图片描述][c8d151b34ef3483c9a7e970ef80b7669.png]

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

**org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator\#getFilters()** 方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

**org.springframework.cloud.gateway.handler.FilteringWebHandler\#handle()** 方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

## 二、总结 ##

*  路由过滤器、defaultFilter、全局过滤器的执行顺序？

1.  order值越小，优先级越高
2.  当order值一样时，顺序是defaultFilter最先，然后是局部的路由过滤器，最后是全局过滤器

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

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

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

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

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

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

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 # 这次跨域检测的有效期

## 二、总结 ##

CORS跨域要配置的参数包括哪几个？

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

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

## 一、限流过滤器 ##

限流：对应用服务器的请求做限制，避免因过多请求而导致服务器过载甚至宕机。限流算法常见的包括两种：

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

## 二、限流过滤器-计数器算法 ##

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

*  将时间划分为多个窗口；
 *  在每个窗口内每有一次请求就将计数器加一，当时间到达下一个窗口时，计数器重置。
 *  如果计数器超过了限制数量，则本窗口内所有的请求都被丢弃。  
    ![在这里插入图片描述][ca52df695810499a838aba9d632e2d85.png]

## 三、限流过滤器-漏桶算法 ##

漏桶算法说明：

*  将每个请求视作"水滴"放入"漏桶"进行存储；
 *  "漏桶"以固定速率向外"漏"出请求来执行，如果"漏桶"空了则停止"漏水”；
 *  如果"漏桶"满了则多余的"水滴"会被直接丢弃。  
    ![在这里插入图片描述][e165e4d16bcb43dd835678aeeedc714b.png]

## 四、限流过滤器-令牌桶算法 ##

漏桶算法说明：

*  以固定的速率生成令牌，存入令牌桶中，如果令牌桶满了以后，多余令牌丢弃
 *  请求进入后，必须先尝试从桶中获取令牌，获取到令牌后才可以被处理
 *  如果令牌桶中没有令牌，则请求等待或丢弃  
    ![在这里插入图片描述][e75e88fcd6ae47d592084a18e50c05f2.png]

## 五、总结 ##

限流有什么作用？

*  限流是保护服务器，避免因过多请求而导致服务器过载甚至宕机

限流算法：

*  计数器算法
 *  漏桶算法
 *  令牌桶算法

[82477c0631b548768934f6c7c315e4ba.png]: https://img-blog.csdnimg.cn/82477c0631b548768934f6c7c315e4ba.png
[9a2352bf7b81476a9ed015fd40ce5a53.png]: https://img-blog.csdnimg.cn/9a2352bf7b81476a9ed015fd40ce5a53.png
[aa42ad6bd4734928a6a8e3bcbb965591.png]: https://img-blog.csdnimg.cn/aa42ad6bd4734928a6a8e3bcbb965591.png
[8e6cf6e9e5cb4bb68d6f882ef3e047d8.png]: https://img-blog.csdnimg.cn/8e6cf6e9e5cb4bb68d6f882ef3e047d8.png
[615205b1099e4d55b66bceb717d7c7cc.png]: https://img-blog.csdnimg.cn/615205b1099e4d55b66bceb717d7c7cc.png
[c8d151b34ef3483c9a7e970ef80b7669.png]: https://img-blog.csdnimg.cn/c8d151b34ef3483c9a7e970ef80b7669.png
[ca52df695810499a838aba9d632e2d85.png]: https://img-blog.csdnimg.cn/ca52df695810499a838aba9d632e2d85.png
[e165e4d16bcb43dd835678aeeedc714b.png]: https://img-blog.csdnimg.cn/e165e4d16bcb43dd835678aeeedc714b.png
[e75e88fcd6ae47d592084a18e50c05f2.png]: https://img-blog.csdnimg.cn/e75e88fcd6ae47d592084a18e50c05f2.png