suspend function: bu nədir, sintaksis və korutinlərdə işləməsi

Kotlin-də suspend function nədir?

Suspend function — suspend açar sözü ilə elan edilmiş, axını bloklamadan bir və ya bir neçə nöqtədə icranı dayandıra bilən funksiyadır. Digər suspend funksiyasının daxilində hər bir suspend funksiyası çağırışı potensial dayandırma nöqtəsidir.

suspend fun fetchUserData(): User {
    val response = httpClient.get("/user")
    return parser.parse(response)
}

Kotlin kompilyatoru belə bir funksiyanı state-maşınına çevirir. Hər bir dayandırma nöqtəsi (digər suspend funksiyasının çağırışı) state (label) olur. Cari axın state-lər arasında sərbəst buraxılır və gözlənilən əməliyyat bitdikdən sonra icra növbəti state-dən davam edir.

Yaranma tarixi

Suspend funksiyaları Kotlin 1.3-də (2018-ci il) korutinlərlə birlikdə eksperimental xüsusiyyət olaraq ortaya çıxdı və Kotlin 1.5-də (2021-ci il) stabil oldu. Bundan əvvəl Kotlin/Java-da asinxronluq callback-lər, RxJava və CompletableFuture vasitəsilə təmin edilirdi. Suspend funksiyaları xətti sintaksis və avtomatik axın idarəetməsi ilə alternativ təklif etdi.

Suspend funksiyaları necə işləyir: Continuation və state-maşını

Suspend funksiyalarının daxili quruluşunu başa düşmək korutinlərlə düzgün işin açarıdır. Adi funksiyalardan fərqli olaraq, hər bir suspend funksiyası Continuation interfeysi olan sinfə kompilyasiya olunur.

Continuation — gizli parametr

Kotlin kompilyatoru suspend funksiyasının hər bir parametrinin sonuna Continuation tipli parametr əlavə edir. Continuation aşağıdakıları ehtiva edir:

• context — CoroutineContext (dispetçer, job, kontekst elementləri)
• resumeWith — nəticə və ya istisna ilə icranı bərpa etmək metodu
• label — state-maşınında cari state-in indeksi

Nümunə ilə state-maşını

Tutaq ki, digər suspend funksiyalarına iki çağırışı olan suspend funksiyamız var:

suspend fun process() {
    val a = stepOne()
    val b = stepTwo(a)
    println(b)
}

Kompilyator onu etiketlərlə state-maşınına çevirir:

// Sadələşdirilmiş yaradılmış kod təsviri
fun process(cont: Continuation<Unit>): Any? {
    val cont = cont as ProcessContinuation
    when (cont.label) {
        0 -> {
            cont.label = 1
            if (stepOne(cont) == COROUTINE_SUSPENDED) return COROUTINE_SUSPENDED
        }
        1 -> {
            cont.label = 2
            val a = cont.result as TypeA
            if (stepTwo(a, cont) == COROUTINE_SUSPENDED) return COROUTINE_SUSPENDED
        }
        2 -> {
            println(cont.result)
            Unit
        }
    }
}

Əsas müşahidə: funksiya COROUTINE_SUSPENDED qaytararsa, cari axın sərbəst buraxılır. Asinxron əməliyyat bitdikdə Continuation.resumeWith çağırılır və state-maşını növbəti label-dən davam edir.

Suspend funksiyalarının sintaksisi: elan və çağırış

Suspend funksiyasının elanı adi funksiyadan fərqlənmir, yalnız fun-dən əvvəl suspend açar sözü əlavə olunur. Yalnız bir məhdudiyyət var: suspend funksiyasını yalnız korutindən və ya digər suspend funksiyasından çağırmaq olar.

Əsas elan

suspend fun delayAndReturn(ms: Long): String {
    delay(ms)
    return "Done after ${ms}ms"
}

Bu nümunədə delay də suspend funksiyasıdır, korutinanı axını bloklamadan müəyyən millisaniyə dayandırır. Gecikmədən sonra icra bərpa olunur.

Korutindən çağırış

fun main() = runBlocking {
    val result = delayAndReturn(1000)
    println(result)
}

runBlocking adi dünya ilə korutinlər arasında körpü yaradır. Lambda daxilində istənilən suspend funksiyasını çağırmaq mümkündür.

Suspend lambdaları və funksional tiplər

Kotlin funksional tiplərin suspend versiyalarını dəstəkləyir — suspend () -> T və suspend (A) -> B. Bu, asinxron lambdaları yüksək səviyyəli funksiyalara ötürməyə imkan verir:

suspend fun  withRetry(
    retries: Int = 3,
    block: suspend () -> T
): T {
    repeat(retries - 1) {
        try { return block() }
        catch (_: Exception) { delay(100) }
    }
    return block()
}

