डिपेंडेंसी (व्यू) के साथ ViewModel बनाना   Android Jetpack का हिस्सा.

सिद्धांत और Jetpack Compose में लागू करना

डिपेंडेंसी इंजेक्शन's के सबसे सही तरीकों का पालन करते हुए, ViewModels अपने कंस्ट्रक्टर में पैरामीटर के तौर पर डिपेंडेंसी ले सकते हैं. ये ज़्यादातर डोमेन या डेटा लेयर के टाइप होते हैं. फ़्रेमवर्क, ViewModels उपलब्ध कराता है. इसलिए, इनके इंस्टेंस बनाने के लिए एक खास तरीके की ज़रूरत होती है. यह ViewModelProvider.Factory इंटरफ़ेस है. सिर्फ़ इस इंटरफ़ेस को लागू करने वाले ऑब्जेक्ट, सही स्कोप में ViewModels को इंस्टैंशिएट कर सकते हैं.

CreationExtras के साथ ViewModels

अगर किसी ViewModel क्लास को उसके कंस्ट्रक्टर में डिपेंडेंसी मिलती हैं, तो ViewModelProvider.Factory इंटरफ़ेस को लागू करने वाली फ़ैक्ट्री उपलब्ध कराएं. ViewModel का नया इंस्टेंस उपलब्ध कराने के लिए, create(Class<T>, CreationExtras) फ़ंक्शन को बदलें.

APPLICATION_KEY के साथ CreationExtras

यहां ViewModel का एक इंस्टेंस देने का तरीका बताया गया है. यह Application क्लास के स्कोप में मौजूद repository और 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 के तौर पर पास करना

कस्टम कुंजी बनाकर, CreationExtras के ज़रिए अपनी ViewModel को डिपेंडेंसी पास की जा सकती हैं. अगर आपका 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,
                )
            }
        }
    }
}

ComponentActivity, Fragment या NavBackStackEntry जैसे ViewModelStoreOwner से CreationExtras.Key का इस्तेमाल करके, ViewModel को इंस्टैंशिएट किया जा सकता है.

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 से आगे बढ़ाएं.

यहां दिए गए उदाहरण में, एक ऐसे ViewModel के लिए AbstractSavedStateViewModelFactory का इस्तेमाल किया गया है जो एक रिपॉज़िटरी और 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);
    }
}
इस फ़ंक्शन में 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
}