Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebaslogen/resaca
Compose Multiplatform library to scope ViewModels to a Composable, surviving configuration changes and navigation
https://github.com/sebaslogen/resaca
android android-architecture android-library architecture-components compose compose-multiplatform compose-multiplatform-library hilt-dependency-injection kotlin viewmodel
Last synced: 6 days ago
JSON representation
Compose Multiplatform library to scope ViewModels to a Composable, surviving configuration changes and navigation
- Host: GitHub
- URL: https://github.com/sebaslogen/resaca
- Owner: sebaslogen
- License: mit
- Created: 2021-11-24T13:09:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T07:47:24.000Z (11 days ago)
- Last Synced: 2024-11-05T08:29:30.688Z (11 days ago)
- Topics: android, android-architecture, android-library, architecture-components, compose, compose-multiplatform, compose-multiplatform-library, hilt-dependency-injection, kotlin, viewmodel
- Language: Kotlin
- Homepage:
- Size: 1.06 MB
- Stars: 421
- Watchers: 4
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - sebaslogen/resaca - Compose Multiplatform library to scope ViewModels to a Composable, surviving configuration changes and navigation (Kotlin)
- kmp-awesome - Resaca - Scope ViewModels to a Composable, surviving config. changes and navigation (Libraries / 🏗 Architecture)
README
[](https://central.sonatype.com/artifact/io.github.sebaslogen/resaca)
[](https://github.com/sebaslogen/resaca/actions/workflows/build.yml)
[](https://codecov.io/github/sebaslogen/resaca)
[](https://javadoc.io/doc/io.github.sebaslogen/resaca)
[](https://android-arsenal.com/api?level=21)
[](https://github.com/sebaslogen/resaca/blob/main/LICENSE)
[](https://central.sonatype.com/namespace/io.github.sebaslogen)
[](https://mailchi.mp/kotlinweekly/kotlin-weekly-285)
[](https://androidweekly.net/issues/issue-593)
Article about this library: [Every Composable deserves a ViewModel](https://engineering.q42.nl/compose/)
# Resaca 🍹
The right scope for objects and View Models in Android [Compose](https://developer.android.com/jetpack/compose).
Resaca provides a simple way to **keep a Jetpack ViewModel** (or any other object) **in memory during the lifecycle of a** `@Composable` **function** and automatically
clean it up when not needed anymore. This means, it retains your object or ViewModel across recompositions, during configuration changes, and also when the
container Fragment or Compose Navigation destination goes into the backstack.
With Resaca you can create fine grained ViewModels for fine grained Composables and finally have reusable components across screens.
# Why
Compose allows the creation of fine-grained UI components that can be easily reused like Lego blocks 🧱. Well architected Android apps isolate functionality in
small business logic components (like use cases, interactors, repositories, etc.) that are also reusable like Lego blocks 🧱.
Screens are built using Compose components together with business logic components, and the standard tool to connect these two types of components is
a [Jetpack ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel). Unfortunately, ViewModels can only be scoped to a whole screen (or
larger scope), but not to smaller Compose components on the screen.
In practice, this means that we are gluing UI Lego blocks with business logic Lego blocks using a big glue class for the whole screen, the ViewModel 🗜.
Until now...
# Installation
Just include the library (less than 5Kb):
Kotlin (KTS)
```kotlin
// In module's build.gradle.kts
dependencies {
// The latest version of the lib is available in the badget at the top from Maven Central, replace X.X.X with that version
implementation("io.github.sebaslogen:resaca:X.X.X")
}
```
Groovy
```gradle
dependencies {
// The latest version of the lib is available in the badget at the top from Maven Central, replace X.X.X with that version
implementation 'io.github.sebaslogen:resaca:X.X.X'
}
```
# Usage
Inside your `@Composable` function create and retrieve an object using `rememberScoped` to remember any type of object (except ViewModels). For ViewModels use
`viewModelScoped`. That's all 🪄✨
Examples:
Scope an object to a Composable
```kotlin
@Composable
fun DemoScopedObject() {
val myRepository: MyRepository = rememberScoped { MyRepository() }
DemoComposable(inputObject = myRepository)
}
```
Scope a ViewModel to a Composable
```kotlin
@Composable
fun DemoScopedViewModel() {
val myScopedVM: MyViewModel = viewModelScoped()
DemoComposable(inputObject = myScopedVM)
}
```
Scope a ViewModel with a dependency to a Composable
```kotlin
@Composable
fun DemoScopedViewModelWithDependency() {
val myScopedVM: MyViewModelWithDependencies = viewModelScoped { MyViewModelWithDependencies(myDependency) }
DemoComposable(inputObject = myScopedVM)
}
```
Scope a ViewModel with a key to a Composable
```kotlin
@Composable
fun DemoViewModelWithKey() {
val scopedVMWithFirstKey: MyViewModel = viewModelScoped("myFirstKey") { MyViewModel("myFirstKey") }
val scopedVMWithSecondKey: MyViewModel = viewModelScoped("mySecondKey") { MyViewModel("mySecondKey") }
// We now have 2 ViewModels of the same type with different data inside the same Composable scope
DemoComposable(inputObject = scopedVMWithFirstKey)
DemoComposable(inputObject = scopedVMWithSecondKey)
}
```
Scope a ViewModel with a dependency injected with Koin to a Composable
```kotlin
@Composable
fun DemoKoinInjectedViewModelWithDependency() {
val myInjectedScopedVM: MyViewModelWithDependencies = viewModelScoped() { getKoin().get { parametersOf(myConstructorDependency) } }
DemoComposable(inputObject = myInjectedScopedVM)
}
```
Use a different ViewModel for each item in a LazyColumn and scope them to the Composable that contains the LazyColumn
```kotlin
@Composable
fun DemoManyViewModelsScopedOutsideTheLazyColumn(listItems: List = (1..1000).toList()) {
val keys = rememberKeysInScope(inputListOfKeys = listItems)
LazyColumn() {
items(items = listItems, key = { it }) { item ->
val myScopedVM: MyViewModel = viewModelScoped(key = item, keyInScopeResolver = keys)
DemoComposable(inputObject = myScopedVM)
}
}
}
```
Once you use the `rememberScoped` or `viewModelScoped` functions, the same object will be restored as long as the Composable is part of the composition, even if
it _temporarily_ leaves composition on configuration change (e.g. screen rotation, change to dark mode, etc.) or while being in the backstack.
For ViewModels, in addition to being forgotten when they're really not needed anymore, their _coroutineScope_ will also be automatically canceled because
ViewModel's `onCleared` method will be automatically called.
> 💡 _Optional key_: a key can be provided to the call, `rememberScoped(key) { ... }` or `viewModelScoped(key) { ... }`. This makes possible to forget an old
object when there is new input data during a recomposition (e.g. a new input id for your ViewModel).
> ⚠️ Note that ViewModels remembered with `viewModelScoped` **should not be created** using any of the Compose `viewModel()` or `ViewModelProviders` factories,
otherwise they will be retained in the scope of the screen regardless of `viewModelScoped`. Also, if a ViewModel is remembered with `rememberScoped`, instead of `viewModelScoped`, then its
clean-up method won't be called, so it's always better to use `viewModelScoped` for ViewModels.
# Sample use cases
Here are some sample use cases reported by the users of this library:
- ❤️ Isolated and stateful UI components like a **favorite button** that are widely used across the screens. This `FavoriteViewModel` can be very small, focused
and only require an id to work without affecting the rest of the screen's UI and state.
- 🗪 **Dialog pop-ups** can have their own business-logic with state that is better to isolate in a separate ViewModel but the lifespan of these dialogs might be short,
so it's important to clean-up the ViewModel associated to a Dialog after it has been closed.
- 📃 A LazyColumn with a **ViewModel per list item**. Each item can have its own complex logic in an isolated ViewModel that will be lazily loaded when the item is
visible for the first time. The ViewModel will cleared and destroyed when the item is not part of the list in the source data or the whole LazyColumn is removed.
- 📄📄 Multiple instances of the same type of ViewModel in a screen with a **view-pager**. This screen will have multiple sub-pages that use the same ViewModel
class with different ids. For example, a screen of holiday destinations with multiple pages and each page with its own `HolidayDestinationViewModel`.
# Demo app
Demo app [documentation can be found here](https://github.com/sebaslogen/resaca/blob/main/sample/README.md).
Before | After backstack navigation & configuration change
:-------------------------:|:-------------------------:
| 
# Multiplatform support
Resaca works in Kotlin Multiplaform and also in Compose Multiplatform for Android and iOS targets:
## Compose Multiplatform
Since version 4.0, Resaca supports Compose Multiplatform for Android and iOS targets.
To see an example of usage and configuration check the [Sample Compose Multiplatform project](https://github.com/sebaslogen/resaca/blob/main/samplecmp/sampleComposeApp/src/commonMain/kotlin/App.kt) in the `samplecmp` module.
## Kotlin Multiplatform
Resaca is a Kotlin Multiplatform library and can be used in any Kotlin Multiplatform project that targets Android or iOS. Nevertheless,
Resaca does not make sense in a SwiftUI project because it's a Compose only library, instead, if you want to scope ViewModels to SwiftUI views,
you can look at the solutions provided in the first comments of this ticket https://github.com/sebaslogen/resaca/issues/91.
# Dependency injection support
This library does not influence how your app provides or creates objects so it's dependency injection strategy and framework agnostic.
Nevertheless, this library supports two of the main **dependency injection frameworks**:
## Hilt 🗡️
Hilt details
[HILT](https://dagger.dev/hilt/quick-start) (Dagger) support is available in a small extension of this library: [**resaca-hilt**](https://github.com/sebaslogen/resaca/tree/main/resacahilt/).
[Documentation and installation instructions are available here](https://github.com/sebaslogen/resaca/tree/main/resacahilt/README.md).
## Koin 🪙
Koin details
[Koin](https://insert-koin.io/) is out of the box supported by simply changing the way you request a dependency.
Instead of using the `getViewModel` or `koinViewModel` functions from Koin, you have to use the standard way of getting a dependency from Koin `getKoin().get()`.
Usage example: `val viewModel: MyViewModel = viewModelScoped(myId) { getKoin().get { parametersOf(myId) } }`
> **Note**: if you plan to use a ViewModel with a [SavedStateHandle](https://developer.android.com/topic/libraries/architecture/viewmodel/viewmodel-savedstate), then you need to use the `koinViewModelScoped` function from the small extension library [**resaca-koin**](https://github.com/sebaslogen/resaca/blob/main/resacakoin/Readme.md).
# Scoping in a LazyColumn, LazyRow, etc
This is handy for the typical case where you have a lazy list of items and you want to have a separate ViewModel for each item in the list, using the `viewModelScoped` function.
How to use `rememberKeysInScope` to control the lifecycle of a scoped object in a Lazy* list
When using the Lazy* family of Composables it is recommended that -just above the call to the Lazy* Composable- you use `rememberKeysInScope` with a list of
keys corresponding to the items used in the Lazy* Composable to obtain a `KeyInScopeResolver` (it's already highly recommended in Compose that items in a Lazy* list have unique keys).
Then, in the Lazy* Composable, once you are creating an item and you need an object or ViewModel for that item,
all you have to do is include in the call to `rememberScoped`/`viewModelScoped` the key for the current item and the `KeyInScopeResolver` you previously got from `rememberKeysInScope`.
With this setup, when an item of the Lazy* list becomes visible for the first time, its associated `rememberScoped`/`viewModelScoped` object will be created and even if the item is scrolled away, the scoped object will still be alive. Only once the associated key is not present anymore in the list provided to `rememberKeysInScope` and the item is either not part of the Lazy* list anymore or scrolled away, then the associated object will be cleared and destroyed.
🏷️ Example of a separate ViewModel for each item in a LazyColumn and scope them to the Composable that contains the LazyColumn
```kotlin
@Composable
fun DemoManyViewModelsScopedOutsideTheLazyColumn(listItems: List = (1..1000).toList()) {
val keys = rememberKeysInScope(inputListOfKeys = listItems)
LazyColumn() {
items(items = listItems, key = { it }) { item ->
val myScopedVM: MyViewModel = viewModelScoped(key = item, keyInScopeResolver = keys)
DemoComposable(inputObject = myScopedVM)
}
}
}
```
### General considerations for State Hoisting
When a Composable is used more than once in the same screen with the same input, then the ViewModel (or business logic object) should be provided only once
with `viewModelScoped` at a higher level in the composition tree using Compose's [State Hoisting](https://developer.android.com/jetpack/compose/state#state-hoisting).
# Why not use remember?
Pros, cons and alternatives to remember:
**[Remember](https://developer.android.com/reference/kotlin/androidx/compose/runtime/package-summary#remember(kotlin.Function0))** will keep our object alive as
long as the Composable is not disposed of. Unfortunately, there are a few cases where our Composable will be disposed of and then added again, breaking the
lifecycle parity with the remember function. 😢
Pros and Cons
**_Pros_**
- Simple API
**_Cons_**
- remember value will **NOT** survive a configuration change
- remember value will **NOT** survive when going into the backstack
- remember value will **NOT** survive a process death
**[RememberSaveable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/package-summary#rememberSaveable(kotlin.Array,androidx.compose.runtime.saveable.Saver,kotlin.String,kotlin.Function0))**
will follow the lifecycle of the Composable, even in the few cases where the Composable is temporarily disposed of. But the object we want to remember needs to
implement Parcelable or the [Saver](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver) interface in an additional class. 😢
Implementing these interfaces might not trivial.
Pros and Cons
**_Pros_**
- rememberSaveable value will survive a configuration change
- rememberSaveable value will survive when going into the backstack
- rememberSaveable value will survive a process death
**_Cons_**
- **Complex** integration work is required to correctly implement Parcelable
or [Saver](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver)
### Resaca's RememberScoped 🪄✨
**[RememberScoped](https://github.com/sebaslogen/resaca/blob/main/resaca/src/main/java/com/sebaslogen/resaca/ScopedMemoizers.kt#L33)** function keeps
objects in memory during the lifecycle of the Composable, even in a few cases where the Composable is disposed of, and then added again. Therefore, it will
retain objects longer than the `remember` function but shorter than `rememberSaveable` because there is no serialization involved.
Pros and Cons
**_Pros_**
- Simple API
- rememberScoped/viewModelScoped value will survive a configuration change
- rememberScoped/viewModelScoped value will survive when going into the backstack
**_Cons_**
- rememberScoped/viewModelScoped value will **NOT** survive a process death
# Lifecycle explained
How does the lifecycle of the Resaca scoped objects work and some lifecycle illustrated examples:
**[RememberScoped](https://github.com/sebaslogen/resaca/blob/main/resaca/src/main/java/com/sebaslogen/resaca/ScopedMemoizers.kt#L33)** function keeps
objects in memory during the lifecycle of the Composable, even in a few cases where the Composable is disposed of, and then added again.
## RememberScoped lifecycle internal implementation details
This project uses internally a ViewModel as a container to store all scoped ViewModels and scoped objects.
What happens when a Composable is disposed?
When a Composable is disposed of, we don't know for sure if it will return again later. So at the moment of disposal, we mark in our container the associated
object to be disposed of after the next frame when the Activity is resumed. During the span of time of this next frame, a few things can happen:
- The Composable is not part of the composition anymore after the next frame and the associated object is disposed of. 🚮
- The LifecycleOwner of the disposed Composable (i.e. the navigation destination where the Composable lived) is paused (e.g. screen went to background) before
the next frame happened. Then the disposal of the scoped object is canceled, but the object is still marked for disposal at a later stage.
- This can happen when the application goes through a configuration change and the container Activity is recreated.
- Also when the Composable is part of a Fragment that has been pushed to the backstack.
- And also when the Composable is part of a Compose Navigation destination that has been pushed to the backstack.
- When the LifecycleOwner of the disposed Composable is resumed (e.g. Fragment comes back to foreground), then the disposal of the associated object is
scheduled again to happen after the next frame when the Activity is resumed. At this point two things can happen:
- The Composable becomes part of the composition again and the `rememberScoped`/`viewModelScoped` function restores the associated object while also
cancelling any pending disposal in the next frame when the Activity is resumed. 🎉
- The Composable is not part of the composition anymore after the next frame and then the associated object is disposed of. 🚮
> **Note**:
- To know that the same Composable is being added to the composition again after being disposed of, we generate a random ID and store it with `rememberSaveable`
, which survives recomposition, recreation and even process death.
- To detect when the requester Composable is not needed anymore (has left composition and the screen for good), the ScopedViewModelContainer also observes the
resume/pause Lifecycle events of the owner of this ScopedViewModelContainer (i.e. Activity, Fragment, or Compose Navigation destination)
## Lifecycle example
This diagram shows the lifecycle of three Composables (A, B, and C) with their respective objects scoped with the `rememberScoped` function. All these
Composables are part of a Composable destination which is part of a Fragment which is part of an Activity which is part of the App. The horizontal arrows
represent different lifecycle events, events like Composable being disposed of, Composable screen going into the backstack, Fragment going into the backstack
and returning from backstack, or Activity recreated after a configuration change.
The existing alternatives to replicate the lifecycle of the objects in the diagram without using `rememberScoped` are:
- Object A lifecycle could only be achieved using the Compose `viewModel()` or `ViewModelProviders` factories.
- Object B lifecycle could only be achieved using the Compose `remember()` function.
- Object C lifecycle could not be achieved neither by using ViewModel provider functions nor Compose `remember` functions.