ایجاد ViewModels با وابستگی بخشی از Android Jetpack .

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

ViewModels با CreationExtras

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

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() استفاده کنید و آن را به ViewModel ارسال کنید.

Creation Extras با APPLICATION_KEY

در زیر نمونه‌ای از نحوه ارائه نمونه‌ای از ViewModel است که یک مخزن را به کلاس Application و SavedStateHandle به عنوان وابستگی می‌برد:

کاتلین 

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

جاوا 

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، می توانید از این کارخانه استفاده کنید:

کاتلین 

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
}

Jetpack Compose 

import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun MyScreen(
    modifier: Modifier = Modifier,
    viewModel: MyViewModel = viewModel(factory = MyViewModel.Factory)
) {
    // ...
}

روش دیگر، از ViewModel factory DSL برای ایجاد کارخانه با استفاده از یک API اصطلاحی 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
                )
            }
        }
    }
}

پارامترهای سفارشی را به عنوان 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 یا با Jetpack Compose نمونه‌سازی کنید.

کاتلین 

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]

Jetpack Compose 

import androidx.lifecycle.viewmodel.MutableCreationExtras
import androidx.lifecycle.viewmodel.compose.viewModel
// ...
@Composable
fun MyApp(myRepository: MyRepository) {
    val extras = MutableCreationExtras().apply {
        set(MyViewModel.MY_REPOSITORY_KEY, myRepository)
    }
    val viewModel: MyViewModel = viewModel(
        factory = MyViewModel.Factory,
        extras = extras,
    )
}

Factories برای ViewModel نسخه قدیمی تر از 2.5.0

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

اگر Application یا SavedStateHandle نیاز نیست، به سادگی از ViewModelProvider.Factory گسترش دهید.

مثال زیر از AbstractSavedStateViewModelFactory برای ViewModel استفاده می کند که یک مخزن و یک نوع 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);
    }
}

سپس، می توانید از کارخانه برای بازیابی 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
}

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
        )
    )
) {
    // ...
}
{% کلمه به کلمه %} {% آخر کلمه %} {% کلمه به کلمه %} {% آخر کلمه %}