Spring Cloud Gateway 是 Spring 提供的一个 API 网关解决方案,它构建在 Spring 5、Spring Boot 2 以及 Project Reactor 和 Spring WebFlux 之上,旨在提供一个简单有效的方式进行路由和过滤。本文将带你从零开始,详细了解 Spring Cloud Gateway 的使用及其核心特性。
一、Spring Cloud Gateway 入门
1. 搭建项目
首先,我们需要创建一个 Spring Boot 项目,并引入 Spring Cloud Gateway 依赖。在 pom.xml 文件中添加如下依赖:
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Hoxton.SR6</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
2. 配置路由
在 application.yml 文件中配置路由规则:
spring:
cloud:
gateway:
routes:
- id: example-route
uri: http://httpbin.org:80
predicates:
- Path=/get
在上面的配置中,example-route 定义了一条简单的路由规则,匹配路径为 /get 的请求会被转发到 http://httpbin.org:80。
3. 启动应用
编写一个简单的启动类:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
启动应用后,访问 http://localhost:8080/get,你将会看到 httpbin 的 /get 接口的返回结果。
二、核心功能
1. 路由断言(Predicates)
Predicates 用于匹配请求。Spring Cloud Gateway 提供了多种断言方式:
- Path 路径断言
predicates:
- Path=/get
- Host 主机断言
predicates:
- Host=*.example.com
- Header 请求头断言
predicates:
- Header=X-Request-Id, \d+
2. 路由过滤器(Filters)
Filters 用于在请求进入和离开路由之前进行处理。Spring Cloud Gateway 提供了多种内置过滤器,并支持自定义过滤器。
- AddRequestHeader 添加请求头
filters:
- AddRequestHeader=X-Request-Id, 123
- RewritePath 重写路径
filters:
- RewritePath=/old-path/(?<segment>.*), /new-path/${segment}
三、自定义过滤器
除了内置过滤器外,我们还可以创建自定义过滤器:
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.http.HttpHeaders;
import reactor.core.publisher.Mono;
public class CustomFilter extends AbstractGatewayFilterFactory<CustomFilter.Config> {
public static class Config {
// 配置属性
}
public CustomFilter() {
super(Config.class);
}
@Override
public GatewayFilter apply(Config config) {
return (exchange, chain) -> {
// 自定义逻辑
HttpHeaders headers = exchange.getRequest().getHeaders();
// 打印请求头信息
headers.forEach((key, value) -> System.out.println(key + ":" + value));
return chain.filter(exchange);
};
}
}
注册自定义过滤器:
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class GatewayConfig {
@Bean
public CustomFilter customFilter() {
return new CustomFilter();
}
}
在配置文件中使用自定义过滤器:
spring:
cloud:
gateway:
routes:
- id: custom-filter-route
uri: http://httpbin.org:80
predicates:
- Path=/custom
filters:
- name: CustomFilter
四、Hystrix 熔断器
Spring Cloud Gateway 集成了 Hystrix 熔断器,可以防止服务雪崩效应:
filters:
- name: Hystrix
args:
name: myCommand
fallbackUri: forward:/fallback
定义一个简单的 Fallback 控制器:
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class FallbackController {
@GetMapping("/fallback")
public String fallback() {
return "This is a fallback response";
}
}
五、小结
通过本文的介绍,你已经了解了如何在 Spring Cloud Gateway 中配置路由、使用断言和过滤器,并创建自定义过滤器。Spring Cloud Gateway 提供了强大的功能和灵活的配置,使得微服务架构中的 API 管理变得更加高效和简单。
希望这篇指南对你有所帮助,如果有任何疑问或建议,欢迎在评论区留言分享!
更多推荐:
- Spring Cloud 微服务架构设计与实践
- 实战 Hystrix:从入门到进阶
- 使用 Spring Boot 和 Spring Cloud 构建高性能系统
持续关注,掌握最新技术动态,成为微服务架构大师!