对于最新稳定版本,请使用 Spring Framework 7.0.6spring-doc.cadn.net.cn

协程

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

Spring Framework 在以下范围内提供对协程(Coroutines)的支持:spring-doc.cadn.net.cn

依赖项

当类路径中包含 kotlinx-coroutines-corekotlinx-coroutines-reactor 依赖项时,协程支持将被启用:spring-doc.cadn.net.cn

build.gradle.ktsspring-doc.cadn.net.cn

dependencies {

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

支持版本 1.4.0 及以上。spring-doc.cadn.net.cn

响应式如何转换为协程?

对于返回值,从响应式(Reactive)API 到协程(Coroutines)API 的转换如下所示:spring-doc.cadn.net.cn

  • fun handler(): Mono<Void> 变为 suspend fun handler()spring-doc.cadn.net.cn

  • fun handler(): Mono<T> 变为 suspend fun handler(): Tsuspend fun handler(): T?,具体取决于 Mono 是否可能为空(这样做的优势在于具有更强的静态类型安全性)spring-doc.cadn.net.cn

  • fun handler(): Flux<T> 变为 fun handler(): Flow<T>spring-doc.cadn.net.cn

对于输入参数:spring-doc.cadn.net.cn

  • 如果不需要延迟加载,fun handler(mono: Mono<T>) 就会变成 fun handler(value: T),因为挂起函数可以被调用来获取 value 参数。spring-doc.cadn.net.cn

  • 如果需要惰性求值,fun handler(mono: Mono<T>) 就变为 fun handler(supplier: suspend () → T)fun handler(supplier: suspend () → T?)spring-doc.cadn.net.cn

Flow 在协程世界中相当于 Flux,适用于热流或冷流、有限或无限流,主要区别如下:spring-doc.cadn.net.cn

阅读这篇关于使用 Spring、协程和 Kotlin Flow 实现响应式编程的博客文章, 以了解更多详情,包括如何使用协程并发运行代码。spring-doc.cadn.net.cn

控制器

这是一个协程(Coroutines)@RestController 的示例。spring-doc.cadn.net.cn

@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 进行视图渲染。spring-doc.cadn.net.cn

@Controller
class CoroutinesViewController(banner: Banner) {

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

WebFlux.fn

这是一个通过 coRouter { } DSL 定义的协程(Coroutines)路由及其相关处理器的示例。spring-doc.cadn.net.cn

@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>())
}

事务

协程(Coroutines)的事务支持通过 Spring Framework 5.2 起提供的响应式事务管理的编程式变体来实现。spring-doc.cadn.net.cn

对于挂起函数,提供了 TransactionalOperator.executeAndAwait 扩展。spring-doc.cadn.net.cn

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 扩展。spring-doc.cadn.net.cn

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
    }
}