Создание моделей представления с зависимостями . Часть Android Jetpack .

Следуя лучшим практикам внедрения зависимостей , ViewModels могут принимать зависимости в качестве параметров в своем конструкторе. В основном это типы из предметной области или слоев данных . Поскольку платформа предоставляет ViewModels, для создания их экземпляров требуется специальный механизм. Этот механизм — интерфейс ViewModelProvider.Factory . Только реализации этого интерфейса могут создавать экземпляры ViewModels в нужной области видимости .

Примечание. Если ViewModel не принимает никаких зависимостей или только тип SavedStateHandle в качестве зависимости , вам не нужно предоставлять фабрику для платформы для создания экземпляров этого типа ViewModel .

Примечание. При внедрении ViewModel с использованием Hilt в качестве решения для внедрения зависимостей вам не нужно вручную определять фабрику ViewModel . Hilt генерирует фабрику, которая знает, как создавать все модели ViewModel, аннотированные @HiltViewModel во время компиляции. Классы, аннотированные @AndroidEntryPoint могут напрямую обращаться к созданной Hilt фабрике при вызове обычных API ViewModel .

Модели просмотра с CreationExtras

Если класс ViewModel получает зависимости в своем конструкторе, укажите фабрику, реализующую интерфейс ViewModelProvider.Factory . Переопределите функцию create(Class<T>, CreationExtras) чтобы предоставить новый экземпляр ViewModel.

CreationExtras позволяет получить доступ к соответствующей информации, которая помогает создать экземпляр ViewModel. Вот список ключей, к которым можно получить доступ из дополнений:

Ключ	Функциональность
ViewModelProvider.NewInstanceFactory.VIEW_MODEL_KEY	Предоставляет доступ к пользовательскому ключу, который вы передали в ViewModelProvider.get() .
ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY	Предоставляет доступ к экземпляру класса Application .
SavedStateHandleSupport.DEFAULT_ARGS_KEY	Предоставляет доступ к набору аргументов, которые следует использовать для создания SavedStateHandle .
SavedStateHandleSupport.SAVED_STATE_REGISTRY_OWNER_KEY	Предоставляет доступ к SavedStateRegistryOwner , который используется для создания ViewModel .
SavedStateHandleSupport.VIEW_MODEL_STORE_OWNER_KEY	Предоставляет доступ к ViewModelStoreOwner , который используется для создания ViewModel .

Чтобы создать новый экземпляр SavedStateHandle , используйте функцию CreationExtras.createSavedStateHandle() и передайте ее в ViewModel.

CreationExtras с APPLICATION_KEY

Ниже приведен пример того, как предоставить экземпляр ViewModel , который принимает репозиторий , ограниченный классом Application , и SavedStateHandle в качестве зависимостей:

Котлин

    import androidx.lifecycle.SavedStateHandle
    import androidx.lifecycle.ViewModel
    import androidx.lifecycle.ViewModelProvider
    import androidx.lifecycle.ViewModelProvider.AndroidViewModelFactory.Companion.APPLICATION_KEY
    import androidx.lifecycle.createSavedStateHandle
    import androidx.lifecycle.viewmodel.CreationExtras

    class MyViewModel(
        private val myRepository: MyRepository,
        private val savedStateHandle: SavedStateHandle
    ) : ViewModel() {

        // ViewModel logic
        // ...

        // Define ViewModel factory in a companion object
        companion object {

            val Factory: ViewModelProvider.Factory = object : ViewModelProvider.Factory {
                @Suppress("UNCHECKED_CAST")
                override fun <T : ViewModel> create(
                    modelClass: Class<T>,
                    extras: CreationExtras
                ): T {
                    // Get the Application object from extras
                    val application = checkNotNull(extras[APPLICATION_KEY])
                    // Create a SavedStateHandle for this ViewModel from extras
                    val savedStateHandle = extras.createSavedStateHandle()

                    return MyViewModel(
                        (application as MyApplication).myRepository,
                        savedStateHandle
                    ) as T
                }
            }
        }
    }

Ява

import static androidx.lifecycle.SavedStateHandleSupport.createSavedStateHandle;
import static androidx.lifecycle.ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY;

import androidx.lifecycle.SavedStateHandle;
import androidx.lifecycle.ViewModel;
import androidx.lifecycle.viewmodel.ViewModelInitializer;

public class MyViewModel extends ViewModel {

    public MyViewModel(
        MyRepository myRepository,
        SavedStateHandle savedStateHandle
    ) { /* Init ViewModel here */ }

