SpringCloud第三篇：GateWay服务网关

布满荆棘的人生 2024-03-16 16:22 19阅读 0赞

## 一、为什么需要服务网关： ##

### 1、什么是服务网关 ###

传统的单体架构中只需要开放一个服务给客户端调用，但是[微服务架构][Link 1]中是将一个系统拆分成多个微服务，如果没有网关，客户端只能在本地记录每个微服务的调用地址，当需要调用的微服务数量很多时，它需要了解每个服务的接口，这个工作量很大。那有了网关之后，能够起到怎样的改善呢？

网关作为系统的唯一流量入口，封装内部系统的架构，**所有请求都先经过网关，由网关将请求路由到合适的微服务**，所以，使用网关的好处在于：

（1）简化客户端的工作。网关将微服务封装起来后，客户端只需同网关交互，而不必调用各个不同服务；  
（2）降低函数间的耦合度。 一旦服务接口修改，只需修改网关的路由策略，不必修改每个调用该函数的客户端，从而减少了程序间的耦合性  
（3）解放开发人员把精力专注于业务逻辑的实现。由网关统一实现服务路由(灰度与ABTest)、负载均衡、访问控制、流控熔断降级等非业务相关功能，而不需要每个服务 API 实现时都去考虑

### 2、网关的作用 ###

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

![1d219480a7b14ee7af082599b82a0792.png][]

## 二、搭建网关服务的步骤 ##

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>

2、编写路由配置即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/开头就符合要求

> 我们将符合 path 规则的一切请求，都代理到 uri 参数指定的地址。
> 
> 本例中，我们将 `/user/**`开头的请求，代理到`lb://userservice`，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

> 路由配置包括：
> 
> 1.  路由id：路由的唯一标示
> 2.  路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
> 3.  路由断言（predicates）：判断路由的规则，
> 4.  路由过滤器（filters）：对请求或响应做处理

## 三、断言工厂 ##

![3a745745628f4052aa6b1f956d9e919d.png][]

**PredicateFactory的作用：**

*  **读取用户定义的断言条件，对请求做出判断**

Path=/user/\*\*是什么含义？

*  路径是以/user开头的就认为是符合的

## 四、过滤器工厂 ##

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

![14abc98154ba466fbebb3bdaedcb37a1.png][]

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

![374c1557fa744f75a6b1fb6eb84c6946.png][]

#### 1、请求头过滤器 ####

下面我们以AddRequestHeader 为例来讲解。

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

只需要修改gateway服务的application.yml文件，添加路由过滤即可：

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

当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。

#### 2、默认过滤器（default-filters） ####

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

spring:
      cloud:
        gateway:
          routes:
          - id: user-service 
            uri: lb://userservice 
            predicates: 
            - Path=/user/**
          default-filters: # 默认过滤项
          - AddRequestHeader=Truth, Itcast is freaking awesome!

**总结**

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

#### 3、全局过滤器 ####

> **需求**：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：
> 
>  *  参数中是否有authorization，
>  *  authorization参数值是否为admin
> 
> 如果同时满足则放行，否则拦截

**实现：**

在gateway中定义一个过滤器：

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

package cn.itcast.gateway.filters;
     
    import org.springframework.cloud.gateway.filter.GatewayFilterChain;
    import org.springframework.cloud.gateway.filter.GlobalFilter;
    import org.springframework.core.annotation.Order;
    import org.springframework.http.HttpStatus;
    import org.springframework.stereotype.Component;
    import org.springframework.web.server.ServerWebExchange;
    import reactor.core.publisher.Mono;
     
    @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();
        }
    }

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

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

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter

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

![be73affdea434b94b9d60ef6bb841fab.png][]

#### **排序规则：** ####

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

[Link 1]: https://so.csdn.net/so/search?q=%E5%BE%AE%E6%9C%8D%E5%8A%A1%E6%9E%B6%E6%9E%84&spm=1001.2101.3001.7020
[1d219480a7b14ee7af082599b82a0792.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/4a242d9dffb34d5fb6671ad64750a69d.png
[3a745745628f4052aa6b1f956d9e919d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/53b991854faf4f3db6febe7269a438ee.png
[14abc98154ba466fbebb3bdaedcb37a1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/7c6817a41a7045fca10b38f141a7059e.png
[374c1557fa744f75a6b1fb6eb84c6946.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/79c38d866f94417ebbb262e9fb80a3c9.png
[be73affdea434b94b9d60ef6bb841fab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/753a01d0153d418e9291a9756272e5dc.png