สร้าง ViewModels ที่มี Dependency (Views)   ซึ่งเป็นส่วนหนึ่งของ Android Jetpack.

แนวคิดและการใช้งาน Jetpack Compose

ViewModels สามารถใช้ทรัพยากร Dependency เป็นพารามิเตอร์ในเครื่องมือสร้างได้ตามแนวทางปฏิบัติแนะนำของ Dependency Injection ซึ่งส่วนใหญ่จะเป็นประเภท จากชั้นโดเมนหรือชั้นข้อมูล เนื่องจากเฟรมเวิร์กมี ViewModels จึงต้องมีกลไกพิเศษในการสร้างอินสแตนซ์ของ ViewModels กลไกดังกล่าวคืออินเทอร์เฟซ ViewModelProvider.Factory เฉพาะการใช้งานอินเทอร์เฟซนี้เท่านั้นที่สร้างอินสแตนซ์ของ ViewModels ในขอบเขตที่เหมาะสมได้

ViewModels ที่มี CreationExtras

หากคลาส ViewModel ได้รับทรัพยากร Dependency ในเครื่องมือสร้าง ให้ระบุ Factory ที่ใช้อินเทอร์เฟซ ViewModelProvider.Factory ลบล้างฟังก์ชัน create(Class<T>, CreationExtras) เพื่อระบุอินสแตนซ์ใหม่ของ ViewModel

CreationExtras ที่มี APPLICATION_KEY

ตัวอย่างต่อไปนี้แสดงวิธีระบุอินสแตนซ์ของ ViewModel ที่ ใช้ ที่เก็บข้อมูล ซึ่งกำหนดขอบเขตไว้ที่คลาส Application และ SavedStateHandle เป็นทรัพยากร Dependency

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

จากนั้นคุณจะใช้ Factory นี้เมื่อดึงข้อมูลอินสแตนซ์ของ 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

คุณสามารถส่ง Dependency ไปยัง ViewModel ผ่าน CreationExtras ได้โดยการสร้างคีย์ที่กำหนดเอง วิธีนี้อาจมีประโยชน์หาก ViewModel ของคุณขึ้นอยู่กับออบเจ็กต์ที่เข้าถึงไม่ได้ผ่านคลาส Application และ APPLICATION_KEY ตัวอย่างเช่น เมื่อ ViewModel ของคุณสร้างขึ้นภายในโมดูล Kotlin Multiplatform จึงไม่มีสิทธิ์เข้าถึง Dependency ของ 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,
                )
            }
        }
    }
}

คุณสามารถสร้างอินสแตนซ์ของ 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]

Factory สำหรับ ViewModel เวอร์ชันเก่ากว่า 2.5.0

หากคุณใช้เวอร์ชันของ ViewModel ที่เก่ากว่า 2.5.0 คุณต้องระบุ Factory จากคลาสย่อยที่ขยาย ViewModelProvider.Factory และใช้ฟังก์ชัน create(Class<T>) คุณต้องขยายคลาสที่แตกต่างกันออกไป ทั้งนี้ขึ้นอยู่กับ Dependency ที่ ViewModel ต้องการ

หากไม่จำเป็นต้องใช้ Application หรือ SavedStateHandle ให้ขยายจาก ViewModelProvider.Factory

ตัวอย่างต่อไปนี้ใช้ AbstractSavedStateViewModelFactory สำหรับ ViewModel ที่ใช้ที่เก็บข้อมูลและประเภท SavedStateHandle เป็น Dependency

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

จากนั้นคุณจะใช้ Factory เพื่อดึงข้อมูล 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
}