يمكنك إنشاء ViewModels مع التبعيات جزء من Android Jetpack.

وباتّباع أفضل الممارسات المتعلّقة بإدخال الاعتماد، يمكن أن تأخذ ViewModels التبعيات كمعلَمات في دالة الإنشاء. وهي غالبًا من أنواع من طبقات النطاق أو البيانات. بما أنّ الإطار يقدّم نماذج ViewModels، يجب استخدام آلية خاصة لإنشاء نُسخ منها. وهذه الآلية هي واجهة ViewModelProvider.Factory. لا يمكن إلا لعمليات التنفيذ لهذه الواجهة إنشاء مثيل لـ ViewModels في النطاق الصحيح.

عرض النماذج التي تتضمّن إضافات إنشاء

إذا كانت فئة 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 كتبعيات:

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.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
                }
            }
        }
    }

Java

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:

Kotlin

import androidx.activity.viewModels

class MyActivity : AppCompatActivity() {

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

    // Rest of Activity code
}

Java

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
}

Jetpack Compose

import androidx.lifecycle.viewmodel.compose.viewModel

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

ويمكنك بدلاً من ذلك استخدام DSL من مصنع ViewModel لإنشاء مصانع باستخدام واجهة برمجة تطبيقات Kotlin API الأكثر صلةً، وذلك باتّباع الخطوات التالية:

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.

Kotlin

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]

Jetpack Compose

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، يجب تمديد فئة مختلفة من:

إذا لم تكن Application أو SavedStateHandle مطلوبة، ما عليك سوى التمديد من ViewModelProvider.Factory.

يستخدم المثال التالي AbstractSavedStateViewModelFactory لـ ViewModel الذي يأخذ مستودعًا والنوع SavedStateHandle كعنصر تابع:

Kotlin

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
            }
        }
    }
}

Java

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:

Kotlin

import androidx.activity.viewModels

class MyActivity : AppCompatActivity() {

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

    // Rest of Activity code
}

Java

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
}

Jetpack Compose

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
        )
    )
) {
    // ...
}