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

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

ملاحظة: إذا كان ViewModel لا يتضمّن تبعيات أو كان النوع SavedStateHandle فقط هو نوع تبعية، لن تحتاج إلى توفير مصنع لإطار العمل من أجل إثبات مثيلات من نوع ViewModel هذا.

ملاحظة: عند إدخال نماذج عرض النماذج باستخدام Hilt كحل حقن تبعية، لا تحتاج إلى تحديد المصنع يدويًا. ينشئ Hilt مصنعًا يعرف كيفية إنشاء جميع نماذج ViewModels التي تم التعليق عليها باستخدام @HiltViewModel في وقت التجميع. ويمكن للصفوف التي تمت إضافة تعليقات توضيحية إليها باستخدام @AndroidEntryPoint الوصول مباشرةً إلى المصنع الذي تم إنشاؤه من خلال Hilt عند استدعاء واجهات برمجة تطبيقات 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().createSavedStateHandle()) ومررها إلى 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 في ملف ViewModel للحصول على سياق أفضل، وتسهيل قراءتها، وتسهيل اكتشافها. يمكن استخدام عامل ViewModel نفسه مع العديد من نماذج ViewModels عندما تتشارك التبعيات، كما هو الحال مع عيّنة Architecture Blueprints.

بعد ذلك، يمكنك استخدام هذا النظام الأصلي عند استرداد مثيل من 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
                )
            }
        }
    }
}

عوامل إصدار ViewModel الأقدم من 2.5.0

إذا كنت تستخدم إصدارًا أقدم من 2.5.0 من ViewModel، عليك توفير مصانع من مجموعة فرعية من الفئات التي تعمل على توسيع ViewModelProvider.Factory وتنفذ دالة create(Class<T>). اعتمادًا على التبعيات التي يحتاجها ViewModel، يجب تمديد فئة مختلفة من:

• AndroidViewModelFactory إذا كان صف Application ضروريًا.
• AbstractSavedStateViewModelFactory إذا كان يجب تمرير SavedStateHandle كتبعية.

إذا لم تكن هناك حاجة إلى السمة 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 2.5.0، قد يتوفّر لك خيار إلغاء دالة الإنشاء باستخدام CreationExtras في توقيعها. لا تلغي هذه الدالة. بدلاً من ذلك، يمكنك إلغاء دالة create التي تحتوي على المَعلمتَين key, modelClass وsavedStateHandle.

وبعد ذلك، يمكنك استخدام الإعدادات الأصلية لاسترداد 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
        )
    )
) {
    // ...
}