Корутина

Непросто подобрать описание, что такое корутина. В самом начале обычно рассматривается такой простой пример:

launch {
    delay(1000L)
    println("World!")
}

Этот и последующие несколько примеров выдернуты из контекста и не будут работать без дополнительного кода. Но в целях изучения теории они нам подходят. Практика будет позже.

Здесь launch - это билдер корутины, которому передается небольшой блок кода:

delay(1000L)
println("World!")

Мы еще рассмотрим очень подробно и по шагам, что происходит под капотом билдера. А пока что нам надо знать только то, что билдер упакует переданный ему блок кода в корутину и запустит ее. Если необходимо, то с помощью входных параметров мы можем указать билдеру, в каком потоке необходимо выполнить этот код.

 

Если очень упрощать, то можно сказать, что билдер - это экзекьютор, который оборачивает блок кода в Runnable и запускает этот Runnable на выполнение. Т.е. корутину можно представить так:

executor.submit {
    delay(1000L)
    println("World!")
}

Казалось бы, все, тему можно закрывать. Корутина - это просто очередной механизм для выполнения асинхронных операций. Но не все так просто.

Корутина имеет ряд особенностей. Например - Job. Когда мы запускаем корутину, мы можем получить Job, как результат запуска билдера:

val job = launch {
    delay(1000L)
    println("World!")
}

Это дает нам некоторые возможности по управлению корутиной. Мы можем сделать выполнение кода отложенным (LAZY) и стартовать его позже, когда понадобится. Или в любой момент времени можно будет отменить выполнение. Также можно запускать корутину внутри корутины. Их джобы будут связаны между собой отношениями Parent-Child, что является отдельным механизмом, который влияет на обработку ошибок и отмену корутин. Все это мы еще подробно рассмотрим в дальнейших уроках.

А пока что нас интересует одна из самых важных особенностей корутин - suspend функции.

 

 

Suspend функция

Чтобы лучше понять, что это такое, поговорим про потоки. Поток выполнения корутины - это вовсе не обязательно фоновый поток. Им вполне может быть и main поток. В Android мы часто будем запускать корутины в main потоке. И, как мы все знаем, этот поток нельзя блокировать.

В примере выше мы в корутине используем suspend функцию delay. Эта функция приостановит выполнение кода на 1000 мсек, затем выполнение кода продолжится и напишет в лог слово World. Вроде ничего не обычного. Но обратите внимание, я написал "приостановит выполнение кода", а не "заблокирует поток".

В этом и есть ключевая особенность suspend функции. Она не блочит поток. А значит мы можем эту корутину запускать в main потоке. Функция delay приостановит выполнение кода на 1 секунду, но не заблокирует main поток.

 

Давайте рассмотрим пример, более приближенный к реальности. Например, загрузка файла. 

Код без всяких корутин и suspend функций будет таким:

val url = buildUrl()

// long synchronous function
download(url)

toast("File is downloaded")

Мы генерируем URL файла и передаем его в функцию download, которая выполнит загрузку. После этого мы выводим Toast-сообщение о том, что файл загружен.

Функция download - синхронная, а значит заблокирует поток, в котором будет выполнена. Но нам хотелось бы выполнить этот код в UI потоке, потому что функция toast может быть выполнена только в нем. Чтобы разрешить это противоречие, нам придется сделать функцию download асинхронной и toast поместить в колбэк, который будет выполнен по завершении загрузки.

val url = buildUrl()

// long asynchronous function
download(url) {
    toast("File is downloaded")
}

 

Т.е. при запуске тяжелого кода в main потоке нам приходится выбирать из двух зол: блокировка потока или колбэк. Если функция download синхронна - то поток будет заблокирован. А если она асинхронна, то нам придется добавлять колбэк, чтобы выполнить последующий код.

А хорошо было бы сделать так, чтобы долго работающая функция не блокировала поток, но при этом код, который находится после функции, был выполнен по завершении загрузки без всяких колбэков. Использование suspend функций в корутинах позволяют нам сделать это.

Перепишем код с использованием корутины и suspend функции:

launch {
    val url = buildUrl()

    download(url) //suspend function

    toast("File is downloaded")
}

Эта корутина не заблокирует поток, в котором будет запущен ее код. Т.е. его можно запустить даже в main потоке. Функция download загрузит файл в отдельном потоке, а toast будет выполнен только после того, как download отработает. 

Это кажется магией, но не забывайте, что Kotlin код будет преобразован в Java классы. И во время этих преобразований будет использован механизм Continuation. Он в сочетании с suspend функциями реализует колбэк, который обеспечит выполнение toast только после того, как загрузка файла будет завершена.

О том, как именно это происходит, подробно поговорим в следующем уроке.

Корутина

В самом начале документации и статей обычно рассматривается такой простой пример:

launch {
    delay(1000L)
    println("World!")
}

Здесь launch - это билдер корутины, которому передается блок кода. Билдер упакует переданный ему блок кода в корутину и запустит ее. 

 

 

Когда мы запускаем корутину, мы можем получить Job, как результат запуска билдера:

val job = launch {
    delay(1000L)
    println("World!")
}

Это дает нам некоторые возможности по управлению корутиной. Например, мы можем сделать выполнение кода отложенным (lazy) и стартовать его позже, когда понадобится. Или в любой момент времени можно будет отменить выполнение. Также можно запускать корутину внутри корутины. Их джобы будут связаны между собой отношениями Parent-Child, что является отдельным механизмом, который влияет на обработку ошибок и отмену корутин.

 

 

Suspend функция

В примере выше мы в корутине используем suspend функцию delay. Эта функция приостановит выполнение кода на 1000 мсек, затем выполнение кода продолжится и напишет в лог слово World. При этом delay не заблокирует поток. В этом и есть ключевая особенность suspend функций. А значит мы можем эту корутину запускать в main потоке.

 

Давайте рассмотрим пример, более приближенный к реальности. Например, загрузка файла. 

Код без всяких корутин и suspend функций будет таким:

val url = buildUrl()

// long synchronous function
download(url)

toast("Url is downloaded")

Мы генерируем URL файла и передаем его в функцию download, которая выполнит загрузку. После этого мы выводим Toast-сообщение о том, что файл загружен.

 

Функция download - синхронная, а значит заблокирует поток, в котором будет выполнена. Но нам хотелось бы выполнить этот код в UI потоке, потому что функция toast может быть выполнена только в нем. Чтобы разрешить это противоречие, нам придется сделать функцию download асинхронной и toast поместить в колбэк, который будет выполнен по завершении загрузки.

val url = buildUrl()

// long asynchronous function
download(url) {
    toast("Url is downloaded")
}

 

Использование suspend функций в корутинах позволяют нам выполнять долгие асинхронные функции без колбэков:

launch {
    val url = buildUrl()

    download(url) //suspend function

    toast("Url is downloaded")
}

Эта корутина не заблокирует поток, в котором она будет запущена. А toast будет выполнен только после того, как download отработает. Это достигается с помощью механизма Continuation, который используется при преобразовании Kotlin кода в Java классы.

О том, как именно это происходит, подробно поговорим в следующем уроке.