SpringCloud Gateway基础应用

1.网关介绍

什么是网关
在微服务架构中，一个系统会被拆分为多个微服务。那么作为客户端要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。这样的话会产生很多问题，例如：
1. 客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
  1. 认证复杂，每个微服务都有独立认证
2. 存在跨域请求，在一定场景下处理相对复杂
为解决上面的问题所以引入了网关的概念：所谓的API网关，就是指系统的统一入口，提供内部服务的路由中转，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、路由转发、负载均衡、限流、降级与应用检测等功能。
网关对比

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，缺乏更易用的管控、配置方式。

总结：zuul1.x、zuul2.x、gateway属于业务网关；nginx属于流量网关

2.Gateway介绍

基本介绍
Spring Cloud Gateway 基于Spring Boot 2.x、Spring WebFlux和Project Reactor，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代Netflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。

特点：
1. 性能强劲：是Zuul的1.6倍
2. 功能强大：内置了很多实用的功能，例如转发、监控、限流等
3. 设计优雅，容易扩展
基本概念
路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息：
- id：路由标识、区别于其他route
- uri：路由指向的目的地uri，即客户端请求最终被转发到的微服务
- order：用于多个route之间的排序，数值越小排序越靠前，匹配优先级越高
- predicate：断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由
- filter：过滤器用于修改请求和响应信息
执行流程
1. Gateway Client向Gateway Server发送请求
2. 请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文
3. 然后网关的上下文会传递到DispatcherHandler，它负责将请求分发给RoutePredicateHandlerMapping
4. RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用
5. 如果过断言成功，由FilteringWebHandler创建过滤器链并调用
6. 请求会一次经过PreFilter--微服务--PostFilter的方法，最终返回响应
总结：SpringCloud GateWay使用的是Webflux中的reactor-netty响应式编程组件，底层使用了Netty通讯框架。

3.Gateway工作流程

核心流程图如下：

核心概念：客户端向 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核心的流程就是：路由转发+执行过滤器链

4.Gateway路由配置

第一个gateway程序，gateway-9999

因为GateWay属于SpringCloud的，所以导入对应依赖一定要注意版本关系：

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

注意：引入GateWay一定要删除spring-boot-starter-web依赖，否则会有冲突无法启动

pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>2.6.4</version>
  <relativePath/> <!-- lookup parent from repository -->
</parent>

<groupId>com.zt.studydemo</groupId>
<artifactId>gateway-9999</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>gateway-9999</name>
<description>gateway-9999</description>

<properties>
  <java.version>1.8</java.version>
</properties>

<dependencies>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
  </dependency>

  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-gateway</artifactId>
  </dependency>
</dependencies>

<build>
  <plugins>
      <plugin>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
  </plugins>
</build>

</project>

yml：

server:
 port: 9999

spring:
 application:
    name: gateway-service
 cloud:
    gateway:
      routes:
        - id: nacos-provider #路由ID，没有固定要求，但是要保证唯一，建议配合服务名
          uri: http://localhost:9001 # 匹配提供服务的路由地址
          predicates: # 断言
            - Path=/nacos-provider/** # 断言，路径相匹配进行路由
          filters:
            - StripPrefix=1
            # 表示去掉1个前缀,比如这里会把/nacos-provider/** 去掉nacos-provider变为/** 路由转发到目标地址
            # http://localhost:9999/nacos-provider/nacos-provider/nacosdemo
            # http://localhost:9999/nacos-provider/nacosdemo

测试：启动之前的nacos-9001服务，启动gateway-9999，访问http://localhost:9999/nacos-provider/nacosdemo

5.Gateway断言Predicate

Predicate（断言）：可以理解为当满足条件后才会进行转发，如果是多个条件那就是满足所有条件才会转发

断言种类：

After：匹配在指定日期时间之后发生的请求。

Before：匹配在指定日期之前发生的请求。

Between：需要指定两个日期参数，设定一个时间区间，匹配此时间区间内的请求。

Cookie：需要指定两个参数，分别为name和regexp（正则表达式），也可以理解Key和Value，匹配具有给定名称且其值与正则表达式匹配的Cookie。

Header：需要两个参数header和regexp（正则表达式），也可以理解为Key和Value，匹配请求携带信息。

Host：匹配当前请求是否来自于设置的主机。

Method：可以设置一个或多个参数，匹配HTTP请求，比如GET、POST

Path：匹配指定路径下的请求，可以是多个用逗号分隔

Query：需要指定一个或者多个参数，一个必须参数和一个可选的正则表达式，匹配请求中是否包含第一个参数，如果有两个参数，则匹配请求中第一个参数的值是否符合正则表达式。

RemoteAddr：匹配指定IP或IP段，符合条件转发。

Weight：需要两个参数group和weight（int），实现了路由权重功能，按照路由权重选择同一个分组中的路由

官网地址：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

6.Gateway路由配置

gateway路由配置有两种方式，一种是上面说的yml配置文件方式，还有一直是硬编码方式（不推荐使用）

硬编码方式：

 @Bean
 public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
     /*
     配置了一个id为path_test的路由规则，当访问地址http://localhost:9999/**
     就会转发到http://localhost:9001任何地址
      */
     // 构建多个路由routes
     RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
     // 具体路由地址
     routes.route("path_test", r -> r.path("/**").uri("http://localhost:9001")).build();
     // 返回所有路由规则
     return routes.build();
 }

测试：

7.Gateway负载均衡

自动负载均衡

