07-微服务getaway网关详解

一、初识网关

在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。这样的话会产生很多问题，例如：

• 客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
• 认证复杂，每个微服务都有独立认证
• 存在跨域请求，在一定场景下处理相对复杂
  为解决上面的问题所以引入了网关的概念：所谓的API网关，就是指系统的统一入口，提供内部服务的路由中转，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、路由转发等

1.1 网关的分类

• Zuul 1.x
  Netflix开源的网关，基于Servlet框架构建，功能丰富，使用JAVA开发，易于二次开发 问题：即一个线程处理一次连接请求，这种方式在内部延迟严重、设备故障较多情况下会引起存活的连接增多和线程增加的情况发生。
• Zuul 2.x
  Zuul2 采用了Netty实现异步非阻塞编程模型，每个 CPU 核一个线程，处理所有的请求和响应，请求和响应的生命周期是通过事件和回调来处理的，这种方式减少了线程数量，因此开销较小。
• GateWay
  Spring公司为了替换Zuul而开发的网关服务，底层为Netty，将在下面具体介绍。
• Nginx+lua
  使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用，lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本，问题在于：无法融入到微服务架构中
• Kong
  基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。 问题：只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。

1.2 gateway

Spring Cloud Gateway 基于Spring Boot 2.x、Spring WebFlux和Project Reactor，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代Netflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。基于Webflux中的reactor-netty响应式编程组件，底层使用了Netty通讯框架
特点：

1. 性能强劲：是Zuul的1.6倍
2. 功能强大：内置了很多实用的功能，例如转发、监控、限流等
3. 设计优雅，容易扩展

1.2.1 基本理解

路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息:

• id：路由标识、区别于其他route
• uri：路由指向的目的地uri，即客户端请求最终被转发到的微服务
• order：用于多个route之间的排序，数值越小排序越靠前，匹配优先级越高
• predicate：断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由
• filter：过滤器用于修改请求和响应信息

1.2.2 执行流程

1. Gateway Client向Gateway Server发送请求
2. 请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文
3. 然后网关的上下文会传递到DispatcherHandler，它负责将请求分发给RoutePredicateHandlerMapping
4. RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用
5. 如果断言成功，由FilteringWebHandler创建过滤器链并调用
6. 请求会一次经过PreFilter–微服务–PostFilter的方法，最终返回响应

1.2.3 核心流程解读

客户端向 Spring Cloud Gateway 发出请求。如果Gateway Handler Mapping确定请求与路由匹配，则将其发送到Gateway Web Handler 处理程序。此处理程序通过特定于请求的Fliter链运行请求。Fliter被虚线分隔的原因是Fliter可以在发送代理请求之前（pre）和之后（post）运行逻辑。执行所有pre过滤器逻辑。然后进行代理请求。发出代理请求后，将运行“post”过滤器逻辑。

过滤器作用：

• Filter在pre类型的过滤器可以做参数效验、权限效验、流量监控、日志输出、协议转换等。
• Filter在post类型的过滤器可以做响应内容、响应头的修改、日志输出、流量监控等
• 这两种类型的过滤器有着非常重要的作用

核心点

• Route（路由）
  路由是构建网关的基础模块，它由ID，目标URI，包括一些列的断言和过滤器组成，如果断言为true则匹配该路由
• Predicate（断言）
  参考的是Java8的java.util.function.Predicate，开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），请求与断言匹配则进行路由
• Filter（过滤）
  指的是Spring框架中GateWayFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。
• 三个核心点连起来：
  当用户发出请求到达GateWay，GateWay会通过一些匹配条件，定位到真正的服务节点，并在这个转发过程前后，进行一些及细化控制。其中Predicate就是我们匹配的条件，而Filter可以理解为一个拦截器，有了这两个点，再加上目标URI，就可以实现一个具体的路由了。

GateWay核心的流程就是：路由转发+执行过滤器链

二、 网关搭建

2.1 创建一个子模块。端口为9999

版本对应地址：https://spring.io/projects/spring-cloud

2.2 引入依赖

因为gateway是Spring cloud的，我们需要在父工程引入spring cloud的依赖

<!--spring cloud Hoxton.SR12-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-dependencies</artifactId>
    <version>${spring-cloud-gateway-varsion}</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

在我们的9999网关服务引入nacos和geteway依赖

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

配置yaml文件

server:  
  port: 9999  
