《深入浅出SpringCloud》Spring Cloud Gateway：API网关服务

原创

已于 2022-04-25 00:52:00 修改 · 527 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring cloud

于 2022-04-23 21:07:53 首次发布

本文详细介绍了Spring Cloud Gateway作为API网关的功能和特性，包括动态路由、断言Predicate和过滤器Filter的使用。通过Java Bean配置和YAML配置展示了如何创建API网关模块，讲解了After、Before、Between等Route Predicate的用法，并介绍了AddRequestParameter、StripPrefix等GatewayFilter的实践。同时，文章还讨论了Gateway与注册中心Eureka的整合，实现动态路由和过滤器的负载均衡功能。

新一代API网关服务

Spring Cloud Gateway 为 SpringBoot 应用提供了API网关支持，具有强大的智能路由与过滤器功能，本文将对其用法进行详细介绍。

Gateway 简介

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

Spring Cloud Gateway 特性：

基于Spring Framework 5, Project Reactor 和 Spring Boot 2.0 进行构建；
动态路由：能够匹配任何请求属性；
可以对路由指定 Predicate（断言）和 Filter（过滤器）；
集成Hystrix的断路器功能；
集成 Spring Cloud 服务发现功能；
易于编写的 Predicate（断言）和 Filter（过滤器）；
请求限流功能；
支持路径重写。

创建 api-gateway模块

这里我们创建一个api-gateway模块来演示Gateway的常用功能。

在pom.xml中添加相关依赖

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

两种不同的配置路由方式
Gateway 提供了两种不同的方式用于配置路由，一种是通过yml文件来配置，另一种是通过Java Bean来配置，下面我们分别介绍下。
使用yml配置

server:
  port: 8801
service-url:
  user-service: http://localhost:8201
spring:
  cloud:
    gateway:
      routes:
        - id: path_route #路由的ID
          uri: ${service-url.user-service}/user/{id} #匹配后路由地址
          predicates: # 断言，路径相匹配的进行路由
            - Path=/user/{id}

启动eureka-server，user-service和api-gateway服务，并调用该地址测试：http://localhost:9201/user/
我们发现该请求被路由到了user-service的该路径上：http://localhost:8001/user/1

使用Java Bean配置

添加相关配置类，并配置一个RouteLocator对象：

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("path_route2", r -> r.path("/user/getByUsername")
                        .uri("http://localhost:8201/user/getByUsername"))
                .build();
    }
}

重新启动api-gateway服务，并调用该地址测试：http://localhost:8801/user/getByUsername?username=yuan11
我们发现该请求被路由到了user-service的该路径上：http://localhost:8001/user/getByUsername?username=yuan11