डिपेंडेंसी के साथ ViewModels बनाएं Android Jetpack का हिस्सा है.

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

CreationExtras के साथ 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().createSavedStateHandle()) फ़ंक्शन को एक्ज़ीक्यूट करना चाहिए और उसे ViewModel पर पास करना.

नीचे दिए गए उदाहरण में, 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)
) {
    // ...
}

इसके अलावा, ViewModel फ़ैक्ट्री DSL का इस्तेमाल करके, मुहावरेदार 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
                )
            }
        }
    }
}

ViewModel के 2.5.0 से पुराने वर्शन के लिए फ़ैक्ट्री

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

अगर Application या SavedStateHandle की ज़रूरत नहीं है, तो बस इससे बढ़ाएं ViewModelProvider.Factory.

नीचे दिए गए उदाहरण में 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);
    }
}

इसके बाद, फ़ैक्ट्री का इस्तेमाल करके 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
        )
    )
) {
    // ...
}