    static final ViewModelInitializer<MyViewModel> initializer = new ViewModelInitializer<>(
        MyViewModel.class,
        creationExtras -> {
            MyApplication app = (MyApplication) creationExtras.get(APPLICATION_KEY);
            assert app != null;
            SavedStateHandle savedStateHandle = createSavedStateHandle(creationExtras);

            return new MyViewModel(app.getMyRepository(), savedStateHandle);
        }
    );
}

Примечание. Рекомендуется размещать фабрики ViewModel в их файле ViewModel для улучшения контекста, удобства чтения и упрощения обнаружения. Одну и ту же фабрику ViewModel можно использовать для нескольких моделей ViewModel, если они имеют общие зависимости, как в случае с примером Architecture Blueprints .

Затем вы можете использовать эту фабрику при получении экземпляра ViewModel:

Котлин

import androidx.activity.viewModels

class MyActivity : AppCompatActivity() {

    private val viewModel: MyViewModel by viewModels { MyViewModel.Factory }

    // Rest of Activity code
}

Ява

import androidx.appcompat.app.AppCompatActivity;
import androidx.lifecycle.ViewModelProvider;

public class MyActivity extends AppCompatActivity {

MyViewModel myViewModel = new ViewModelProvider(
    this,
    ViewModelProvider.Factory.from(MyViewModel.initializer)
).get(MyViewModel.class);

// Rest of Activity code
}

Реактивный ранец

import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun MyScreen(
    modifier: Modifier = Modifier,
    viewModel: MyViewModel = viewModel(factory = MyViewModel.Factory)
) {
    // ...
}

Альтернативно, используйте DSL фабрики ViewModel для создания фабрик с использованием более идиоматического API Kotlin:

import androidx.lifecycle.SavedStateHandle
import androidx.lifecycle.ViewModel
import androidx.lifecycle.ViewModelProvider
import androidx.lifecycle.ViewModelProvider.AndroidViewModelFactory.Companion.APPLICATION_KEY
import androidx.lifecycle.createSavedStateHandle
import androidx.lifecycle.viewmodel.initializer
import androidx.lifecycle.viewmodel.viewModelFactory

class MyViewModel(
    private val myRepository: MyRepository,
    private val savedStateHandle: SavedStateHandle
) : ViewModel() {
    // ViewModel logic

    // Define ViewModel factory in a companion object
    companion object {
        val Factory: ViewModelProvider.Factory = viewModelFactory {
            initializer {
                val savedStateHandle = createSavedStateHandle()
                val myRepository = (this[APPLICATION_KEY] as MyApplication).myRepository
                MyViewModel(
                    myRepository = myRepository,
                    savedStateHandle = savedStateHandle
                )
            }
        }
    }
}

Передайте пользовательские параметры как CreationExtras

Вы можете передать зависимости в свою ViewModel через CreationExtras , создав собственный ключ. Это может быть полезно, если ваша ViewModel зависит от объектов, которые недоступны через класс Application и APPLICATION_KEY . Примером этого может служить случай, когда ваша ViewModel создается внутри многоплатформенного модуля Kotlin и, следовательно, не имеет доступа к зависимостям Android.

В этом примере ViewModel определяет пользовательский ключ и использует его в ViewModelProvider.Factory .

import androidx.lifecycle.ViewModel
import androidx.lifecycle.ViewModelProvider
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.CreationExtras
import androidx.lifecycle.viewmodel.initializer
import androidx.lifecycle.viewmodel.viewModelFactory

class MyViewModel(
    private val myRepository: MyRepository,
) : ViewModel() {
    // ViewModel logic

    // Define ViewModel factory in a companion object
    companion object {

        // Define a custom key for your dependency
        val MY_REPOSITORY_KEY = object : CreationExtras.Key<MyRepository> {}

        val Factory: ViewModelProvider.Factory = viewModelFactory {
            initializer {
                // Get the dependency in your factory
                val myRepository = this[MY_REPOSITORY_KEY] as MyRepository
                MyViewModel(
                    myRepository = myRepository,
                )
            }
        }
    }
}

Вы можете создать экземпляр ViewModel с помощью CreationExtras.Key из ViewModelStoreOwner , например ComponentActivity , Fragment или NavBackStackEntry , или с помощью Jetpack Compose.

Котлин

import androidx.lifecycle.ViewModelProvider
import androidx.lifecycle.ViewModelStoreOwner
import androidx.lifecycle.viewmodel.CreationExtras
import androidx.lifecycle.viewmodel.MutableCreationExtras
// ...
    // Use from ComponentActivity, Fragment, NavBackStackEntry,
    // or another ViewModelStoreOwner.
    val viewModelStoreOwner: ViewModelStoreOwner = this
    val myViewModel: MyViewModel = ViewModelProvider.create(
        viewModelStoreOwner,
        factory = MyViewModel.Factory,
        extras = MutableCreationExtras().apply {
            set(MyViewModel.MY_REPOSITORY_KEY, myRepository)
        },
    )[MyViewModel::class]