需要配合注册中心来获取服务列表，实现自动路由功能，这里我们使用nacos

pom.xml增加如下配置：

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

<dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-loadbalancer</artifactId>
</dependency>

<dependencyManagement>
 <dependencies>
     <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-dependencies</artifactId>
         <version>2021.0.1</version>
         <type>pom</type>
         <scope>import</scope>
     </dependency>

     <dependency>
         <groupId>com.alibaba.cloud</groupId>
         <artifactId>spring-cloud-alibaba-dependencies</artifactId>
         <version>2.2.7.RELEASE</version>
         <type>pom</type>
         <scope>import</scope>
     </dependency>
 </dependencies>
</dependencyManagement>

yml：

server:
port: 9999

spring:
application:
 name: gateway-service
cloud:
 nacos:
   discovery:
     server-addr: 127.0.0.1:8848
 gateway:
   discovery:
     locator:
       enabled: true #是否与服务发现组件进行结合，通过serviceId转发到具体的服务实例。默认为false，设为true便开启通过服务中心的自动根据 serviceId（服务名） 创建路由的功能。

测试：在9001和9002切换

手动负载均衡

在以上的配置中其实是有问题的，问题在于会暴露服务名称并且太过于灵活，那么如果想解决的话，其实我们可以进行手动配置。

yml：

server:
port: 9999

spring:
application:
 name: gateway-service
cloud:
 nacos:
   discovery:
     server-addr: 127.0.0.1:8848
 gateway:
   routes:
        - id: nacos-provider #路由ID，没有固定要求，但是要保证唯一，建议配合服务名
          uri: lb://nacos-provider # 匹配提供服务的路由地址
          predicates: # 断言
            - Path=/nacos-provider/** # 断言，路径相匹配进行路由
          filters:
            - StripPrefix=1 
			# 表示去掉1个前缀,比如这里会把/nacos-provider/** 去掉nacos-provider变为/** 路由转发到目标地址
            # http://localhost:9999/nacos-provider/nacos-provider/nacosdemo
            # http://localhost:9999/nacos-provider/nacosdemo

测试：在9001和9002切换

8.Gateway的Filter

开发中可以通过filter实现日志，权限认证，限流，监控等功能。

路由过滤器允许以某种方式修改传入的 HTTP 请求或传出的 HTTP 响应。路由过滤器的范围是特定的路由。Spring Cloud Gateway 包含许多内置的 GatewayFilter 工厂。

内置Filter：

GateWay内置的Filter生命周期为两种：pre（业务逻辑之前）、post（业务逻辑之后），客户端的请求先经过“pre”类型的filter，然后将请求转发到具体的业务服务，比如上图中的user-service，收到业务服务的响应之后，再经过“post”类型的filter处理，最后返回响应到客户端

GateWay本身自带的Filter分为两种： GateWayFilter（单一）、GlobalFilter（全局）

单一的有32种，全局的有9种

官方网址：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters

自定义filter

要实现GateWay自定义过滤器，那么我们需要实现两个接口GlobalFilter和Ordered

创建MyFilter

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.util.Date;

@Component
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");
        System.out.println("*************MyFilter:" + new Date());
        if (username == null) {
            System.out.println("**********用户名为null，非法用户，请求被拒绝！");
//            如果username为空，返回状态码为406，不可接受的请求
//            指定特定的状态码
//            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
//            return exchange.getResponse().setComplete();

            DataBuffer dataBuffer = exchange.getResponse().bufferFactory().wrap("test".getBytes());
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            return exchange.getResponse().writeWith(Mono.just(dataBuffer));
        }
        return chain.filter(exchange);
    }

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

测试：

不带username：

带username：

通过gateway内置令牌桶实现限流

内置令牌桶+redis

引入依赖：

   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
   </dependency>

yml配置：

server:port: 9999spring:application:name: gateway-serviceredis:database: 0host: 127.0.0.1port: 6379password: 123456cloud:nacos:  discovery:    server-addr: 127.0.0.1:8848gateway:  routes:        - id: nacos-provider #路由ID，没有固定要求，但是要保证唯一，建议配合服务名          uri: lb://nacos-provider # 匹配提供服务的路由地址          predicates: # 断言            - Path=/nacos-provider/** # 断言，路径相匹配进行路由          filters:            - StripPrefix=1            - name: RequestRateLimiter              args:                key-resolver: '#{@userKeyResolver}' #限流依据的条件bean对象id                redis-rate-limiter.replenishRate: 1 #令牌桶每秒填充平均速率                redis-rate-limiter.burstCapacity: 3 #令牌桶总容量

定义RateLimitConfig：

import org.springframework.cloud.gateway.filter.ratelimit.KeyResolver;import org.springframework.context.annotation.Bean;import org.springframework.stereotype.Component;import reactor.core.publisher.Mono;@Componentpublic class RateLimitConfig {    @Bean    KeyResolver userKeyResolver() {        return exchange -> Mono.just(exchange.getRequest().getQueryParams().getFirst("user"));    }}

测试：一秒内多次请求http://127.0.0.1:9999/nacos-provider/nacosdemo?user=1 会出现如下限流效果：

posted @ 2022-05-21 12:14 ZT丶阅读(248) 评论(0) 编辑收藏举报

刷新页面返回顶部

Loading

SpringCloud Gateway基础应用

1.网关介绍

2.Gateway介绍

3.Gateway工作流程

4.Gateway路由配置

5.Gateway断言Predicate

6.Gateway路由配置

7.Gateway负载均衡

8.Gateway的Filter

公告