Spring Cloud（4）Spring Cloud Gateway快速入门

最新推荐文章于 2024-07-31 08:35:25 发布

warybee

最新推荐文章于 2024-07-31 08:35:25 发布

阅读量118

点赞数 1

分类专栏： Spring Cloud 文章标签： spring cloud gateway

欢迎各位转载，转载请在文章页面中给出作者和原文链接！谢谢您配合

本文链接：https://blog.csdn.net/warybee/article/details/121310604

版权

Spring Cloud 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

本文目录

1 Gateway简介
- 1.2 Gateway核心概念
- 1.3 How It Works（ GateWay⼯作过程）
2 快速开始
3 GateWay动态路由
4 GateWay路由规则
5 GateWay过滤器
- 5.1 GateWayFilter
- 5.2 GlobalFilter

1 Gateway简介

Spring Cloud GateWay是Spring Cloud的⼀个全新项⽬，⽬标是取代Netflix Zuul，它基于Spring5.0+SpringBoot2.0+WebFlux（基于⾼性能的Reactor模式响应式通信框架Netty，异步⾮阻塞模型）等技术开发，性能⾼于Zuul，官⽅测试，GateWay是 Zuul的1.6倍，旨在为微服务架构提供⼀种简单有效的统⼀的API路由管理⽅式。

Spring Cloud GateWay不仅提供统⼀的路由⽅式（反向代理）并且基于 Filter(定义过滤器对请求过滤，完成⼀些功能) 链的⽅式提供了⽹关基本的功能，例如：鉴权、流量控制、熔断、路径重写、⽇志监控等

⽹关在架构中的位置

在这里插入图片描述

1.2 Gateway核心概念

⼀个请求到⽹关后根据⼀定的条件匹配路由，匹配成功之后可以将请求转发到指定的服务地址；⽽在这个过程中，我们可以进⾏⼀些⽐较具体的控制（限流、⽇志、⿊⽩名单）。

路由（route）：⽹关最基础的部分，也是⽹关⽐较基础的⼯作单元。路由由⼀个ID、⼀个⽬标URL（最终路由到的地址）、⼀系列的断⾔（匹配条件判断）和 Filter过滤器（精细化控制）组成。如果断⾔为true，则匹配该路由。
断⾔（predicates）：参考了Java8中的断⾔java.util.function.Predicate，开发⼈员可以匹配Http请求中的所有内容（包括请求头、请求参数等）（类似于 nginx中的location匹配⼀样），如果断⾔与请求相匹配则路由。
过滤器（filter）：⼀个标准的Spring webFilter，使⽤过滤器，可以在请求之前或者之后执⾏业务逻辑。

1.3 How It Works（ GateWay⼯作过程）

在这里插入图片描述

客户端向Spring Cloud GateWay发出请求，然后在GateWay Handler Mapping中找到与请求相匹配的路由，将其发送到GateWay Web Handler；
Handler再通过指定的过滤器链来将请求发送到我们实际的服务执⾏业务逻辑，然后返回。
过滤器之间⽤虚线分开是因为过滤器可能会在发送代理请求之前（pre）或者之后（post）执⾏业务逻辑。
Filter在“pre”类型过滤器中可以做参数校验、权限校验、流量监控、⽇志输出、协议转换等，在“post”类型的过滤器中可以做响应内容、响应头的修改、⽇志的输出、流量监控等。

2 快速开始

2.1 创建网关工程，并导入依赖

<?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.warybee</groupId>
    <artifactId>yyq-cloud-gateway-server</artifactId>
    <version>1.0-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.6</version>
    </parent>
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <spring-cloud.version>2020.0.4</spring-cloud.version>
    </properties>
    <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>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-commons</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </dependency>
        <!-- Actuator可以帮助你监控和管理Spring Boot应用-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.22</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.3</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.5.6</version>
            </plugin>
        </plugins>
    </build>
</project>

2.2 配置文件

server:
  port: 9001
