ViewModel स्कोपिंग एपीआई Android Jetpack का हिस्सा है.

ViewModels को असरदार तरीके से इस्तेमाल करने के लिए स्कोप सबसे ज़रूरी है. हर ViewModel का दायरा वह ऑब्जेक्ट जो ViewModelStoreOwner इंटरफ़ेस को लागू करता है. यहां हैं कई एपीआई हैं, जो आपको अपने ViewModels के दायरे को ज़्यादा आसानी से मैनेज करने की सुविधा देते हैं. इस दस्तावेज़ में कुछ ऐसी अहम तकनीकों के बारे में बताया गया है जिनके बारे में आपको पता होना चाहिए.

ध्यान दें: स्कोप और ViewModel लाइफ़साइकल के बारे में ज़्यादा जानकारी के लिए, ViewModel की खास जानकारी.

ViewModelProvider.get() तरीके से, आपको ViewModel का इंस्टेंस पाने में मदद मिलती है किसी भी ViewModelStoreOwner तक सीमित करें. Kotlin के उपयोगकर्ताओं के लिए, यहां अलग-अलग एक्सटेंशन फ़ंक्शन, सबसे ज़्यादा इस्तेमाल किए जाने वाले उदाहरणों के लिए उपलब्ध हैं. सभी Kotlin एक्सटेंशन फ़ंक्शन लागू करने के लिए, हुड के तहत ViewModelProvider API का इस्तेमाल किया जाता है.

ViewModels, सबसे नज़दीकी ViewModelStoreOwner तक के दायरे में है

आप ViewModel को किसी ऐक्टिविटी, फ़्रैगमेंट या डेस्टिनेशन नेविगेशन ग्राफ़. कॉन्टेंट बनाने viewModels() एक्सटेंशन ऐक्टिविटी, फ़्रैगमेंट, और नेविगेशन लाइब्रेरी से मिलने वाले फ़ंक्शन के साथ ही लिखें में viewModel() फ़ंक्शन की मदद से, ViewModel का इंस्टेंस देखा जा सकता है निकटतम ViewModelStoreOwner तक के दायरे में.

व्यू

import androidx.activity.viewModels

class MyActivity : AppCompatActivity() {
    // ViewModel API available in activity.activity-ktx
    // The ViewModel is scoped to `this` Activity
    val viewModel: MyViewModel by viewModels()
}

import androidx.fragment.app.viewModels

class MyFragment : Fragment() {
    // ViewModel API available in fragment.fragment-ktx
    // The ViewModel is scoped to `this` Fragment
    val viewModel: MyViewModel by viewModels()
}

व्यू

import androidx.lifecycle.ViewModelProvider;

public class MyActivity extends AppCompatActivity {
    // The ViewModel is scoped to `this` Activity
    MyViewModel viewModel = new ViewModelProvider(this).get(MyViewModel.class);
}

public class MyFragment extends Fragment {
    // The ViewModel is scoped to `this` Fragment
    MyViewModel viewModel = new ViewModelProvider(this).get(MyViewModel.class);
}

Compose

import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun MyScreen(
    modifier: Modifier = Modifier,
    // ViewModel API available in lifecycle.lifecycle-viewmodel-compose
    // The ViewModel is scoped to the closest ViewModelStoreOwner provided
    // via the LocalViewModelStoreOwner CompositionLocal. In order of proximity,
    // this could be the destination of a Navigation graph, the host Fragment,
    // or the host Activity.
    viewModel: MyViewModel = viewModel()
) { /* ... */ }

ध्यान दें: अगर Hilt और Jetpack Compose का इस्तेमाल किया जा रहा है, तो viewModel() कॉल बदलें लिखें + Hilt दस्तावेज़ में दी गई जानकारी के हिसाब से hiltViewModel() का इस्तेमाल करें.

ViewModels का दायरा किसी भी ViewModelStoreOwner तक का है

ComponentActivity.viewModels() और Fragment.viewModels() फ़ंक्शन लिखने के लिए व्यू सिस्टम और viewModel() फ़ंक्शन एक वैकल्पिक पैरामीटर के तौर पर ownerProducer पैरामीटर का इस्तेमाल करके, यह तय किया जा सकता है कि ViewModelStoreOwner ViewModel के इंस्टेंस के दायरे में. नीचे दिया गया सैंपल, ViewModel के इंस्टेंस को पैरंट फ़्रैगमेंट:

व्यू

import androidx.fragment.app.viewModels

class MyFragment : Fragment() {

    // ViewModel API available in fragment.fragment-ktx
    // The ViewModel is scoped to the parent of `this` Fragment
    val viewModel: SharedViewModel by viewModels(
        ownerProducer = { requireParentFragment() }
    )
}

व्यू

import androidx.lifecycle.ViewModelProvider;

public class MyFragment extends Fragment {

    SharedViewModel viewModel;

    @Override
    public void onViewCreated(View view, Bundle savedInstanceState) {
        // The ViewModel is scoped to the parent of `this` Fragment
        viewModel = new ViewModelProvider(requireParentFragment())
            .get(SharedViewModel.class);
    }
}

Compose

import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun MyScreen(
    context: Context = LocalContext.current,
    // ViewModel API available in lifecycle.lifecycle-viewmodel-compose
    // The ViewModel is scoped to the parent of the host Fragment
    // where this composable function is called
    viewModel: SharedViewModel = viewModel(
        viewModelStoreOwner = (context as Fragment).requireParentFragment()
    )
) { /* ... */ }

