Spring Cloud Gateway基于Spring Boot 2,是Spring Cloud的全新项目,该项目提供了一个构建在Spring 生态之上的API网关,包括:Spring 5,Spring Boot 2和Project Reactor。 Spring Cloud Gateway旨在提供一种简单而有效的途径来发送API,并为他们提供横切关注点,例如:安全性,监控/指标和弹性。
Spring Cloud Gateway的特征:
Zuul基于servlet 2.5(使用3.x),使用阻塞API。 它不支持任何长连接,如websockets。而Gateway建立在Spring Framework 5,Project Reactor和Spring Boot 2之上,使用非阻塞API。 Websockets得到支持,并且由于它与Spring紧密集成,所以将会是一个更好的开发体验。
示例启动两个服务:Gateway-Server和user-Server。模拟的场景是,客户端请求后端服务,网关提供后端服务的统一入口。后端的服务都注册到服务发现Consul。网关通过负载均衡转发到具体的后端服务。
用户服务注册到Consul上,并提供一个接口/test
。
需要的依赖如下:
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-consul-discoveryartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
spring:
application:
name: user-service
cloud:
consul:
host: 192.168.13.214
port: 8500
discovery:
ip-address: ${HOST_ADDRESS:localhost}
port: ${SERVER_PORT:${server.port}}
healthCheckPath: /health
healthCheckInterval: 15s
instance-id: user-${server.port}
service-name: user
server:
port: 8005
management:
security:
enabled: false
@SpringBootApplication
@RestController
@EnableDiscoveryClient
public class GatewayUserApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayUserApplication.class, args);
}
@GetMapping("/test")
public String test() {
return "ok";
}
}
网关服务提供多种路由配置、路由断言工厂和过滤器工厂等功能。
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-actuatorartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webfluxartifactId>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-gateway-coreartifactId>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-consul-discoveryartifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
exclusion>
exclusions>
dependency>
<dependency>
<groupId>org.jetbrains.kotlingroupId>
<artifactId>kotlin-stdlibartifactId>
<version>${kotlin.version}version>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.jetbrains.kotlingroupId>
<artifactId>kotlin-reflectartifactId>
<version>${kotlin.version}version>
<optional>trueoptional>
dependency>
如上引入了kotlin相关的依赖,这里需要支持kotlin的路由配置。Spring Cloud Gateway的使用需要排除web相关的配置,引入的是webflux的引用,应用启动时会检查,必须引入。
路由断言工厂有多种类型,根据请求的时间、host、路径、方法等等。如下定义的是一个基于路径的路由断言匹配。
@Bean
public RouterFunction<ServerResponse> testFunRouterFunction() {
RouterFunction<ServerResponse> route = RouterFunctions.route(
RequestPredicates.path("/testfun"),
request -> ServerResponse.ok().body(BodyInserters.fromObject("hello")));
return route;
}
当请求的路径为/testfun
时,直接返回ok的状态码,且响应体为hello
字符串。
网关经常需要对路由请求进行过滤,进行一些操作,如鉴权之后构造头部之类的,过滤的种类很多,如增加请求头、增加请求参数、增加响应头和断路器等等功能。
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder builder, ThrottleGatewayFilterFactory throttle) {
// @formatter:off
return builder.routes()
.route(r -> r.path("/image/webp")
.filters(f ->
f.addResponseHeader("X-AnotherHeader", "baz"))
.uri("http://httpbin.org:80")).build();
// @formatter:on
}
如上实现了当请求路径为/image/webp
时,将请求转发到http://httpbin.org:80
,并对响应进行过滤处理,增加响应的头部X-AnotherHeader: baz
。
上面属于API自定义路由,还可以通过配置进行定义:
spring:
cloud:
gateway:
locator:
enabled: true
default-filters:
- AddResponseHeader=X-Response-Default-Foo, Default-Bar
routes:
# =====================================
- id: default_path_to_http
uri: blueskykong.com
order: 10000
predicates:
- Path=/**
如上的配置定义了路由与过滤器。全局过滤器将所有的响应加上头部X-Response-Default-Foo: Default-Bar
。定义了id为default_path_to_http
的路由,只是优先级比较低,当该请求都不能匹配时,将会转发到blueskykong.com
。
Spring Cloud Gateway可以使用kotlin自定义路由:
@Configuration
class AdditionalRoutes {
@Bean
fun additionalRouteLocator(builder: RouteLocatorBuilder): RouteLocator = builder.routes {
route(id = "test-kotlin") {
path("/image/png")
filters {
addResponseHeader("X-TestHeader", "foobar")
}
uri("http://httpbin.org:80")
}
}
}
当请求的路径是/image/png
,将会转发到http://httpbin.org:80
,并设置了过滤器,在其响应头中加上了X-TestHeader: foobar
头部。
与服务注册于发现组件进行结合,通过serviceId转发到具体的服务实例。在前面的配置已经引入了相应的依赖。
@Bean
public RouteDefinitionLocator discoveryClientRouteDefinitionLocator(DiscoveryClient discoveryClient) {
return new DiscoveryClientRouteDefinitionLocator(discoveryClient);
}
将DiscoveryClient
注入到DiscoveryClientRouteDefinitionLocator
的构造函数中,关于该路由定义定位器,后面的源码分析会讲解,此处不展开。
spring:
cloud:
gateway:
locator:
enabled: true
default-filters:
- AddResponseHeader=X-Response-Default-Foo, Default-Bar
routes:
# =====================================
- id: service_to_user
uri: lb://user
order: 8000
predicates:
- Path=/user/**
filters:
- StripPrefix=1
上面的配置开启了DiscoveryClient
定位器的实现。路由定义了,所有请求路径以/user
开头的请求,都将会转发到user
服务,并应用路径的过滤器,截取掉路径的第一部分前缀。即访问/user/test
的实际请求转换成了lb://user/test
。
还可以配置websocket的网关路由:
spring:
cloud:
gateway:
default-filters:
- AddResponseHeader=X-Response-Default-Foo, Default-Bar
routes:
- id: websocket_test
uri: ws://localhost:9000
order: 9000
predicates:
- Path=/echo
启动一个ws服务端wscat --listen 9000
,将网关启动(网关端口为9090),进行客户端连接即可wscat --connect ws://localhost:9090/echo
。
展示访问用户服务的结果:
网关成功负载均衡到user-server,并返回了ok。响应的头部中包含了全局过滤器设置的头部X-Response-Default-Foo: Default-Bar
原文链接:https://juejin.im/post/5aa4eacbf265da237a4ca36f