SpringCloud微服务-Gateway网关

2023-10-09 09:58:22

一、Gateway简介

（1）官网： https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/

（2）官网介绍：
Gateway是在Spring生态系统之上构建的API网关服务，基于Spring 5，Spring Boot 2和Project Reactor等技术。Gateway旨在提供一种简单而有效的方式来对API进行路由，以及提供一些强大的过滤器功能
例如︰熔断、限流、重试等

SpringCloud Gateway是Spring Cloud的一个全新项目，基于Spring 5.0+Spring Boot 2.0和Project Reactor等技术开发的网关，它旨在为微服务架构提供─种简单有效的统一的API路由管理方式。
I
SpringCloud Gateway作为Spring Cloud生态系统中的网关，目标是替代Zuul，在Spring Cloud 2.0以上版本中，没有对新版本的Zuul 2.0以上最新高性能版本进行集成，仍然还是使用的Zuul 1.x非Reactor模式的老版本。而为了提升网关的性能,

SpringCloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。

Spring Cloud Gateway的目标提供统一的路由方式且基于Filter链的方式提供了网关基本的功能，例如:安全，监控/指标，和限流。

Spring Cloud Gateway 使用的Webflux中的reactor-netty响应式编程组件，底层使用了Netty通讯框架

具体功能介绍：反向代理、鉴权、流量控制、熔断、日志监控…

（3）SpringCloud Gateway具有如下特性

基于Spring Framework 5，Project Reactor和 Spring Boot 2.0进行构建，动态路由，能够匹配任何请求属性