किसी फ़्रैगमेंट से, ऐक्टिविटी के स्कोप वाला ViewModel लेना आम तौर पर इस्तेमाल का उदाहरण है. टास्क कब शुरू होगा ऐसा करने के लिए, activityViewModels() का इस्तेमाल करें दृश्य एक्सटेंशन फ़ंक्शन उपलब्ध है. अगर View और Kotlin का इस्तेमाल नहीं किया जा रहा है, तो आप ऊपर बताए गए तरीके से और सही मालिक को पास करके उन्हीं एपीआई का इस्तेमाल कर सकते हैं.

व्यू

import androidx.fragment.app.activityViewModels

class MyFragment : Fragment() {

    // ViewModel API available in fragment.fragment-ktx
    // The ViewModel is scoped to the host Activity
    val viewModel: SharedViewModel by activityViewModels()
}

व्यू

import androidx.lifecycle.ViewModelProvider;

public class MyFragment extends Fragment {

    SharedViewModel viewModel;

    @Override
    public void onViewCreated(View view, Bundle savedInstanceState) {
        // The ViewModel is scoped to the host Activity
        viewModel = new ViewModelProvider(requireActivity())
            .get(SharedViewModel.class);
    }
}

Compose

import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun MyScreen(
    context: Context = LocalContext.current,
    // ViewModel API available in lifecycle.lifecycle-viewmodel-compose
    // The ViewModel is scoped to the Activity of the host Fragment
    // where this composable function is called
    viewModel: SharedViewModel = viewModel(
        viewModelStoreOwner = (context as Fragment).requireActivity()
    )
) { /* ... */ }

ध्यान दें: अगर Hilt और Jetpack Compose का इस्तेमाल किया जा रहा है, तो viewModel() कॉल बदलें साथ ही, जैसा कि hiltViewModel() में बताया गया है लिखने + हिलने से जुड़े दस्तावेज़.

ViewModels, नेविगेशन ग्राफ़ के दायरे में आता है

नेविगेशन ग्राफ़, ViewModel स्टोर के मालिक भी होते हैं. अगर इसका इस्तेमाल किया जा रहा है, तो नेविगेशन फ़्रैगमेंट या नेविगेशन कंपोज़, आपको कोई इंस्टेंस ViewModel एक नेविगेशन ग्राफ़ तक सीमित है, जिसमें navGraphViewModels(graphId) एक्सटेंशन फ़ंक्शन देखता है.

व्यू

import androidx.navigation.navGraphViewModels

class MyFragment : Fragment() {

    // ViewModel API available in navigation.navigation-fragment
    // The ViewModel is scoped to the `nav_graph` Navigation graph
    val viewModel: SharedViewModel by navGraphViewModels(R.id.nav_graph)

    // Equivalent navGraphViewModels code using the viewModels API
    val viewModel: SharedViewModel by viewModels(
        { findNavController().getBackStackEntry(R.id.nav_graph) }
    )
}

व्यू

import androidx.lifecycle.ViewModelProvider;

public class MyFragment extends Fragment {

    SharedViewModel viewModel;

    @Override
    public void onViewCreated(View view, Bundle savedInstanceState) {
        NavController navController = NavHostFragment.findNavController(this);
        NavBackStackEntry backStackEntry = navController.getBackStackEntry(R.id.my_graph);

        // The ViewModel is scoped to the `nav_graph` Navigation graph
        viewModel = new ViewModelProvider(backStackEntry).get(SharedViewModel.class);
    }
}

Compose

import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun MyAppNavHost() {
    // ...
    composable("myScreen") { backStackEntry ->
        // Retrieve the NavBackStackEntry of "parentNavigationRoute"
        val parentEntry = remember(backStackEntry) {
            navController.getBackStackEntry("parentNavigationRoute")
        }
        // Get the ViewModel scoped to the `parentNavigationRoute` Nav graph
        val parentViewModel: SharedViewModel = viewModel(parentEntry)
        // ...
    }
}

अगर जेटपैक नेविगेशन के अलावा, Hilt का इस्तेमाल किया जा रहा है, तो hiltNavGraphViewModels(graphId) API को देखें.

व्यू

import androidx.hilt.navigation.fragment.hiltNavGraphViewModels

class MyFragment : Fragment() {

    // ViewModel API available in hilt.hilt-navigation-fragment
    // The ViewModel is scoped to the `nav_graph` Navigation graph
    // and is provided using the Hilt-generated ViewModel factory
    val viewModel: SharedViewModel by hiltNavGraphViewModels(R.id.nav_graph)
}

व्यू

import androidx.hilt.navigation.HiltViewModelFactory;
import androidx.lifecycle.ViewModelProvider;

public class MyFragment extends Fragment {

    SharedViewModel viewModel;

    @Override
    public void onViewCreated(View view, Bundle savedInstanceState) {
        NavController navController = NavHostFragment.findNavController(this);
        NavBackStackEntry backStackEntry = navController.getBackStackEntry(R.id.my_graph);

        // The ViewModel is scoped to the `nav_graph` Navigation graph
        // and is provided using the Hilt-generated ViewModel factory
        viewModel = new ViewModelProvider(
            backStackEntry,
            HiltViewModelFactory.create(getContext(), backStackEntry)
        ).get(SharedViewModel.class);
    }
}

Compose

import androidx.hilt.navigation.compose.hiltViewModel

@Composable
fun MyAppNavHost() {
    // ...
    composable("myScreen") { backStackEntry ->
        val parentEntry = remember(backStackEntry) {
            navController.getBackStackEntry("parentNavigationRoute")
        }

        // ViewModel API available in hilt.hilt-navigation-compose
        // The ViewModel is scoped to the `parentNavigationRoute` Navigation graph
        // and is provided using the Hilt-generated ViewModel factory
        val parentViewModel: SharedViewModel = hiltViewModel(parentEntry)
        // ...
    }
}