ایجاد ViewModelها به همراه وابستگی‌ها (Views) بخشی از Android Jetpack .

مفاهیم و پیاده‌سازی Jetpack Compose

با پیروی از بهترین شیوه‌های تزریق وابستگی ، ViewModelها می‌توانند وابستگی‌ها را به عنوان پارامتر در سازنده خود دریافت کنند. این وابستگی‌ها عمدتاً از نوع دامنه یا لایه‌های داده هستند. از آنجا که چارچوب، ViewModelها را ارائه می‌دهد، برای ایجاد نمونه‌هایی از آنها به مکانیزم خاصی نیاز است. این مکانیزم رابط ViewModelProvider.Factory است. فقط پیاده‌سازی‌های این رابط می‌توانند ViewModelها را در محدوده مناسب نمونه‌سازی کنند .

ViewModelها با CreationExtras

اگر یک کلاس ViewModel در سازنده خود وابستگی دریافت می‌کند، یک factory ارائه دهید که رابط ViewModelProvider.Factory را پیاده‌سازی کند. تابع create(Class<T>, CreationExtras) را برای ارائه یک نمونه جدید از ViewModel بازنویسی کنید.

CreationExtras با APPLICATION_KEY

در ادامه مثالی از نحوه ارائه نمونه‌ای از ViewModel آمده است که یک مخزن (repository) را که در محدوده کلاس 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 از این factory استفاده کنید:

کاتلین 

import androidx.activity.viewModels

class MyActivity : AppCompatActivity() {

    private val viewModel: MyViewModel by viewModels { MyViewModel.Factory }

    // Rest of Activity code
}

جاوا 

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 ایجاد شده باشد و بنابراین به وابستگی‌های اندروید دسترسی نداشته باشد.

در این مثال، 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 قدیمی‌تر از ۲.۵.۰

اگر از نسخه‌ای از ViewModel قدیمی‌تر از 2.5.0 استفاده می‌کنید، باید factoryها را از زیرمجموعه‌ای از کلاس‌ها که ViewModelProvider.Factory را ارث‌بری می‌کنند، فراهم کنید و تابع create(Class<T>) را پیاده‌سازی کنید. بسته به اینکه ViewModel به چه وابستگی‌هایی نیاز دارد، باید کلاس متفاوتی از موارد زیر ارث‌بری شود:

اگر Application یا SavedStateHandle مورد نیاز نیستند، کافیست از ViewModelProvider.Factory کلاس را گسترش دهید.

مثال زیر از یک AbstractSavedStateViewModelFactory برای یک ViewModel استفاده می‌کند که یک repository و یک نوع SavedStateHandle را به عنوان وابستگی می‌گیرد:

کاتلین 

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
            }
        }
    }
}

جاوا 

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);
    }
}

سپس، می‌توانید از factory برای بازیابی ViewModel خود استفاده کنید:

کاتلین 

import androidx.activity.viewModels

class MyActivity : AppCompatActivity() {

    private val viewModel: MyViewModel by viewModels {
        MyViewModel.provideFactory((application as MyApplication).myRepository, this)
    }

    // Rest of Activity code
}

جاوا 

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
}
{% کلمه به کلمه %} {% فعل کمکی %} {% کلمه به کلمه %} {% فعل کمکی %}