摘要: 原创出处 http://www.iocoder.cn/Spring-Cloud-Gateway/route-locator-route-custom-kotlin/ 「芋道源码」欢迎转载，保留摘要，谢谢！

本文主要基于 Spring-Cloud-Gateway 2.0.X M4

阅读源码最好的方式，是使用 IDEA 进行调试 Spring Cloud Gateway 源码，不然会一脸懵逼。

1. 概述

本文主要分享如何使用 Kotlin 实现自定义 RouteLocator。

😈 由于笔者暂时不了解 Kotlin ，也比较懒，暂时不准备了解 Kotlin ，所以本文很大可能性是 "一本正经的胡说八道" 。

推荐 Spring Cloud 书籍：

• 请支持正版。下载盗版，等于主动编写低级 BUG 。

• 程序猿DD —— 《Spring Cloud微服务实战》

• 周立 —— 《Spring Cloud与Docker微服务架构实战》

• 两书齐买，京东包邮。

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

@Configuration
class AdditionalRoutes {

	@Bean
	fun additionalRouteLocator(): RouteLocator = gateway {
		route(id = "test-kotlin") {
			uri("http://httpbin.org:80") // Route.Builder#uri(uri)
			predicate(host("kotlin.abc.org") and path("/image/png")) // Route.Builder#predicate(predicate)
			add(addResponseHeader("X-TestHeader", "foobar")) // Route.Builder#add(webFilter)
		}
	}

}

• 调用 #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)

    • x

• 第 9 行 ：调用 Route.Builder#add(webFilter) 方法，添加 filters 。

  • 使用 GatewayFilters 创建每个 Route 的 GatewayFilter 。