协程

Kotlin 协程是 Kotlin 的轻量级线程，允许以命令式方式编写非阻塞代码。在语言层面，挂起函数为异步操作提供了抽象，而在库层面，kotlinx.coroutines 提供了诸如 async { } 的函数和诸如 Flow 的类型。

Spring Framework 在以下范围提供协程支持

Spring MVC 和 WebFlux 带注解 @Controller 中的 Deferred 和 Flow 返回值支持
Spring MVC 和 WebFlux 带注解 @Controller 中的挂起函数支持
WebFlux 客户端和服务器函数式 API 的扩展。
WebFlux.fn coRouter { } DSL
WebFlux CoWebFilter
RSocket 带 @MessageMapping 注解方法中的挂起函数和 Flow 支持
RSocketRequester 的扩展
Spring AOP

依赖

当类路径中存在 kotlinx-coroutines-core 和 kotlinx-coroutines-reactor 依赖时，会启用协程支持

build.gradle.kts

dependencies {

	implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:${coroutinesVersion}")
	implementation("org.jetbrains.kotlinx:kotlinx-coroutines-reactor:${coroutinesVersion}")
}

支持版本 1.4.0 及以上。

响应式如何转换为协程？

对于返回值，从响应式 API 到协程 API 的转换如下

fun handler(): Mono<Void> 变为 suspend fun handler()
fun handler(): Mono<T> 变为 suspend fun handler(): T 或 suspend fun handler(): T?，这取决于 Mono 是否可以为空（优点是类型更加静态）
fun handler(): Flux<T> 变为 fun handler(): Flow<T>

对于输入参数

如果不需要惰性求值，fun handler(mono: Mono<T>) 变为 fun handler(value: T)，因为可以调用挂起函数来获取 value 参数。
如果需要惰性求值，fun handler(mono: Mono<T>) 变为 fun handler(supplier: suspend () → T) 或 fun handler(supplier: suspend () → T?)

Flow 是协程世界中 Flux 的等价物，适用于热流或冷流，有限流或无限流，主要区别如下

Flow 是基于推送的，而 Flux 是推拉混合的
通过挂起函数实现背压
Flow 只有一个挂起 collect 方法，运算符作为扩展实现
得益于协程，运算符易于实现
扩展允许向 Flow 添加自定义运算符
收集操作是挂起函数
map 运算符支持异步操作（无需使用 flatMap），因为它接受一个挂起函数参数

阅读这篇关于使用 Spring、协程和 Kotlin Flow 迈向响应式编程的博客文章，了解更多详细信息，包括如何使用协程并发运行代码。

控制器

这是一个协程 @RestController 的示例。

@RestController
class CoroutinesRestController(client: WebClient, banner: Banner) {

	@GetMapping("/suspend")
	suspend fun suspendingEndpoint(): Banner {
		delay(10)
		return banner
	}

	@GetMapping("/flow")
	fun flowEndpoint() = flow {
		delay(10)
		emit(banner)
		delay(10)
		emit(banner)
	}

	@GetMapping("/deferred")
	fun deferredEndpoint() = GlobalScope.async {
		delay(10)
		banner
	}

	@GetMapping("/sequential")
	suspend fun sequential(): List<Banner> {
		val banner1 = client
				.get()
				.uri("/suspend")
				.accept(MediaType.APPLICATION_JSON)
				.awaitExchange()
				.awaitBody<Banner>()
		val banner2 = client
				.get()
				.uri("/suspend")
				.accept(MediaType.APPLICATION_JSON)
				.awaitExchange()
				.awaitBody<Banner>()
		return listOf(banner1, banner2)
	}

	@GetMapping("/parallel")
	suspend fun parallel(): List<Banner> = coroutineScope {
		val deferredBanner1: Deferred<Banner> = async {
			client
					.get()
					.uri("/suspend")
					.accept(MediaType.APPLICATION_JSON)
					.awaitExchange()
					.awaitBody<Banner>()
		}
		val deferredBanner2: Deferred<Banner> = async {
			client
					.get()
					.uri("/suspend")
					.accept(MediaType.APPLICATION_JSON)
					.awaitExchange()
					.awaitBody<Banner>()
		}
		listOf(deferredBanner1.await(), deferredBanner2.await())
	}

	@GetMapping("/error")
	suspend fun error() {
		throw IllegalStateException()
	}

	@GetMapping("/cancel")
	suspend fun cancel() {
		throw CancellationException()
	}

}

使用 @Controller 进行视图渲染也受支持。

@Controller
class CoroutinesViewController(banner: Banner) {

	@GetMapping("/")
	suspend fun render(model: Model): String {
		delay(10)
		model["banner"] = banner
		return "index"
	}
}

WebFlux.fn

这是一个通过 coRouter { } DSL 定义的协程路由及其相关处理器的示例。

@Configuration
class RouterConfiguration {

	@Bean
	fun mainRouter(userHandler: UserHandler) = coRouter {
		GET("/", userHandler::listView)
		GET("/api/user", userHandler::listApi)
	}
}

class UserHandler(builder: WebClient.Builder) {

	private val client = builder.baseUrl("...").build()

	suspend fun listView(request: ServerRequest): ServerResponse =
			ServerResponse.ok().renderAndAwait("users", mapOf("users" to
			client.get().uri("...").awaitExchange().awaitBody<User>()))

	suspend fun listApi(request: ServerRequest): ServerResponse =
				ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).bodyAndAwait(
				client.get().uri("...").awaitExchange().awaitBody<User>())
}

事务

通过响应式事务管理的编程式变体支持协程上的事务。

对于挂起函数，提供了 TransactionalOperator.executeAndAwait 扩展。

import org.springframework.transaction.reactive.executeAndAwait

class PersonRepository(private val operator: TransactionalOperator) {

	suspend fun initDatabase() = operator.executeAndAwait {
		insertPerson1()
		insertPerson2()
	}

	private suspend fun insertPerson1() {
		// INSERT SQL statement
	}

	private suspend fun insertPerson2() {
		// INSERT SQL statement
	}
}

对于 Kotlin Flow，提供了 Flow<T>.transactional 扩展。

import org.springframework.transaction.reactive.transactional

class PersonRepository(private val operator: TransactionalOperator) {

	fun updatePeople() = findPeople().map(::updatePerson).transactional(operator)

	private fun findPeople(): Flow<Person> {
		// SELECT SQL statement
	}

	private suspend fun updatePerson(person: Person): Person {
		// UPDATE SQL statement
	}
}