spring:  
  application:  
    name: cloud-getway-service  
  cloud:  
    nacos:  
      discovery:  
        server-addr: localhost:8848  
    gateway:  
      discovery:  
        locator:  
          enabled: true #开启从注册中心动态创建路由的功能，利用微服务名进行路由  
      routes:  
        - id: nacos-payment-provider  
          uri: http://localhost:9001/nacos-payment-provider  
          predicates:  
            - Path=/test/**

启动Nacos服务，9999网关服务，9001服务，通过浏览器访问其他服务，效果如下：

2.3 网关配置路由的第二种方式

我们可以通过代码来配置网关
新建配置类，交由Spring管理

@Configuration  
public class TestGetWayConfig {  
  
    @Bean  
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {  
        return builder.routes()  
                .route("nacos-payment-provider", r -> r.path("/test/**").uri("http://localhost:9001/nacos-payment-provider"))  
                .route("nacos-payment-provider2", r -> r.path("/**").uri("http://localhost:9002/nacos-payment-provider2"))  
                .build();  
    }  
}

正常访问浏览器即可。

三、配置动态路由

1. gateway.discovery.locator.enabled: true 开启自动路由功能
2. routes中的uri其实最后是不需要服务名称的，这个位置其实只需要指定的localhost:9001即可
   自动路由规则：
3. discovery.locator.enabled: true 这个配置默认为false，但是如果为true，就是开启了通过serviceId转发到具体的服务实例。localhost:9999/ServiceID/test/
4. geteway开启了自动路由后自带负载均衡功能

手动配置负载均衡
uri: lb

server:
  port: 9999
spring:
  application:
    name: cloud-gateway-9999
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: true #开启自动路由功能(此时可以关闭)
      routes: # 路由
        - id: nacos-payment-provider #路由ID，没有固定要求，但是要保证唯一，建议配合服务名
          uri: lb://nacos-payment-provider # 匹配提供服务的路由地址
          predicates: # 断言
            - Path=/test/** 

四、断言Predicate

4.1 断言种类

1. After：匹配在指定日期时间之后发生的请求。
2. Before：匹配在指定日期之前发生的请求。
3. Between：需要指定两个日期参数，设定一个时间区间，匹配此时间区间内的请求。
4. Cookie：需要指定两个参数，分别为name和regexp（正则表达式），也可以理解Key和Value，匹配具有给定名称且其值与正则表达式匹配的Cookie。
5. Header：需要两个参数header和regexp（正则表达式），也可以理解为Key和Value，匹配请求携带信息。
6. Host：匹配当前请求是否来自于设置的主机。
7. Method：可以设置一个或多个参数，匹配HTTP请求，比如GET、POST
8. Path：匹配指定路径下的请求，可以是多个用逗号分隔
9. Query：需要指定一个或者多个参数，一个必须参数和一个可选的正则表达式，匹配请求中是否包含第一个参数，如果有两个参数，则匹配请求中第一个参数的值是否符合正则表达式。
10. RemoteAddr：匹配指定IP或IP段，符合条件转发。
11. Weight：需要两个参数group和weight（int），实现了路由权重功能，按照路由权重选择同一个分组中的路由

参考Spring官网案例：

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

五、Filter 过滤器

5.1 内置Filter

1. GateWay内置的Filter生命周期为两种：pre（业务逻辑之前）、post（业务逻辑之后）
2. GateWay本身自带的Filter分为两种： GateWayFilter（单一）、GlobalFilter（全局）
3. 单一的有32种，全局的有9
4. 官方网址：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters

5.2 自定义Filter

工作中最常用的就是自定义顾虑器

我们需要创建一个自定义过滤器类，实现Ordered, GlobalFilter

@Component
@Slf4j
public class MyFilter implements Ordered, GlobalFilter {
    /**
     * @param exchange 可以拿到对应的request和response
     * @param chain 过滤器链
     * @return 是否放行
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String username = exchange.getRequest().getQueryParams().getFirst("username");
        log.info("*************MyFilter:"+new Date());
        if(username == null){
            log.info("**********用户名为null，非法用户，请求被拒绝！");
            //如果username为空，返回状态码为406，不可接受的请求
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    /**
     * 加载过滤器的顺序
     * @return 整数数字越小优先级越高
     */
    @Override
    public int getOrder() {
        return 0;
    }
}

访问浏览器，如果我们的接口地址中没有携带username参数则拒绝访问，否则成功响应

如果对你有帮助，可以关注博主（不定期更新各种技术文档）
给博主一个免费的点赞以示鼓励，谢谢 ! 欢迎各位🔎点赞👍评论收藏⭐️