可以对路由指定 Predicate (断言）和Filter (过滤器），集成Hystrix的断路器功能

集成Spring Cloud 服务发现功能

易于编写的 Predicate (断言）和Filter (过滤器），请求限流功能

支持路径重写

（4）SpringCloud Gateway与Zuul的区别

在SpringCloud Finchley正式版之前，Spring Cloud 推荐的网关是 Netflix提供的Zuul
1、Zuul 1.x，是一个基于阻塞I/O的API Gateway
2、Zuul 1.x基于Servlet 2.5使用阻塞架构它不支持任何长连接(如WebSocket)Zuul的设计模式和Nginx较像，每次VО操作都是从工作线程中选择一个执行，请求线程被阻塞到工作线程完成，但是差别是Nginx用C++实现，Zuul用Java 实现，而JVM本身会有第一次加载较慢的情况，使得Zuul的性能相对较差。
3、Zuul 2.x理念更先进，想基于Netty非阻塞和支持长连接，但SpringCloud目前还没有整合。Zuul 2 x的性能较Zuul 1.x有较大提升。在性能方面，根据官方提供的基准测试,Spring Cloud Gateway的RPS(每秒请求数)是Zuul的1.6倍。
4、Spring Cloud Gateway建立在Spring Framework 5、Project Reactor和Spring Boot2之上，使用非阻塞API。
5、Spring Cloud Gateway还支持 WebSocket，并且与Spring紧密集成拥有更好的开发体验

（5）Gateway三大核心概念

Route（路由）：路由是构建网关的基本模块，它由ID，目标URI，一系列的断言和过滤器组成，如果断言为true则匹配该路由

Predicate（断言）：参考的是java8的java.util.function.Predicate开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由

Filter（过滤）：指的是Spring框架中GatewayFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。

SpringCloud微服务-Gateway网关

（6）Gateway工作流程
SpringCloud微服务-Gateway网关

客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到GatewayWeb Handler，Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。

过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”)或之后(“post")执行业务逻辑。Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等，在“post”类型的过滤器中可以做响应内容、响应头的修改，日志的输出，流量监控等有着非常重要的作用。

核心逻辑：路由转发+执行过滤器链

二、入门配置

（1）pom依赖

 <dependencies>
        <!--新增gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
       
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

（2）yml配置

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true  #开启从注册中心动态创建路由的功能，利用微服务名进行路由
      routes:
        - id: payment_routh #路由的ID，没有固定规则但要求唯一，建议配合服务名
#          uri: http://localhost:8001   #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service
          predicates:
            - Path=/payment/get/**   #断言,路径相匹配的进行路由


        - id: payment_routh2
#          uri: http://localhost:8001
          uri: lb://cloud-payment-service
          predicates:
            - Path=/payment/lb/**   #断言,路径相匹配的进行路由
#            - Header=X-Request-Id, \d+ #请求头中要有X-Request-Id属性并且值为整数的正则表达式
#            - Host=**.atguigu.com
#            - Method=GET
#            - Query=username, \d+ #要有参数名称并且是正整数才能路由
#            - Cookie=username,gaozhi  #curl http://localhost:9527/payment/lb --cookie "username=gaozhi"
#            - After=2021-09-27T11:11:50.233+08:00[Asia/Shanghai]  #定时生效，在某个时间之后生效
#            - Before=2021-09-27T12:11:50.233+08:00[Asia/Shanghai] #定时生效，在某个时间之前生效
#            - Between=2021-09-27T11:11:50.233+08:00[Asia/Shanghai],2021-09-27T11:12:50.233+08:00[Asia/Shanghai]  #某个时间段内生效，前面必须小于后面

（3）YML配置说明
Gateway网关路由有两种配置方式，一种是在配置文件yml中配置，见上面的配置，一种是在代码中注入RouteLocator的Bean，例子如下：

@Configuration
public class GateWayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder){
        RouteLocatorBuilder.Builder routes = builder.routes();
        routes.route("path_rote_atguigu", r -> r.path("/guonei").uri("http://news.baidu.com/guonei")).build();
        return routes.build();
    }

    @Bean
    public RouteLocator customRouteLocator2(RouteLocatorBuilder builder){
        return   builder.routes().route("path_rote_atguigu2", t -> t.path("/guoji").uri("http://news.baidu.com/guonei")).build();
    }

}

三、通过微服务名实现动态路由

默认情况下Gateway会根据注册中心的服务列表，以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由的功能，需要注意的是uri的协议为lb，表示启用Gateway的负载均衡功能。

yml配置，lb://serviceName是spring cloud gateway在微服务中自动为我们创建的负载均衡uri


spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true  #开启从注册中心动态创建路由的功能，利用微服务名进行路由
      routes:
        - id: payment_routh #路由的ID，没有固定规则但要求唯一，建议配合服务名
          #uri: http://localhost:8001   #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service
          predicates:
            - Path=/payment/get/**   #断言,路径相匹配的进行路由

        - id: payment_routh2
          #uri: http://localhost:8001   #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service
          predicates:
            - Path=/payment/lb/**   #断言,路径相匹配的进行路由

四、Predicate的使用

SpringCloud微服务-Gateway网关
1.After Route Predicate

  - After=2020-03-08T10:59:34.102+08:00[Asia/Shanghai]

2.Before Route Predicate

 - Before=2020-03-08T10:59:34.102+08:00[Asia/Shanghai]

3.Between Route Predicate

-Between=2020-03-08T10:59:34.102+08:00[Asia/Shanghai] ,  2020-03-08T10:59:34.102+08:00[Asia/Shanghai]

4.Cookie Route Predicate

 - Cookie=username,atguigu    #并且Cookie是username=zhangshuai才能访问

5.Header Route Predicate

- Header=X-Request-Id, \d+   #请求头中要有X-Request-Id属性并且值为整数的正则表达式

6.Host Route Predicate

  - Host=**.www.com

7.Method Route Predicate

- Method=GET

8.Path Route Predicate

- Path=/payment/lb/**   #断言,路径相匹配的进行路由

9.Query Route Predicate

  - Query=username, \d+ #要有参数名称并且是正整数才能路由

五、Filter的使用

GatewayFilter Factories
iRoute fites all w the moifcation of the inccming HiTP requestor outgoing HiTTPresponse in scome manner. Route fltes are scoped to a paricuar route.Spring Cloud:Gateway includes many built-in GatewayFilter Factories.NOTE For more detailed examples on how to use any of the following filters, take a look at the unit tests.

路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用。
Spring Cloud Gateway 内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生

Spring Cloud Gateway的Filter
1.生命周期：在业务逻辑之前-pre，在业务逻辑之后-post
2.种类：单一配置GatewayFilter，全局配置GlobalFilter

常用的GatewayFilter

AddRequestParameter
yml配置
SpringCloud微服务-Gateway网关

自定义过滤器

自定义全局GlobalFilter：全局日志记录，统一网关鉴权

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter,Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        log.info("*********come in MyLogGateWayFilter: "+new Date());
        String uname = exchange.getRequest().getQueryParams().getFirst("username");
        if(StringUtils.isEmpty(username)){
            log.info("*****用户名为Null 非法用户,(┬＿┬)");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);//给人家一个回应
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}
上一篇：如果还不懂如何使用 Consumer 接口，来公司我当面给你讲！


下一篇：Lamda表达式Expression>与Func