إنشاء ViewModels مع عناصر اعتمادية (طرق العرض)   جزء من Android Jetpack

المفاهيم والتنفيذ في Jetpack Compose

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

‫ViewModels مع CreationExtras

إذا كانت الفئة ViewModel تتلقّى عناصر تابعة في الدالة الإنشائية، عليك توفير مصنع ينفّذ الواجهة ViewModelProvider.Factory. يمكنك إلغاء الدالة create(Class<T>, CreationExtras) لتوفير مثيل جديد من ViewModel.

‫CreationExtras مع APPLICATION_KEY

في ما يلي مثال على كيفية توفير مثيل من ViewModel يتضمّن مستودعًا ضمن نطاق الفئة Application وSavedStateHandle كعناصر تابعة:

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
}

تمرير المَعلمات المخصّصة كـ CreationExtras

يمكنك تمرير التبعيات إلى ViewModel من خلال CreationExtras عن طريق إنشاء مفتاح مخصّص. يمكن أن يكون ذلك مفيدًا إذا كان ViewModel يعتمد على عناصر لا يمكن الوصول إليها من خلال الفئة Application وAPPLICATION_KEY. ومن الأمثلة على ذلك، إنشاء ViewModel داخل وحدة Kotlin Multiplatform، وبالتالي لا يمكن الوصول إلى تبعيات 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.

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]

المصانع لإصدار 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
}