Как настроить ViewModel для KMP

AndroidX ViewModel выступает в качестве моста, устанавливая четкий контракт между вашей общей бизнес-логикой и компонентами интерфейса. Такой подход позволяет обеспечить согласованность данных на разных платформах и при этом настроить интерфейс для каждой платформы. Вы можете продолжить разработку интерфейса с помощью Jetpack Compose на Android и SwiftUI на iOS.

Подробнее о преимуществах использования ViewModel и всех ее функциях можно узнать в основной документации по ViewModel.

Настройте зависимости

Чтобы настроить KMP ViewModel в проекте, определите зависимость в файле libs.versions.toml:

[versions]
androidx-viewmodel = 2.11.0

[libraries]
androidx-lifecycle-viewmodel = { module = "androidx.lifecycle:lifecycle-viewmodel", version.ref = "androidx-viewmodel" }

Затем добавьте артефакт в файл build.gradle.kts для модуля KMP и объявите зависимость как api, поскольку она будет экспортирована в двоичный фреймворк:

// You need the "api" dependency declaration here if you want better access to the classes from Swift code.
commonMain.dependencies {
  api(libs.androidx.lifecycle.viewmodel)
}

Экспорт API ViewModel для доступа из Swift

По умолчанию любая библиотека, добавленная в базу кода, не экспортируется автоматически в исполняемый фреймворк. Если API не экспортируются, они доступны из двоичного фреймворка, только если вы используете их в общем коде (из набора исходных файлов iosMain или commonMain). В таком случае API будут содержать префикс пакета, например класс ViewModel будет доступен как класс Lifecycle_viewmodelViewModel. Подробнее об экспорте зависимостей в двоичные файлы…

Чтобы улучшить работу, вы можете экспортировать зависимость ViewModel в двоичный фреймворк, используя настройку export в файле build.gradle.kts, где вы определяете двоичный фреймворк iOS. Это позволит получать доступ к API ViewModel непосредственно из кода Swift так же, как из кода Kotlin:

listOf(
  iosX64(),
  iosArm64(),
  iosSimulatorArm64(),
).forEach {
  it.binaries.framework {
    // Add this line to all the targets you want to export this dependency
    export(libs.androidx.lifecycle.viewmodel)
    baseName = "shared"
  }
}

(Необязательно) Использование viewModelScope на компьютере с JVM

При запуске сопрограмм в ViewModel свойство viewModelScope связано с Dispatchers.Main.immediate, который по умолчанию может быть недоступен на компьютере. Чтобы все работало правильно, добавьте в проект зависимость kotlinx-coroutines-swing:

// Optional if you use JVM Desktop
desktopMain.dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-swing:[KotlinX Coroutines version]")
}

Подробная информация приведена в документации по Dispatchers.Main.

Используйте ViewModel из commonMain или androidMain

Нет никаких особых требований к использованию класса ViewModel в общем модуле commonMain или в наборе исходных файлов androidMain. Единственное, что нужно учитывать, – это то, что вы не можете использовать API, предназначенные для определенной платформы, и вам нужно абстрагировать их. Например, если вы используете Android Application в качестве параметра конструктора ViewModel, вам нужно отказаться от этого API, абстрагировав его.

Подробнее о том, как использовать код для определенных платформ, можно узнать в документации по Kotlin Multiplatform.

Например, в следующем фрагменте кода показан класс ViewModel с фабрикой, определенной в commonMain:

// commonMain/MainViewModel.kt

class MainViewModel(
    private val repository: DataRepository,
) : ViewModel() { /* some logic */ }

// ViewModelFactory that retrieves the data repository for your app.
val mainViewModelFactory = viewModelFactory {
    initializer {
        MainViewModel(repository = getDataRepository())
    }
}

fun getDataRepository(): DataRepository = DataRepository()

После этого вы можете получить ViewModel в коде интерфейса, как обычно:

// androidApp/ui/MainScreen.kt

@Composable
fun MainScreen(
    viewModel: MainViewModel = viewModel(
        factory = mainViewModelFactory,
    ),
) {
// observe the viewModel state
}

Как использовать ViewModel в SwiftUI

В Android жизненный цикл ViewModel обрабатывается автоматически и ограничивается областью действия ComponentActivity, Fragment, NavBackStackEntry (Navigation 2) или rememberViewModelStoreNavEntryDecorator (Navigation 3). Однако в SwiftUI для iOS нет встроенного аналога AndroidX ViewModel.

Чтобы поделиться ViewModel с приложением SwiftUI, нужно добавить код настройки.

Как создать функцию для работы с обобщенными типами

При создании экземпляра универсального объекта ViewModel на Android используется отражение ссылки на класс. Поскольку обобщенные типы Objective-C поддерживают не все функции Kotlin и Swift, вы не можете напрямую получить ViewModel обобщенного типа из Swift.