Реактивный ранец

import androidx.lifecycle.viewmodel.MutableCreationExtras
import androidx.lifecycle.viewmodel.compose.viewModel
// ...
@Composable
fun MyApp(myRepository: MyRepository) {
    val extras = MutableCreationExtras().apply {
        set(MyViewModel.MY_REPOSITORY_KEY, myRepository)
    }
    val viewModel: MyViewModel = viewModel(
        factory = MyViewModel.Factory,
        extras = extras,
    )
}

Фабрики для версии ViewModel старше 2.5.0

Если вы используете версию ViewModel старше 2.5.0, вам необходимо предоставить фабрики из подмножества классов, которые расширяют ViewModelProvider.Factory и реализуют функцию create(Class<T>) . В зависимости от того, какие зависимости необходимы ViewModel , необходимо расширить другой класс:

• AndroidViewModelFactory если необходим класс Application .
• AbstractSavedStateViewModelFactory , если SavedStateHandle необходимо передать как зависимость.

Если Application или SavedStateHandle не нужны, просто расширьте ViewModelProvider.Factory .

В следующем примере используется AbstractSavedStateViewModelFactory для ViewModel, который принимает репозиторий и тип SavedStateHandle в качестве зависимости:

Котлин

class MyViewModel(
private val myRepository: MyRepository,
private val savedStateHandle: SavedStateHandle
) : ViewModel() {

// ViewModel logic ...

// Define ViewModel factory in a companion object
companion object {
    fun provideFactory(
        myRepository: MyRepository,
        owner: SavedStateRegistryOwner,
        defaultArgs: Bundle? = null,
    ): AbstractSavedStateViewModelFactory =
        object : AbstractSavedStateViewModelFactory(owner, defaultArgs) {
            @Suppress("UNCHECKED_CAST")
            override fun <T : ViewModel> create(
                key: String,
                modelClass: Class<T>,
                handle: SavedStateHandle
            ): T {
                return MyViewModel(myRepository, handle) as T
            }
        }
    }
}

Ява

import androidx.annotation.NonNull;
import androidx.lifecycle.AbstractSavedStateViewModelFactory;
import androidx.lifecycle.SavedStateHandle;
import androidx.lifecycle.ViewModel;

public class MyViewModel extends ViewModel {
    public MyViewModel(
        MyRepository myRepository,
        SavedStateHandle savedStateHandle
    ) { /* Init ViewModel here */ }
}

public class MyViewModelFactory extends AbstractSavedStateViewModelFactory {

    private final MyRepository myRepository;

    public MyViewModelFactory(
        MyRepository myRepository
    ) {
        this.myRepository = myRepository;
    }

    @SuppressWarnings("unchecked")
    @NonNull
    @Override
    protected <T extends ViewModel> T create(
        @NonNull String key, @NonNull Class<T> modelClass, @NonNull SavedStateHandle handle
    ) {
        return (T) new MyViewModel(myRepository, handle);
    }
}

Предупреждение: если вы используете версию ViewModel старше 2.5.0, у вас может быть возможность переопределить функцию создания с помощью CreationExtras в ее сигнатуре. Не переопределяйте эту функцию. Вместо этого переопределите функцию create , имеющую параметры key, modelClass и savedStateHandle .

Затем вы можете использовать фабрику для получения вашей ViewModel:

Котлин

import androidx.activity.viewModels

class MyActivity : AppCompatActivity() {

    private val viewModel: MyViewModel by viewModels {
        MyViewModel.provideFactory((application as MyApplication).myRepository, this)
    }

    // Rest of Activity code
}

Ява

import androidx.appcompat.app.AppCompatActivity;
import androidx.lifecycle.ViewModelProvider;

public class MyActivity extends AppCompatActivity {

    MyViewModel myViewModel = new ViewModelProvider(
        this,
        ViewModelProvider.Factory.from(MyViewModel.initializer)
    ).get(MyViewModel.class);

    // Rest of Activity code
}

Реактивный ранец

import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun MyScreen(
    modifier: Modifier = Modifier,
    viewModel: MyViewModel = viewModel(
        factory = MyViewModel.provideFactory(
            (LocalContext.current.applicationContext as MyApplication).myRepository,
            owner = LocalSavedStateRegistryOwner.current
        )
    )
) {
    // ...
}

{% дословно %} {% дословно %}