Gateway实战：SpringCloud-Gateway组件使用

女爷i 2022-09-08 11:49 196阅读 0赞

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

### 1.说明 ###

*  网关统一服务入口，可方便实现对平台众多服务接口进行管控，对访问服务的身份认证、防报文重放与防数据篡改、功能调用的业务鉴权、响应数据的脱敏、流量与并发控制，甚至基于API调用的计量或者计费等等。
 *  网关 = 路由转发 + 过滤器`路由转发：接收一切外界请求，转发到后端的微服务上去；`在服务网关中可以完成一系列的横切功能，例如权限校验、限流以及监控等，这些都可以通过过滤器完成

### 2.为什么需要网关 ###

*  1.网关可以实现服务的统一管理
 *  2.网关可以解决微服务中通用代码的冗余问题(如权限控制,流量监控,限流等)

### 3.网关组件在微服务中架构 ###

![fb028fd8103961b1adb803c6a3799a27.png][]

## 2.服务网关组件 ##

### 1.zuul ###

Zuul is the front door for all requests from devices and web sites to the backend of the Netflix streaming application. As an edge service application, Zuul is built to enable dynamic routing, monitoring, resiliency and security.

1.  原文翻译
    
     *  [https://github.com/Netflix/zuul/wiki][https_github.com_Netflix_zuul_wiki]
     *  zul是从设备和网站到Netflix流媒体应用程序后端的所有请求的前门。作为一个边缘服务应用程序，zul被构建为支持动态路由、监视、弹性和安全性。
2.  zuul版本说明
    
     *  目前zuul组件已经从1.0更新到2.0，但是作为springcloud官方不再推荐使用zuul2.0，但是依然支持zuul2.
3.  springcloud 官方集成zuul文档
    
     *  [https://cloud.spring.io/spring-cloud-netflix/2.2.x/reference/html/\#netflix-zuul-starter][https_cloud.spring.io_spring-cloud-netflix_2.2.x_reference_html_netflix-zuul-starter]

### 2.gateway ###

This project provides a library for building an API Gateway on top of Spring MVC. Spring Cloud Gateway aims to provide a simple, yet effective way to route to APIs and provide cross cutting concerns to them such as: security, monitoring/metrics, and resiliency.

1.  原文翻译
    
     *  [https://spring.io/projects/spring-cloud-gateway][https_spring.io_projects_spring-cloud-gateway]
     *  这个项目提供了一个在springmvc之上构建API网关的库。springcloudgateway旨在提供一种简单而有效的方法来路由到api，并为api提供横切关注点，比如：安全性、监控/度量和弹性。
2.  特性
    
     *  基于springboot2.x 和 spring webFlux 和 Reactor 构建 响应式异步非阻塞IO模型
     *  动态路由
     *  请求过滤

创建一个新的项目，根据之前写的环境搭建方式

## 3.开发网关动态路由 ##

*  网关配置有两种方式一种是快捷方式,一种是完全展开方式

### 1.创建项目引入网关依赖 ###

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

完整的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.2.5.RELEASE</version>
            <relativePath/> 
        </parent>
     
        <groupId>com.md</groupId>
        <artifactId>05-gateway8989</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>05-gateway8989</name>
        <description>Demo project for Spring Boot</description>
     
        <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Hoxton.SR6</spring-cloud.version>
        </properties>
     
        <dependencies>
           
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
     
            <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>
     
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-consul-discovery</artifactId>
            </dependency>
     
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
     
        </dependencies>
     
        
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
     
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
     
    </project>

### 2.编写网关配置 ###

spring:
      application:
        name: gateway
      cloud:
        consul:
          host: localhost
          port: 8500
          discovery:
            service-name: ${ spring.application.name}
        gateway:
          routes:
            - id: user_route    # 指定路由的唯一标识
              uri: http://localhost:9999/  # 指定路由服务的地址
              predicates:  # 指定路由的规则
                - Path=/user/**
     
            - id: product_route
              uri: http://localhost:9998/
              predicates:
                - Path=/product/**
     
    server:
      port: 8989

### 3.启动gateway网关项目 ###

*  直接启动报错:
    
    ![567e495b650b9d2de5e6fc5fa84a7b7a.png][]
 *  在启动日志中发现,gateway为了效率使用webflux进行异步非阻塞模型的实现,因此和原来的web包冲突,去掉原来的web即可

![0d708f2fd99e95a8f4600b85e8298c01.png][]

*  再次启动成功启动
    
    ![bb929162c6de105e044db341d6e61fc0.png][]

### 4.测试网关路由转发 ###

使用之前写的写的，可以看前面几篇文章

*  测试通过网关访问用户服务: [http://localhost:8989/user/findOne?productId=10001][http_localhost_8989_user_findOne_productId_10001]
 *  测试通过网关访问商品服务: [http://localhost:8989/product/findOne?productId=10002][http_localhost_8989_product_findOne_productId_10002]

![54ea5097d87dc133ba1f685a5496e280.png][]

**java方式配置路由(了解)**

环境还是和上面的一样

@Configuration
    public class GatewayConfig { 
        @Bean
        public RouteLocator customRouteLocator(RouteLocatorBuilder builder) { 
            return builder.routes()
                    .route("order_route", r -> r.path("/order/**")
                            .uri("http://localhost:9997/"))
                    .build();
        }
    }

## 4.查看网关路由规则列表 ##

### 1.说明 ###

*  gateway提供路由访问规则列表的web界面,但是默认是关闭的,如果想要查看服务路由规则可以在配置文件中开启

management:
      endpoints:
        web:
          exposure:
            include: "*"   #开启所有web端点暴露

访问路由管理列表地址

*  [http://localhost:8989/actuator/gateway/routes][http_localhost_8989_actuator_gateway_routes]

![ad4ba6924d4f18d073f46f33d425a47d.png][]

## 3.配置路由服务负载均衡 ##

### 1.说明 ###

*  现有路由配置方式,都是基于服务地址写死的路由转发,能不能根据服务名称进行路由转发同时实现负载均衡的呢?

### 2.动态路由以及负载均衡转发配置 ###

spring:
      application:
        name: gateway
      cloud:
        consul:
          host: localhost
          port: 8500
          discovery:
            service-name: ${ spring.application.name}
        gateway:
          routes:
            - id: user_route    # 指定路由的唯一标识
    # uri: http://localhost:9999/ # 指定路由服务的地址
     
              # lb代表转发后台服务使用负载均衡,users代表服务注册中心上的服务名
              uri: lb://users
              predicates:  # 指定路由的规则
                - Path=/user/**
     
            - id: product_route
    # uri: http://localhost:9998/
     
              # lb代表负载均衡转发路由,products代表服务注册中心上的服务名
              uri: lb://products
              predicates:
                - Path=/product/**
     
          # 开启根据服务名动态获取路由地址
          discovery:
            locator:
              enabled: true
     
    server:
      port: 8989
     
    #开启所有web端点暴露
    management:
      endpoints:
        web:
          exposure:
            include: "*"

![ca219a4873419b64c169869ad371f436.png][]

此时访问就实现了负载均衡的效果

## 4.常用路由predicate(断言,验证) ##

### 1.Gateway支持多种方式的predicate ###

![19d1c224b44aefe86f7795e5fa5023f8.png][]

After、Before、Between用于商城活动的时候指定日期才能访问

*  After=2020-12-21T11:33:33.993+08:00\[Asia/Shanghai\] \`指定日期之后的请求进行路由
 *  Before=2020-12-21T11:33:33.993+08:00\[Asia/Shanghai\] \`指定日期之前的请求进行路由
 *  Between=2017-01-20T17:42:47.789-07:00\[America/Denver\], 2017-01-21T17:42:47.789-07:00\[America/Denver\]
 *  Cookie=username,pony \`基于指定cookie的请求进行路由
 *  Cookie=username,\[A-Za-z0-9\]+ `基于指定cookie的请求进行路由`curl [http://localhost:8989/user/findAll][http_localhost_8989_user_findAll] \--cookie "username=zhangsan"
 *  Header=X-Request-Id, \\d+ \`\`基于请求头中的指定属性的正则匹配路由(这里全是整数)  
    \`curl [http://localhost:8989/user/findAll][http_localhost_8989_user_findAll] \-H "X-Request-Id:11"
 *  Method=GET,POST \`基于指定的请求方式请求进行路由
 *  官方更多: [https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.3.RELEASE/reference/html/\#the-cookie-route-predicate-factory][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.3.RELEASE_reference_html_the-cookie-route-predicate-factory]

### 2.使用predicate ###

spring:
      application:
        name: gateway
      cloud:
        gateway:
          routes:
            - id: product_route
              #uri: http://localhost:9998/
              uri: lb://products     # lb: 使用负载均衡策略 products代表注册中心的具体服务名
              predicates:
                - Path=/product/**
                #- After=2020-07-30T09:45:49.078+08:00[Asia/Shanghai]
              filters:
              # 为每个请求添加参数id=12
                - AddRequestParameter=id,12
              # 增加响应头 
                - AddResponseHeader=username,chenyn

![f3b9da41902faad48cb22889eea6540d.png][]

## 5.常用的Filter以及自定义filter ##

*  官网:[https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.3.RELEASE/reference/html/\#gatewayfilter-factories][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.3.RELEASE_reference_html_gatewayfilter-factories]
 *  路由过滤器允许以某种方式修改传入的HTTP请求或传出的HTTP响应。路由筛选器的作用域是特定路由。springcloudgateway包括许多内置的GatewayFilter工厂。

### 1.作用 ###

*  当我们有很多个服务时，比如下图中的user-service、order-service、product-service等服务，客户端请求各个服务的Api时，每个服务都需要做相同的事情，比如鉴权、限流、日志输出等。

![c2dabf7809ba064a1389ab269d9c69ed.png][]

![b719395a14be613a2c2269ff7b0b7a7e.png][]

### 2.使用内置过滤器 ###

![40eb2adaef7514768cf7c1be14c9cb2f.png][]

*  更多参加官网:[https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.3.RELEASE/reference/html/\#gatewayfilter-factories][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.3.RELEASE_reference_html_gatewayfilter-factories]
 *  使用方式如下:

### 3.使用自定义filter ###

@Configuration
    @Slf4j
    public class CustomGlobalFilter implements GlobalFilter, Ordered { 
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { 
            log.info("进入自定义的filter");
            if(exchange.getRequest().getQueryParams().get("username")!=null){ 
                log.info("用户身份信息合法,放行请求继续执行!!!");
                return chain.filter(exchange);
            }
            log.info("非法用户,拒绝访问!!!");
           return exchange.getResponse().setComplete();
        }
     
        @Override
        public int getOrder() {   //filter 数字越小filter越先执行
            return -1;           //-1 最先执行
        }
    }

**自定义全局filter**

![9a19611f44bc5ee0c7d99c4e272b1c1b.png][]

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

[fb028fd8103961b1adb803c6a3799a27.png]: /images/20220829/eb67a7b145cd410ebc4755ff965e1d0a.png
[https_github.com_Netflix_zuul_wiki]: https://github.com/Netflix/zuul/wiki
[https_cloud.spring.io_spring-cloud-netflix_2.2.x_reference_html_netflix-zuul-starter]: https://cloud.spring.io/spring-cloud-netflix/2.2.x/reference/html/#netflix-zuul-starter
[https_spring.io_projects_spring-cloud-gateway]: https://spring.io/projects/spring-cloud-gateway
[567e495b650b9d2de5e6fc5fa84a7b7a.png]: /images/20220829/057d6800618b4cf2987cb6acbd32d406.png
[0d708f2fd99e95a8f4600b85e8298c01.png]: /images/20220829/c8f3ed638a1b4596ab68054ec7e49f8e.png
[bb929162c6de105e044db341d6e61fc0.png]: /images/20220829/8b4117d799c242e5a566f14b373402f6.png
[http_localhost_8989_user_findOne_productId_10001]: http://localhost:8989/user/findOne?productId=10001
[http_localhost_8989_product_findOne_productId_10002]: http://localhost:8989/product/findOne?productId=10002
[54ea5097d87dc133ba1f685a5496e280.png]: /images/20220829/5219098f875547b687ebb4ab6d79fadf.png
[http_localhost_8989_actuator_gateway_routes]: http://localhost:8989/actuator/gateway/routes
[ad4ba6924d4f18d073f46f33d425a47d.png]: /images/20220829/137cea3374c642a9a963f36467e66bb6.png
[ca219a4873419b64c169869ad371f436.png]: /images/20220829/0c34f6dd27ee4e53ae74659976efe4bf.png
[19d1c224b44aefe86f7795e5fa5023f8.png]: /images/20220829/d88dbdbb6f6b45709002a96bfdd5967b.png
[http_localhost_8989_user_findAll]: http://localhost:8989/user/findAll
[https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.3.RELEASE_reference_html_the-cookie-route-predicate-factory]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.3.RELEASE/reference/html/#the-cookie-route-predicate-factory
[f3b9da41902faad48cb22889eea6540d.png]: /images/20220829/749dbe9e7d3644808d0fbfa8cb86b76b.png
[https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.3.RELEASE_reference_html_gatewayfilter-factories]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.3.RELEASE/reference/html/#gatewayfilter-factories
[c2dabf7809ba064a1389ab269d9c69ed.png]: /images/20220829/b1eabe4e50544300812d3187de30a101.png
[b719395a14be613a2c2269ff7b0b7a7e.png]: /images/20220829/c4a1cb3d33394158ace89a3f80491ede.png
[40eb2adaef7514768cf7c1be14c9cb2f.png]: /images/20220829/8529980a5beb40da8b7b250049eaf3ae.png
[9a19611f44bc5ee0c7d99c4e272b1c1b.png]: /images/20220829/19ce57932150413d90af98d35461f3c6.png