spring:
  application:
    name: yyq-cloud-server-gateway
  cloud:
    gateway:
      routes: # 定义路由
       - id: order-service-router #路由ID，保持唯一
         uri: http://localhost:8091  #目标服务地址
         # 断言：路由条件，Predicate 接受一个输入参数，返回一个布尔值结果。
         # 这里使用Path请求路径类断言
         predicates:
           - Path=/order/**
       - id: resume-service-router
         uri: http://localhost:8092 
         predicates:
           - Path=/resume/**
eureka:
  client:
    service-url:
      defaultZone: http://192.168.98.135:8761/eureka/,http://192.168.98.136:8762/eureka/
  instance:
    prefer-ip-address: true
    #实例名称，
    #默认为：${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
    #可以自定义
    instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}:@project.version@

说明：

上面定义了两个路由order-service-router 和 resume-service-router

2.3 启动类

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class,args);
    }
}

3 GateWay动态路由

GateWay⽀持⾃动从注册中⼼中获取服务列表并访问，即所谓的动态路由

实现步骤如下

pom.xml中添加注册中⼼客户端依赖（在上面使用了eureka作为注册中心）

动态路由配置

动态路由设置时，uri以 lb: //开头，后面是需要转发到的微服务名称。

spring:
  application:
    name: yyq-cloud-server-gateway
  cloud:
    gateway:
      routes: # 定义路由
       - id: order-service-router #路由ID，保持唯一
         uri: lb://order-service  #动态路由，lb://后面是需要转发到的微服务名称
         # 断言：路由条件，Predicate 接受一个输入参数，返回一个布尔值结果。
         # 这里使用Path请求路径类断言
         predicates:
           - Path=/order/**
       - id: resume-service-router
         uri: lb://resume-service  #动态路由，lb://后面是需要转发到的微服务名称
         predicates:
           - Path=/resume/**

4 GateWay路由规则

Spring Cloud GateWay 帮我们内置了很多 Predicates功能，实现了各种路由匹配规则（通过 Header、请求参数等作为条件）匹配到对应的路由。

在这里插入图片描述

详细配置可以参考官网文档：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

5 GateWay过滤器

从过滤器⽣命周期（影响时机点）的⻆度来说，主要有两个pre和post：

pre：这种过滤器在请求被路由之前调⽤。我们可利⽤这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
这种过滤器在路由到微服务以后执⾏。这种过滤器可⽤来为响应添加标准的 HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

从过滤器类型的⻆度，Spring Cloud GateWay的过滤器分为GateWayFilter和 GlobalFilter两种

GateWayFilter：应⽤到单个路由路由上
GlobalFilter：应⽤到所有的路由上

5.1 GateWayFilter

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

GateWayFilter在实际项目中，用的不多。

具体可参考官网：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

5.2 GlobalFilter

⾃定义全局过滤器实现IP访问限制（⿊⽩名单）

请求过来时，判断发送请求的客户端的ip，如果在⿊名单中，拒绝访问⾃定义GateWay全局过滤器时，我们实现GlobalFilter接⼝即可，通过全局过滤器可以实现⿊⽩名单、限流等功能。

@Slf4j
@Component
public class BlackListFilter implements GlobalFilter, Ordered {


    private static List<String> blackList = new ArrayList<>();
    //模拟⿊名单（实际可以去数据库或者redis中查询）
    static {
        blackList.add("0:0:0:0:0:0:0:1"); // 模拟本机地址
    }

    /**
     * 过滤请求
     * @param exchange  封装了request和response对象的上下⽂
     * @param chain
     * @return
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 思路：获取客户端ip，判断是否在⿊名单中，在的话就拒绝访问，不在的话就放⾏
        // 从上下⽂中取出request和response对象
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();
        // 从request对象中获取客户端ip
        String clientIp =
                request.getRemoteAddress().getHostString();
        // 拿着clientIp去⿊名单中查询，存在的话就决绝访问
        if(blackList.contains(clientIp)) {
            // 决绝访问，返回
            response.setStatusCode(HttpStatus.UNAUTHORIZED); // 状态码
            log.debug("=====>IP:" + clientIp + " 在⿊名单中，将被拒绝访 问！");
                    String data = "Request be denied!";
            DataBuffer wrap =
                    response.bufferFactory().wrap(data.getBytes());
            return response.writeWith(Mono.just(wrap));
        }
        // 合法请求，放⾏，执⾏后续的过滤器
        return chain.filter(exchange);
    }

    /**
     * 返回值表示当前过滤器的顺序(优先级)，数值越⼩，优先级越⾼
     * @return
     */
    @Override
    public int getOrder() {
        return 0;
    }
}