Spring Cloud Gateway 入门

### Spring Cloud Gateway 入门教程 #### 1. Spring Cloud Gateway 的基本概念 Spring Cloud Gateway 是基于 Spring Framework 5、Project Reactor 和 Spring Boot 2 构建的一个高性能网关框架，它提供了非阻塞式的 API 支持[^2]。作为微服务架构中的重要组成部分，它的主要功能是对 HTTP 请求进行路由转发并提供过滤能力。 #### 2. 工作原理概述 Spring Cloud Gateway 的工作流程可以分为以下几个部分： - **路由匹配**：通过预定义的路由规则来决定请求应该被发送到哪个目标服务。 - **过滤器执行**：在请求到达目标服务之前以及返回客户端之后，可以通过一系列的过滤器对请求和响应进行处理[^1]。 #### 3. 路由配置详解 路由是 Spring Cloud Gateway 中的核心概念之一，其配置通常包括以下几项： - `id`：唯一标识符用于区分不同的路由规则。 - `uri`：指定目标服务地址。 - `predicates`：一组断言函数用来判断当前请求是否满足条件。 - `filters`：应用在此路由上的过滤逻辑列表。 下面是一个简单的 YAML 配置例子展示如何设置一个基本路由： ```yaml spring: cloud: gateway: routes: - id: example_route uri: http://example.org predicates: - Path=/example/** filters: - AddRequestHeader=foo, bar ``` 上述代码片段展示了如何创建一条名为 `example_route` 的路径映射，并向所有符合条件的请求头添加键值对 `foo:bar`[^4]。 #### 4. 网关过滤器的作用与分类 网关过滤器允许开发者以特定的方式修改进入系统的 HTTP 请求或者离开系统的 HTTP 响应。按照作用范围划分，它们可分为局部过滤器(Local Filters)和全局过滤器(Global Filters)。其中前者仅应用于单一路由上而后者则影响整个应用程序内的每一个请求/回应周期。 #### 5. 自定义谓词(Predicate) 除了内置的标准外,Spring Cloud Gateway还支持用户自行扩展新的谓词类以便更灵活地控制流量行为模式[^5]。这使得我们可以针对特殊需求设计专属解决方案而不局限于现有选项集之内. --- ### 实践案例分享 假设我们需要实现这样一个场景——当访问 `/api/v1/users/{userId}` 接口时如果参数 userId 小于等于零就拒绝该次调用，则可通过如下方式完成: ```java @Bean public RouteLocator customRouteLocator(RouteLocatorBuilder builder){ return builder.routes() .route(r -> r.path("/api/v1/users/**") .and().args("userId", (arg)->Integer.parseInt(arg)<0 ) .filter((exchange, chain) -> ServerResponse.status(HttpStatus.BAD_REQUEST).build()) .uri("lb://USER-SERVICE")) .build(); } ``` 此段程序利用了复合型 Predicates 来组合多个简单条件形成复杂查询表达式的同时也引入了一个错误处理器 Filter 当检测失败时候立即中断链路并向外部反馈状态码信息。 ---

### Spring Cloud Gateway 入门教程与示例代码 Spring Cloud Gateway 是一个基于 Spring 5.0、Spring Boot 2.0 和 Project Reactor 技术栈开发的 API 网关工具，主要用于微服务架构中的路由管理和请求过滤等功能[^2]。 #### 创建 Spring Cloud Gateway 应用程序 以下是创建并运行一个简单的 Spring Cloud Gateway 示例的具体方法： --- #### 1. 添加 Maven 依赖项 在项目的 `pom.xml` 文件中引入 `spring-cloud-starter-gateway` 依赖项： ```xml <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> ``` 此依赖会自动导入所需的组件来支持 Spring Cloud Gateway 功能[^5]。 --- #### 2. 配置 application.yml 或 application.properties 通过 YAML 文件配置网关的基本参数以及路由规则。以下是一个基本的 YML 配置示例： ```yaml server: port: 8080 spring: cloud: gateway: routes: - id: example_route uri: http://localhost:8701/example-service predicates: - Path=/example/** filters: - AddRequestHeader=MyCustomHeader, MyValue ``` 上述配置说明如下： - **id**: 定义该路由的唯一标识符。 - **uri**: 指定目标服务的实际地址。 - **predicates**: 设置匹配条件，此处表示当路径以 `/example/` 开头时触发该路由[^3]。 - **filters**: 可选字段，用于自定义请求或响应的行为，比如添加 HTTP 请求头部信息。 --- #### 3. 编写启动类 编写主应用程序入口类，并启用服务发现功能（如果需要）。例如： ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; @SpringBootApplication @EnableDiscoveryClient // 如果要集成 Eureka 注册中心，则需开启此项 public class SpringCloudGatewayExampleApplication { public static void main(String[] args) { SpringApplication.run(SpringCloudGatewayExampleApplication.class, args); } } ``` 这里使用了 `@EnableDiscoveryClient` 注解以便让网关能够自动注册到服务中心（如 Eureka），从而实现动态路由的功能[^4]。 --- #### 运行测试 完成以上步骤后，启动应用并通过浏览器访问指定 URL 来验证是否成功转发至对应的服务端点。假设本地存在名为 `example-service` 的服务监听于端口 `8701` 上，则可以通过访问 `http://localhost:8080/example/somePath` 测试其效果。 --- ### 总结 本实例展示了如何利用 Spring Cloud Gateway 构建基础版 API 网关的过程，涵盖了必要的 POM 配置、YAML 参数设定及 Java 启动脚本等内容。此外还提及了一些高级特性，像 Predicate 表达式和 Filter 使用场景等知识点也有所涉及。