Чтобы решить эту проблему, можно создать вспомогательную функцию, которая будет использовать ObjCClass вместо универсального типа, а затем использовать getOriginalKotlinClass, чтобы получить класс ViewModel для создания экземпляра:

// iosMain/ViewModelResolver.ios.kt

/**
 *   This function allows retrieving any ViewModel from Swift Code with generics. We only get
 *   [ObjCClass] type for the [modelClass], because the interop between Kotlin and Swift code
 *   doesn't preserve the generic class, but we can retrieve the original KClass in Kotlin.
 */
@BetaInteropApi
@Throws(IllegalArgumentException::class)
fun ViewModelStore.resolveViewModel(
    modelClass: ObjCClass,
    factory: ViewModelProvider.Factory,
    key: String?,
    extras: CreationExtras? = null,
): ViewModel {
    @Suppress("UNCHECKED_CAST")
    val vmClass = getOriginalKotlinClass(modelClass) as? KClass<ViewModel>
    require(vmClass != null) { "The modelClass parameter must be a ViewModel type." }

    val provider = ViewModelProvider.Companion.create(this, factory, extras ?: CreationExtras.Empty)
    return key?.let { provider[key, vmClass] } ?: provider[vmClass]
}

Затем, когда вы захотите вызвать функцию из Swift, вы сможете написать универсальную функцию типа T : ViewModel и использовать T.self, которая может передать ObjCClass в функцию resolveViewModel.

Как подключить область ViewModel к жизненному циклу SwiftUI

Следующий шаг – создать IosViewModelStoreOwner, реализующий интерфейсы (протоколы) ObservableObject и ViewModelStoreOwner. Причина использования ObservableObject заключается в том, чтобы иметь возможность использовать этот класс как @StateObject в коде SwiftUI:

// iosApp/IosViewModelStoreOwner.swift

class IosViewModelStoreOwner: ObservableObject, ViewModelStoreOwner {

    let viewModelStore = ViewModelStore()

    /// This function allows retrieving the androidx ViewModel from the store.
    /// It uses the utilify function to pass the generic type T to shared code
    func viewModel<T: ViewModel>(
        key: String? = nil,
        factory: ViewModelProviderFactory,
        extras: CreationExtras? = nil
    ) -> T {
        do {
            return try viewModelStore.resolveViewModel(
                modelClass: T.self,
                factory: factory,
                key: key,
                extras: extras
            ) as! T
        } catch {
            fatalError("Failed to create ViewModel of type \(T.self)")
        }
    }

    /// This is called when this class is used as a `@StateObject`
    deinit {
        viewModelStore.clear()
    }
}

Этот владелец позволяет получать несколько типов ViewModel, как и в Android. Жизненный цикл этих объектов ViewModel завершается, когда экран, на котором используется IosViewModelStoreOwner, деинициализируется и вызывает deinit. Подробнее о деинициализации можно узнать в официальной документации.

На этом этапе вы можете создать экземпляр IosViewModelStoreOwner как @StateObject в представлении SwiftUI и вызвать функцию viewModel, чтобы получить ViewModel:

// iosApp/ContentView.swift

struct ContentView: View {

    /// Use the store owner as a StateObject to allow retrieving ViewModels and scoping it to this screen.
    @StateObject private var viewModelStoreOwner = IosViewModelStoreOwner()

    var body: some View {
        /// Retrieves the `MainViewModel` instance using the `viewModelStoreOwner`.
        /// The `MainViewModel.Factory` and `creationExtras` are provided to enable dependency injection
        /// and proper initialization of the ViewModel with its required `AppContainer`.
        let mainViewModel: MainViewModel = viewModelStoreOwner.viewModel(
            factory: MainViewModelKt.mainViewModelFactory
        )
        // ...
        // .. the rest of the SwiftUI code
    }
}

Недоступно в Kotlin Multiplatform

Некоторые API, доступные в Android, недоступны в Kotlin Multiplatform.

Интеграция с Hilt

Поскольку Hilt недоступен для проектов Kotlin Multiplatform, вы не можете напрямую использовать ViewModels с аннотацией @HiltViewModel в sourceSet commonMain. В таком случае вам нужно использовать альтернативный фреймворк для внедрения зависимостей, например Koin, kotlin-inject, Metro или Kodein. Все фреймворки для внедрения зависимостей, которые работают с Kotlin Multiplatform, можно найти на сайте klibs.io.

Как наблюдать за потоками в SwiftUI

Наблюдение за потоками корутин в SwiftUI напрямую не поддерживается. Однако вы можете использовать библиотеку KMP-NativeCoroutines или SKIE, чтобы включить эту функцию.