Spring Cloud：服务网关之Spring Cloud Gateway_spring-cloud-starter-gateway

目录

一、gateway网关简介

二、Gateway简易版

创建项目

 修改pom.xml

添加配置文件

 修改后的application.yml

三、Gateway增强版

加入nacos依赖

pom.xml

在主类上添加注解

修改配置文件application.yml

四、Gateway简化版

修改application.yml

五、断言

内置路由断言工厂

自定义路由断言工厂

一、gateway网关简介

Spring Cloud Gateway是Spring公司基于Spring 5.0，Spring Boot 2.0 和 Project Reactor 等技术 开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代 Netflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安 全，监控和限流。 优点：

• 性能强劲：是第一代网关Zuul的1.6倍

• 功能强大：内置了很多实用的功能，例如转发、监控、限流等

• 设计优雅，容易扩展

缺点：

• 其实现依赖Netty与WebFlux，不是传统的Servlet编程模型，学习成本高

• 不能将其部署在Tomcat、Jetty等Servlet容器里，只能打成jar包执行

• 需要Spring Boot 2.0及以上的版本，才支持

 使用前：

 这样的架构，会存在着诸多的问题：

• 客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性

• 认证复杂，每个服务都需要独立认证。

• 存在跨域请求，在一定场景下处理相对复杂。

上面的这些问题可以借助API网关来解决。 所谓的API网关，就是指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一服 务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证鉴权、监控、路由转发等等。

使用后：

在业界比较流行的网关，有下面这些：

• Ngnix+lua 使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用 lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本

• Kong 基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。 问题： 只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。

• Zuul Netflix开源的网关，功能丰富，使用JAVA开发，易于二次开发 问题：缺乏管控，无法动态配 置；依赖组件较多；处理Http请求依赖的是Web容器，性能不如Nginx

• Spring Cloud Gateway Spring公司为了替换Zuul而开发的网关服务，将在下面具体介绍。

注意：SpringCloud alibaba技术栈中并没有提供自己的网关，我们可以采用Spring Cloud Gateway 来做网关

二、Gateway简易版

创建一个名为api-gateway 的springboot项目

创建项目

 修改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">
 
 
    <parent>
        <artifactId>spcloud-shop</artifactId>
        <groupId>com.cdl</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
 
    <modelVersion>4.0.0</modelVersion>
    <artifactId>api-gateway</artifactId>
 
    <dependencies>
        <!--gateway 注意 此模式不能引入starter-web -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
 
    </dependencies>
</project>

添加配置文件

application.yml

server:
    port: 7000
