สร้าง ViewModel ที่มีทรัพยากร Dependency เป็นส่วนหนึ่งของ Android Jetpack

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

ดูโมเดลด้วย CreationExtras

หากคลาส ViewModel ได้รับทรัพยากร Dependency ในตัวสร้าง โปรดระบุค่าจากโรงงาน ที่ใช้อินเทอร์เฟซ 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 เป็นทรัพยากร Dependency:

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 API ที่มีเอกลักษณ์:

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>) ขึ้นอยู่กับทรัพยากร Dependency ใด ต้องการ ViewModel ต้องขยายคลาสอื่นจาก

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

ตัวอย่างต่อไปนี้ใช้ AbstractSavedStateViewModelFactory สำหรับ ViewModel ที่ใช้ที่เก็บและประเภท 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
        )
    )
) {
    // ...
}