协程

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

Spring 框架在以下范围内提供对协程的支持

  • DeferredFlow 返回值支持在 Spring MVC 和 WebFlux 注释的 @Controller

  • Spring MVC 和 WebFlux 注释的 @Controller 中的挂起函数支持

  • WebFlux 客户端服务器 函数式 API 的扩展。

  • WebFlux.fn coRouter { } DSL

  • WebFlux CoWebFilter

  • RSocket @MessageMapping 注释方法中的挂起函数和 Flow 支持

  • RSocketRequester 的扩展

  • Spring AOP

依赖项

kotlinx-coroutines-corekotlinx-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 及以上版本。

Reactive 如何转换为协程?

对于返回值,从 Reactive 到协程 API 的转换如下所示

  • fun handler(): Mono<Void> 变为 suspend fun handler()

  • fun handler(): Mono<T> 变为 suspend fun handler(): Tsuspend fun handler(): T?,具体取决于 Mono 是否可以为空(具有更静态类型的优势)

  • fun handler(): Flux<T> 变为 fun handler(): Flow<T>

对于输入参数

  • 如果不需要延迟,fun handler(mono: Mono<T>) 变为 fun handler(value: T),因为可以调用挂起函数来获取值参数。

  • 如果需要延迟,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 进行 Reactive 的博文,了解更多详细信息,包括如何使用协程并发运行代码。

控制器

以下是一个协程 @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>())
}

事务

协程上的事务通过从 Spring Framework 5.2 开始提供的 Reactive 事务管理的编程变体来支持。

对于挂起函数,提供了一个 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
    }
}