协程

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

Spring框架在以下范围内支持协程

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

  • 在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),因为可以调用挂起函数来获取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进行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>())
}

事务

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