1. 概述
本文主要分享如何使用 Kotlin 实现自定义 RouteLocator。
😈 由于笔者暂时不了解 Kotlin ,也比较懒,暂时不准备了解 Kotlin ,所以本文很大可能性是 "一本正经的胡说八道"
。
2. RouteLocatorDsl
org.springframework.cloud.gateway.route.RouteLocatorDsl
,使用 Kotlin 实现自定义 RouteLocator 。我们先打开 GatewayDsl.kt ,大体浏览一下。
下面我们来看一段示例程序,我们会把 GatewayDsl.kt 的代码实现嵌入其中。代码如下 :
import org.springframework.cloud.gateway.filter.factory.GatewayFilters.addResponseHeader
import org.springframework.cloud.gateway.handler.predicate.RoutePredicates.host
import org.springframework.cloud.gateway.handler.predicate.RoutePredicates.path
import org.springframework.cloud.gateway.route.RouteLocator
import org.springframework.cloud.gateway.route.gateway
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
1: @Configuration
2: class AdditionalRoutes {
3:
4: @Bean
5: fun additionalRouteLocator(): RouteLocator = gateway {
6: route(id = "test-kotlin") {
7: uri("http://httpbin.org:80") // Route.Builder#uri(uri)
8: predicate(host("kotlin.abc.org") and path("/image/png")) // Route.Builder#predicate(predicate)
9: add(addResponseHeader("X-TestHeader", "foobar")) // Route.Builder#add(webFilter)
10: }
11: }
12:
13: }
- 调用
#gateway(...)
方法,创建自定义的 RouteLocator 。代码如下 :
// GatewayDsl.kt
fun gateway(routeLocator: RouteLocatorDsl.() -> Unit) = RouteLocatorDsl().apply(routeLocator).build()
- 第 6 至 10 行 :调用
RouteLocatorDsl#route(...)
方法,配置一个 Route 。代码如下 :
// GatewayDsl.kt
private val routes = mutableListOf<Route>()
/**
* DSL to add a route to the [RouteLocator]
*
* @see [Route.Builder]
*/
fun route(id: String? = null, order: Int = 0, uri: String? = null, init: Route.Builder.() -> Unit) {
val builder = Route.builder()
if (uri != null) {
builder.uri(uri)
}
routes += builder.id(id).order(order).apply(init).build()
}
-
第 7 行 :调用
Route.Builder#uri(uri)
方法,设置uri
。 -
第 8 行 :调用
Route.Builder#predicate(predicate)
方法,设置predicates
。- 使用 RoutePredicates 创建每个 Route 的 Predicate 。
-
and
/or
操作符,代码如下 :
// GatewayDsl.kt
/**
* A helper to return a composed [Predicate] that tests against this [Predicate] AND the [other] predicate
*/
infix fun <T> Predicate<T>.and(other: Predicate<T>) = this.and(other)
/**
* A helper to return a composed [Predicate] that tests against this [Predicate] OR the [other] predicate
*/
infix fun <T> Predicate<T>.or(other: Predicate<T>) = this.or(other)
第 9 行 :调用 Route.Builder#add(webFilter)
方法,添加 filters
。
- 使用 GatewayFilters 创建每个 Route 的 GatewayFilter 。