spring:
    application:
        name: api-gateway
    cloud:
        gateway:
            routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
                - id: product_route # 当前路由的标识, 要求唯一
                  uri: https://csdn.net # 请求要转发到的地址
                  order: 1 # 路由的优先级,数字越小级别越高
                  predicates: # 断言(就是路由转发要满足的条件)
                      - Path=/csdn/** # 当请求路径满足Path指定的规则时,才进行路由转发
                  filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
                      - StripPrefix=1 # 转发之前去掉1层路径

对application.yml进行修改，以达到通过访问网关而路由到商品微服务

启动商品微服务：

 

 修改后的application.yml

server:
    port: 7000
spring:
    application:
        name: api-gateway
    cloud:
        gateway:
            routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
                - id: product_route # 当前路由的标识, 要求唯一
                  uri: http://localhost:8080/ # 请求要转发到的地址
                  order: 1 # 路由的优先级,数字越小级别越高
                  predicates: # 断言(就是路由转发要满足的条件)
                      - Path=/product-serv/** # 当请求路径满足Path指定的规则时,才进行路由转发
                  filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
                      - StripPrefix=1 # 转发之前去掉1层路径

启动网关服务的项目

 由此可见和访问商品微服务是一样的，可以对访问商品微服务做一定的隐藏，有一定的保护作用

三、Gateway增强版

通过网关访问内部微服务 同时具备负载均衡的效果

加入nacos依赖

<!--nacos客户端-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</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">
 
 
    <parent>
        <artifactId>spcloud-shop</artifactId>
        <groupId>com.cdl</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
 
    <modelVersion>4.0.0</modelVersion>
    <artifactId>api-gateway</artifactId>
 
    <dependencies>
        <!--gateway 注意 此模式不能引入starter-web -->
        <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>
 
    </dependencies>
</project>

在主类上添加注解

package com.cdl.apigateway;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
 
@SpringBootApplication
@EnableDiscoveryClient
public class ApiGatewayApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(ApiGatewayApplication.class, args);
    }
 
}

修改配置文件application.yml

server:
    port: 7000
spring:
    application:
        name: api-gateway
    cloud:
      nacos:
        discovery:
          server-addr: 127.0.0.1:8848
      gateway:
        routes:
          - id: product_route
            uri: lb://shop-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均衡策略 lb:loadbalance
            predicates:
              - Path=/product-serv/**
            filters:
              - StripPrefix=1
              - StripPrefix=1

运行两个不同商品微服务和网关微服务

每刷新一次 都是不同的端口号

 将端口号为8081的停止

页面还有内容

此时的端口号打印

 全是8080

四、Gateway简化版

可以开启动态的网关路由

修改application.yml

server:
    port: 7000
spring:
    application:
        name: api-gateway
    cloud:
      nacos:
        discovery:
          server-addr: 127.0.0.1:8848
      gateway:
        discovery:
          locator:
            enabled: true # 让gateway可以发现nacos中的微服务

访问：网关服务地址+微服务的name+接口地址

 每次刷新页面都是访问的不同端口号的商品微服务

五、断言

内置路由断言工厂

 打开spring的官网

Spring | Home

 找到所需要的内容

 都是从官网取下来的内容

SpringCloud Gateway包括许多内置的断言工厂，所有这些断言都与HTTP请求的不同属性匹配。具体 如下：

• 基于Datetime类型的断言工厂 此类型的断言根据时间做判断，主要有三个： AfterRoutePredicateFactory： 接收一个日期参数，判断请求日期是否晚于指定日期 BeforeRoutePredicateFactory： 接收一个日期参数，判断请求日期是否早于指定日期 BetweenRoutePredicateFactory： 接收两个日期参数，判断请求日期是否在指定时间段内

  -After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]

• 基于远程地址的断言工厂 RemoteAddrRoutePredicateFactory：接收一个IP地址段，判断请求主 机地址是否在地址段中

  -RemoteAddr=192.168.1.1/24

• 基于Cookie的断言工厂 CookieRoutePredicateFactory：接收两个参数，cookie 名字和一个正则表达式。 判断请求 cookie是否具有给定名称且值与正则表达式匹配。

  -Cookie=chocolate, ch.

• 基于Header的断言工厂 HeaderRoutePredicateFactory：接收两个参数，标题名称和正则表达式。 判断请求Header是否 具有给定名称且值与正则表达式匹配。

  -Header=X-Request-Id, \d+

• 基于Host的断言工厂 HostRoutePredicateFactory：接收一个参数，主机名模式。判断请求的Host是否满足匹配规则。

  -Host=.testhost.org

• 基于Method请求方法的断言工厂 MethodRoutePredicateFactory：接收一个参数，判断请求类型是否跟指定的类型匹配。

  -Method=GET

• 基于Path请求路径的断言工厂

  PathRoutePredicateFactory：接收一个参数，判断请求的URI部分是否满足路径规则。

  -Path=/foo/{segment}

• 基于Query请求参数的断言工厂 QueryRoutePredicateFactory ：接收两个参数，请求param和正则表达式， 判断请求参数是否具 有给定名称且值与正则表达式匹配。

  -Query=baz, ba.

• 基于路由权重的断言工厂 WeightRoutePredicateFactory：接收一个[组名,权重], 然后对于同一个组内的路由按照权重转发

  routes: -id: weight_route1 uri: host1 predicates: -Path=/product/ -Weight=group3, 1 -id: weight_route2 uri: host2 predicates: -Path=/product/** -Weight= group3, 9

给网关路由到商品微服务设立一个条件，满足条件成功路由，不满足则失败

 

自定义路由断言工厂

自定义一个断言工厂, 实现断言方法

package com.cdl.apigateway.predicates;
 
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils;
import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
 
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;
 
//这是一个自定义的路由断言工厂类,要求有两个
//1 名字必须是 配置+RoutePredicateFactory
//2 必须继承AbstractRoutePredicateFactory<配置类>
@Component
public class AgeRoutePredicateFactory extends AbstractRoutePredicateFactory<AgeRoutePredicateFactory.Config> {
    public AgeRoutePredicateFactory() {
        super(AgeRoutePredicateFactory.Config.class);
    }
 
    //用于从配置文件中获取参数值赋值到配置类中的属性上
    @Override
    public List<String> shortcutFieldOrder() {
         //这里的顺序要跟配置文件中的参数顺序一致
        return Arrays.asList("minAge", "maxAge");
    }
 
    //断言
    @Override
    public Predicate<ServerWebExchange> apply(AgeRoutePredicateFactory.Config
                                                      config) {
        return new Predicate<ServerWebExchange>() {
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                //从serverWebExchange获取传入的参数
                String ageStr =
                        serverWebExchange.getRequest().getQueryParams().getFirst("age");
                if (StringUtils.isNotEmpty(ageStr)) {
                    int age = Integer.parseInt(ageStr);
                    return age > config.getMinAge() && age < config.getMaxAge();
                }
                return true;
            }
        };
    }
    //配置类,用于接收配置文件中的对应参数
    @Data
    @NoArgsConstructor
    public static class Config {
        private int minAge;//18
        private int maxAge;//60
    }
}

pom中添加的配置

<?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">
 
 
    <parent>
        <artifactId>spcloud-shop</artifactId>
        <groupId>com.cdl</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
 
    <modelVersion>4.0.0</modelVersion>
    <artifactId>api-gateway</artifactId>
 
    <dependencies>
        <!--gateway 注意 此模式不能引入starter-web -->
        <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>
 
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.7</version>
        </dependency>
 
    </dependencies>
</project>

此时的项目

 因为该方法用的是jdk1.8的特性，但是我们此时是1.5的jdk

 <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

 将上述的配置添加到pom中之后，就不会报错了

 但是要使其他的微服务也是，就将此配置加到父工程中去

spcloud-shop

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
 
    <groupId>com.cdl</groupId>
    <artifactId>spcloud-shop</artifactId>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>shop-common</module>
        <module>shop-order</module>
        <module>shop-product</module>
        <module>shop-user</module>
         <module>api-gateway</module>
    </modules>
    <packaging>pom</packaging>
 
    <!--依赖版本的锁定-->
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.3.2.RELEASE</spring-boot.version>
        <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
        <spring-cloud-alibaba.version>2.2.6.RELEASE</spring-cloud-alibaba.version>
    </properties>
 
    <dependencyManagement>
        <dependencies>
            <!-- SpringBoot 依赖配置 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- Springcloud 依赖配置 -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- Springcloud alibaba 依赖配置 -->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
 
        </dependencies>
 
    </dependencyManagement>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
 
 
</project>

此时都变了

 配置application.yml

server:
    port: 7000
spring:
    application:
        name: api-gateway
    cloud:
      nacos:
        discovery:
          server-addr: 127.0.0.1:8848
      gateway:
        discovery:
          locator:
            enabled: true # 让gateway可以发现nacos中的微服务
        routes:
          - id: product_route
            uri: lb://shop-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均衡策略
            predicates:
              - Path=/product-serv/**
              - Age=18,60
            filters:
              - StripPrefix=1

运行