withRetry funksiyası suspend lambda qəbul edir və səhvlər zamanı onu təkrar icra edir. Bu, təkrar cəhdlərlə şəbəkə sorğuları üçün tipik nümunədir.

Suspend funksiyaları adi funksiyalardan nə ilə fərqlənir

Suspend və adi funksiyalar arasındakı fərqlər sadəcə modifikator əlavə etməkdən kənara çıxır. Əsas fərqləri nəzərdən keçirək.

Niyə suspend funksiyaları adi funksiyalardan çağrıla bilməz

Adi funksiyanın Continuation-ı yoxdur — vəziyyəti saxlamağa və icranı bərpa etməyə yeri yoxdur. Adi funksiyadan suspend funksiyasını çağırmaq lazımdırsa, runBlocking (testlər üçün) və ya CoroutineScope.launch (istehsalat üçün lifecycle nəzərə alınmaqla) istifadə edin.

Android-də suspend funksiyalarının nümunələri

Kotlin dilində Android tətbiqlərində suspend funksiyalarından istifadənin üç real ssenarisini nəzərdən keçirək.

Nümunə 1: Room DAO suspend sorğuları ilə

Room suspend funksiyalarını birbaşa dəstəkləyir — sorğu avtomatik olaraq fon axınında icra olunur:

@Dao
interface UserDao {
    @Query("SELECT * FROM users WHERE id = :id")
    suspend fun getUser(id: Int): User?

    @Insert
    suspend fun insertUser(user: User)
}

Room daxili olaraq sorğunun icrası üçün Dispatchers.IO istifadə edir və nəticə suspend funksiyasının çağırıldığı dispetçerə qaytarılır.

Nümunə 2: Ekran yükləməsi üçün suspend funksiyalarının kompozisiyası

class ProfileViewModel : ViewModel() {
    private val repo = ProfileRepository()

    fun loadProfile(id: String) {
        viewModelScope.launch {
            val profile = repo.getProfile(id)
            _profile.value = profile
        }
    }
}

ViewModelScope.launch korutin yaradır, onun daxilində getProfile suspend funksiyası çağırılır. Nəticə alındıqdan sonra UI əsas axında yenilənir.

Nümunə 3: Ardıcıl asinxron addımlar

suspend fun placeOrder(cart: Cart): OrderResult {
    val validated = validateCart(cart)
    val payment = processPayment(validated)
    val receipt = sendReceipt(payment)
    return receipt
}

Üç suspend funksiyası ardıcıl olaraq icra olunur. Hər addımda korutin axını bloklamadan dayana bilər. Əgər hansısa addım istisna atarsa — qalanları icra olunmur, bu da sifarişin yanlış vəziyyətlərindən qoruyur.

Suspend funksiyaları ilə işləyərkən tipik səhvlər

Hətta təcrübəli Kotlin proqramçıları suspend funksiyalarının layihələndirilməsində səhvlərə yol verirlər. Ən çox yayılanları nəzərdən keçirək.

Səhv 1: Suspend daxilində bloklayan çağırışlar

Suspend funksiyası kodu avtomatik olaraq asinxron etmir. Thread.sleep(), InputStream.read() və digər bloklayan çağırışlar yenə də axını bloklayacaq. Bloklayan əməliyyatları bükmək üçün withContext(Dispatchers.IO) istifadə edin.

Səhv 2: Ehtiyacsız suspend funksiyaları yaratmaq

Əgər funksiya digər suspend funksiyalarını çağırmırsa və asinxron əməliyyatlar yerinə yetirmirsə — suspend modifikatoru artıqdır. State-maşınına əlavə yük gətirir və çağırış kontekstini məhdudlaşdırır. Funksiyanı yalnız o zaman suspend edin ki, həqiqətən dayandırılır.

Səhv 3: CancellationException-ı görməməzlikdən gəlmək

Korutin ləğv edildikdə suspend funksiyaları CancellationException atır. Onu düşünmədən tutmayın — çağıran kodu ləğvi düzgün başa çatdırmaq imkanından məhrum edirsiniz. Finalizasiya əməliyyatı yerinə yetirmək lazımdırsa, finally bloku və NonCancellable istifadə edin.

suspend fun safeOperation() {
    try {
        doWork()
    } finally {
        withContext(NonCancellable) {
            cleanup()
        }
    }
}

finally bloku həmişə icra olunur, ləğv də daxil olmaqla, NonCancellable isə cleanup-ın kəsilməyəcəyini təmin edir.

Səhv 4: Suspend funksiyalarını callback-lərdən çağırmaq

Korutin yaratmadan callback-dən birbaşa suspend funksiyasını çağırmaq mümkün deyil. Callback üslubunu korutinlərə uyğunlaşdırmaq üçün suspendCoroutine və ya suspendCancellableCoroutine istifadə edin.