Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amitshekhariitbhu/learn-kotlin-coroutines
Learn Kotlin Coroutines by real examples for Android
https://github.com/amitshekhariitbhu/learn-kotlin-coroutines
coroutines kotlin kotlin-android kotlin-coroutines
Last synced: 2 days ago
JSON representation
Learn Kotlin Coroutines by real examples for Android
- Host: GitHub
- URL: https://github.com/amitshekhariitbhu/learn-kotlin-coroutines
- Owner: amitshekhariitbhu
- License: apache-2.0
- Created: 2022-10-03T17:28:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T04:04:17.000Z (5 months ago)
- Last Synced: 2025-01-26T06:06:40.791Z (9 days ago)
- Topics: coroutines, kotlin, kotlin-android, kotlin-coroutines
- Language: Kotlin
- Homepage: https://outcomeschool.com/blog/kotlin-coroutines
- Size: 208 KB
- Stars: 409
- Watchers: 6
- Forks: 72
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Learn Kotlin Coroutines by real examples for Android
## About this project:
* This project is for someone who wants to get started with Kotlin Coroutines.
* I have tried to add the examples we implement in our Android project frequently.
## About me
Hi, I am Amit Shekhar, Co-Founder @ [Outcome School](https://outcomeschool.com) • IIT 2010-14 • I have taught and mentored many developers, and their efforts landed them high-paying tech jobs, helped many tech companies in solving their unique problems, and created many open-source libraries being used by top companies. I am passionate about sharing knowledge through open-source, blogs, and videos.
You can connect with me on:
- [Twitter](https://twitter.com/amitiitbhu)
- [YouTube](https://www.youtube.com/@amitshekhar)
- [LinkedIn](https://www.linkedin.com/in/amit-shekhar-iitbhu)
- [GitHub](https://github.com/amitshekhariitbhu)
## Steps to learn Kotlin Coroutines from this project
* Learn all the concepts of Kotlin Coroutines from this blog: **[Mastering Kotlin Coroutines](https://outcomeschool.com/blog/kotlin-coroutines)**
* Learn about the Suspending vs Blocking in Kotlin Coroutines: **[Suspending vs Blocking in Kotlin Coroutines](https://www.youtube.com/watch?v=V2lL_aJp17I)**
* Learn about the Launch vs Async in Kotlin Coroutines from here: **[Launch vs Async in Kotlin Coroutines](https://outcomeschool.com/blog/launch-vs-async-in-kotlin-coroutines)**
* Learn about the Dispatchers from here: **[Dispatchers in Kotlin Coroutines](https://outcomeschool.com/blog/dispatchers-in-kotlin-coroutines)**
* Learn about the `coroutineScope` vs `supervisorScope` from here: **[coroutinescope vs supervisorscope](https://outcomeschool.com/blog/coroutinescope-vs-supervisorscope)**
* Blog [suspend function in Kotlin Coroutines](https://outcomeschool.com/blog/suspend-function-in-kotlin-coroutines)
* Blog [Kotlin withContext vs Async-await](https://outcomeschool.com/blog/kotlin-withcontext-vs-async-await)
* Blog [CoroutineContext in Kotlin](https://outcomeschool.com/blog/coroutinecontext-in-kotlin)
* Blog [Callback to Coroutines in Kotlin](https://outcomeschool.com/blog/callback-to-coroutines-in-kotlin)
* Blog [Retrofit with Kotlin Coroutines](https://outcomeschool.com/blog/retrofit-with-kotlin-coroutines)
* Blog [Parallel Multiple Network Calls Using Kotlin Coroutines](https://outcomeschool.com/blog/parallel-multiple-network-calls-using-kotlin-coroutines)
* Blog [Room Database with Kotlin Coroutines](https://outcomeschool.com/blog/room-database-with-kotlin-coroutines)
* Blog [Unit Testing ViewModel with Kotlin Coroutines and LiveData](https://outcomeschool.com/blog/unit-testing-viewmodel-with-kotlin-coroutines-and-livedata)
* Then, just clone, build, run the project and start learning Kotlin Coroutines by examples.
## You will learn the following from this Learn Kotlin Coroutines project:
* Step by step guide on how to implement the Kotlin Coroutines in Android.
* Doing simple task in background using Kotlin Coroutines.
* Doing tasks in series using Kotlin Coroutines.
* Doing tasks in parallel using Kotlin Coroutines.
* Making two network calls in parallel using Kotlin Coroutines.
* What are scopes in Kotlin Coroutines?
* Canceling background task using Kotlin Coroutines.
* Exception handling in Kotlin Coroutines.
* Using Kotlin Coroutines with Retrofit.
Blog: [Retrofit with Kotlin Coroutines](https://outcomeschool.com/blog/retrofit-with-kotlin-coroutines)
* Using Kotlin Coroutines with Room Database.
* Using Kotlin Coroutines with various 3rd party libraries.
* Adding timeout to a task using Kotlin Coroutines.
* Writing Unit-Test for ViewModel which uses Kotlin Coroutines.
## Kotlin Coroutines Examples for Android Development: Activity and ViewModel
* **Single Network Call:** Learn how to make a network call using Kotlin Coroutines. This is a very
simple use-case in Android App Development.
Blog: [Retrofit with Kotlin Coroutines](https://outcomeschool.com/blog/retrofit-with-kotlin-coroutines)
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/retrofit/single/SingleNetworkCallActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/retrofit/single/SingleNetworkCallViewModel.kt)
* **Series Network Calls:** Learn how to make network calls in series using Kotlin Coroutines. This
is useful when you want to make a network call which is dependent on an another network call.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/retrofit/series/SeriesNetworkCallsActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/retrofit/series/SeriesNetworkCallsViewModel.kt)
* **Parallel Network Calls:** Learn how to make network calls in parallel using Kotlin Coroutines.
This is useful when you want to make network calls in parallel which are independent of each
other.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/retrofit/parallel/ParallelNetworkCallsActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/retrofit/parallel/ParallelNetworkCallsViewModel.kt)
* **Room Database Operation:** Learn how to fetch or insert entity in database using Kotlin
Coroutines. This is useful when you are using Room Database in your Android Application.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/room/RoomDBActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/room/RoomDBViewModel.kt)
* **Long Running Task:** Learn how to run a long running task using Kotlin Coroutines. If you want
to do any of your task in background thread using the Kotlin Coroutines, then this is useful.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/task/onetask/LongRunningTaskActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/task/onetask/LongRunningTaskViewModel.kt)
* **Two Long Running Tasks:** Learn how to run two long running tasks in parallel using Kotlin
Coroutines.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/task/twotasks/TwoLongRunningTasksActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/task/twotasks/TwoLongRunningTasksViewModel.kt)
* **Timeout:** Learn how to add timeout to a task using Kotlin Coroutines. If you want to add a
timeout to any of your background task in Android, this is going to super useful.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/timeout/TimeoutActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/timeout/TimeoutViewModel.kt)
* **Try-Catch Error Handling:** Learn how to handle error in Kotlin Coroutines using Try-Catch.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/errorhandling/trycatch/TryCatchActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/errorhandling/trycatch/TryCatchViewModel.kt)
* **CoroutineExceptionHandler:** Learn how to handle error in Kotlin Coroutines using
CoroutineExceptionHandler.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/errorhandling/exceptionhandler/ExceptionHandlerActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/errorhandling/exceptionhandler/ExceptionHandlerViewModel.kt)
* **Ignore Error And Continue:** Learn how to
use [`supervisorScope`](https://outcomeschool.com/blog/coroutinescope-vs-supervisorscope) to ignore
error of a task and continue with other task. In other words, if more than two child jobs are
running in parallel under a supervisor, one child job gets failed, we can continue with other.
* [Activity Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/errorhandling/supervisor/IgnoreErrorAndContinueActivity.kt)
* [ViewModel Code](app/src/main/java/me/amitshekhar/learn/kotlin/coroutines/ui/errorhandling/supervisor/IgnoreErrorAndContinueViewModel.kt)
* **Unit Test:** Learn how write unit-test for ViewModel which uses Kotlin Coroutines.
* [ViewModelTest Code](app/src/test/java/me/amitshekhar/learn/kotlin/coroutines/ui/retrofit/single/SingleNetworkCallViewModelTest.kt)
## If this project helps you in anyway, show your love :heart: by putting a :star: on this project :v:
### License
```
Copyright (C) 2024 Amit Shekhar
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
### Contributing to Learn Kotlin Coroutines
Just make pull request. You are in!
Thanks
**Amit Shekhar**\
Co-Founder @ [Outcome School](https://outcomeschool.com)
You can connect with me on:
- [Twitter](https://twitter.com/amitiitbhu)
- [LinkedIn](https://www.linkedin.com/in/amit-shekhar-iitbhu)
- [GitHub](https://github.com/amitshekhariitbhu)
- [Facebook](https://www.facebook.com/amit.shekhar.iitbhu)
[**Read all of our blogs here.**](https://outcomeschool.com/blog)