kotlinx.coroutines README

The project's README from github.com/Kotlin/kotlinx.coroutines. As one markdown file: README.md.

kotlinx.coroutines

Kotlin Stable JetBrains official project GitHub license Download Kotlin KDoc link Slack channel

Library support for Kotlin coroutines with multiplatform support. This is a companion version for the Kotlin 2.2.20 release.

suspend fun main() = coroutineScope {
    launch { 
       delay(1.seconds)
       println("Kotlin Coroutines World!") 
    }
    println("Hello")
}

Play with coroutines online here

Modules

Documentation

Using in your projects

Maven

Add dependencies (you can also add other modules that you need):

<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>kotlinx-coroutines-core</artifactId>
    <version>1.11.0</version>
</dependency>

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>2.2.20</kotlin.version>
</properties>

Gradle

Add dependencies (you can also add other modules that you need):

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.11.0")
}

And make sure that you use the latest Kotlin version:

plugins {
    // For build.gradle.kts (Kotlin DSL)
    kotlin("jvm") version "2.2.20"
    
    // For build.gradle (Groovy DSL)
    id "org.jetbrains.kotlin.jvm" version "2.2.20"
}

Make sure that you have mavenCentral() in the list of repositories:

repositories {
    mavenCentral()
}

Android

Add kotlinx-coroutines-android module as a dependency when using kotlinx.coroutines on Android:

implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.11.0")

This gives you access to the Android Dispatchers.Main coroutine dispatcher and also makes sure that in case of a crashed coroutine with an unhandled exception that this exception is logged before crashing the Android application, similarly to the way uncaught exceptions in threads are handled by the Android runtime.

R8 and ProGuard

R8 and ProGuard rules are bundled into the kotlinx-coroutines-android module. For more details see "Optimization" section for Android.

Avoiding including the debug infrastructure in the resulting APK

The kotlinx-coroutines-core artifact contains a resource file that is not required for the coroutines to operate normally and is only used by the debugger. To exclude it at no loss of functionality, add the following snippet to the android block in your Gradle file for the application subproject:

packagingOptions {
    resources.excludes += "DebugProbesKt.bin"
}

Multiplatform

Core modules of kotlinx.coroutines are also available for Kotlin/JS and Kotlin/Native.

In common code that should get compiled for different platforms, you can add a dependency to kotlinx-coroutines-core right to the commonMain source set:

commonMain {
    dependencies {
        implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.11.0")
    }
}

Platform-specific dependencies are recommended to be used only for non-multiplatform projects that are compiled only for target platform.

JS

Kotlin/JS version of kotlinx.coroutines is published as kotlinx-coroutines-core-js (follow the link to get the dependency declaration snippet).

Native

Kotlin/Native version of kotlinx.coroutines is published as kotlinx-coroutines-core-$platform where $platform is the target Kotlin/Native platform. Targets are provided in accordance with official K/N target support.

Building and Contributing

See Contributing Guidelines.

kotlinx.coroutines (Kotlin/kotlinx.coroutines)

Searching Database…

13.8K ·GitHub
Kotlinx.coroutines
Что это?kotlinx.coroutines — официальная библиотека Kotlin для написания асинхронного неблокирующего кода с помощью корутин, с поддержкой мультиплатформы для JVM, JS, Native и Wasm.
Это фреймворк или библиотека?Это библиотека, которую вы добавляете как зависимость, а не фреймворк: она предоставляет билдеры вроде launch и async, Flow, каналы и диспетчеры, которые вы вызываете из своего кода.
Как добавить это в проект?Добавьте зависимость kotlinx-coroutines-core через Gradle или Maven, убедившись, что вы используете последнюю версию Kotlin и что в ваших репозиториях есть mavenCentral(); для мультиплатформенных проектов добавьте её в исходный набор commonMain.
Какие модули нужны для конкретной платформы?На Android добавьте kotlinx-coroutines-android для диспетчера Main; на JS и Native она публикуется как kotlinx-coroutines-core-js или в виде артефактов Native под каждую целевую платформу; у инструментов для интерфейсов вроде JavaFX и Swing есть собственные модули ui.
Есть ли подводные камни при использовании на Android с R8/ProGuard?Правила R8/ProGuard входят в kotlinx-coroutines-android, но основной артефакт также содержит файл ресурсов только для отладки, который можно удалить из APK с помощью фрагмента Gradle, чтобы не раздувать приложение.
Есть ли интеграция с реактивными библиотеками вроде RxJava?Да, реактивный модуль предоставляет билдеры и поддержку итераций для Reactive Streams, RxJava 2.x/3.x, Project Reactor и JDK 9 Flow.
Могу ли я протестировать код с корутинами с помощью этой библиотеки?Да, модуль test предоставляет runTest и TestScope для тестирования функций suspend, а также Dispatchers.setMain для переопределения диспетчера Main в тестах.
Есть ли инструмент для отладки корутин?Да, модуль debug предоставляет API DebugProbes для отслеживания, вывода и дампа активных корутин, а также правило тестов CoroutinesTimeout и интеграцию с BlockHound.
Что такое Flow в этой библиотеке?Flow — это холодный асинхронный тип потока в kotlinx.coroutines, который создаётся с помощью билдера flow и полного набора операторов, таких как filter и map.
What are similar projects?compose-multiplatform, swoole-src, vert.x, ktor, RxJava, topcoat, Android-Universal-Image-Loader, pglite
Which topics is it in?coroutines, multi-platform, reactive, concurrency, async, kotlin, wasm, java, database, android, server, library
Creator
Kotlin
Size
43 MB
Stars
13.8K
Updated
CommitOct 16Release1.11.0May 08
Age
10y
Commits · 90 Days