快捷導(dǎo)航

在?Kotlin?中ViewModel?的獲取及使用指南

更新時(shí)間：2025年10月24日 16:54:40 作者：橙子19911016

在Kotlin中,by viewModels()和by viewModels{?}都是用來在?Activity?或?Fragment?中獲取?ViewModel?實(shí)例的屬性委托,接下來通過本文給大家介紹在Kotlin中ViewModel的獲取及使用指南,感興趣的朋友跟隨小編一起看看吧

在 Kotlin 中，ViewModel 的獲取

在 Kotlin 中，by viewModels() 和 by viewModels { } 都是用來在 Activity 或 Fragment 中獲取 ViewModel 實(shí)例的屬性委托。它們之間的區(qū)別在于是否傳遞自定義的 ViewModelProvider.Factory：

by viewModels()：使用默認(rèn)的 ViewModelProvider.Factory，通常，這個(gè)默認(rèn)工廠會(huì)使用 ViewModel 的無參構(gòu)造函數(shù)來創(chuàng)建 ViewModel 實(shí)例。
- 如果 ViewModel 沒有參數(shù)，或者使用了依賴注入（如 Hilt）來提供 ViewModel，可以使用這種形式；
by viewModels {...}：花括號(hào)內(nèi)是一個(gè) Lambda，用于提供自定義的 ViewModelProvider.Factory。當(dāng) ViewModel 需要參數(shù)時(shí)使用，必須提供自定義的 Factory 來創(chuàng)建 ViewModel 實(shí)例；

使用指南：

如果 ViewModel 不需要外部參數(shù)：使用 by viewModel()；
如果 ViewModel 需要參數(shù)或依賴：使用 by viewModels { customFactory }；
如果使用 Hilt/Dagger 等 DI 框架：使用 by viewModels()（框架自動(dòng)處理）；

添加依賴：

dependencies {
    // 必需：ViewModel 核心
    implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.7.0"
    // 必需：Activity 或 Fragment 的委托支持（二選一或都選）
    implementation "androidx.activity:activity-ktx:1.8.2"        // Activity 中使用
    implementation "androidx.fragment:fragment-ktx:1.6.2"       // Fragment 中使用
}

例如：假設(shè)我們有一個(gè)需要參數(shù)的 ViewModel:

class MyViewModel(private val repository: MyRepository) : ViewModel() {
    // ...
}

那么，在 Activity 或 Fragment 中，我們需要提供一個(gè) Factory 來創(chuàng)建 MyViewModel：

private val viewModel: MyViewModel by viewModels {
    object : ViewModelProvider.Factory {
        override fun <T : ViewModel> create(modelClass: Class<T>): T {
            // 假設(shè)我們已經(jīng)有了MyRepository的實(shí)例
            return MyViewModel(myRepository) as T
        }
    }
}

或者，你可以定義一個(gè) ViewModelFactory 類：

class MyViewModelFactory(private val repository: MyRepository) : ViewModelProvider.Factory {
    override fun <T : ViewModel> create(modelClass: Class<T>): T {
        if (modelClass.isAssignableFrom(MyViewModel::class.java)) {
            @Suppress("UNCHECKED_CAST")
            return MyViewModel(repository) as T
        }
        throw IllegalArgumentException("Unknown ViewModel class")
    }
}

然后，在委托屬性中使用：

private val viewModel: MyViewModel by viewModels {
    MyViewModelFactory(myRepository)
}

補(bǔ)充：Kotin- Fragment 獲取 ViewModel 實(shí)例正確方式

Kotin- Fragment 獲取 ViewModel 實(shí)例正確方式

1. 第一種獲取方式：

通常獲取 ViewModel 方法：

 val model : BlankViewModel by lazy{
        ViewModelProvider(this,BlankViewModel.BlankViewModelFactory()).get(BlankViewModel::class.java)
 }
 //該方法已被廢棄：viewModel = ViewModelProvider(this).get(MainViewModel::class.java)

對(duì)應(yīng)的 BlankViewModelFactory 方法

class BlankViewModel : ViewModel() {
    // TODO: Implement the ViewModel
    private val number = MutableLiveData<Int>();
    private var i=0
    fun getNumber() : LiveData<Int>{
        return number
    }
    fun addNumber(){
        i++
        number.value = i
    }
    class BlankViewModelFactory(): ViewModelProvider.Factory{
        override fun <T : ViewModel?> create(modelClass: Class<T>): T {
            return BlankViewModel() as T
        }
    }
}

當(dāng)我們創(chuàng)建 Fragment 頁面，并將頁面添加到一個(gè) Activity 頁面中時(shí)，想要實(shí)現(xiàn)在 Activity 中調(diào)用 ViewModel 中的方法使得 livedata 的數(shù)據(jù)改變，并希望 Fragment 頁面也可以監(jiān)聽到變化，此時(shí)就需要獲取到同一個(gè) ViewModel 實(shí)例，才能保證兩個(gè)頁面的數(shù)據(jù)同時(shí)變化。

首先，在 Activity 中獲取 BlankViewModel ，并通過點(diǎn)擊按鈕調(diào)用其中的 addNumber 方法，讓變量+1

class FragmentActivity : AppCompatActivity() {
    val model : BlankViewModel by lazy{
        ViewModelProvider(this,BlankViewModel.BlankViewModelFactory()).get(BlankViewModel::class.java)
    }
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_fragment)
        val button = findViewById<Button>(R.id.add).setOnClickListener {
              model.addNumber()
        }
    }
}

第一個(gè) Fragment 頁面：

class LeftFragment : Fragment() {
    val model : BlankViewModel by lazy{
        ViewModelProvider(requireActivity(),BlankViewModel.BlankViewModelFactory()).get(BlankViewModel::class.java)
    }
    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?,
                              savedInstanceState: Bundle?): View? {
        return inflater.inflate(R.layout.blank_fragment, container, false)
    }
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        val left = view.findViewById<TextView>(R.id.left_tv)
        model.getNumber().observe(requireActivity(), Observer {
            Log.d("IT",""+it)
            left.text = it.toString()
        })
    }
}

在獲取 ViewModel 實(shí)例時(shí)，ViewModelProvider 中的第一個(gè)參數(shù) ViewModelStoreOwner 對(duì)象傳遞的是requireActivity 方法，這個(gè)方法里就是獲取當(dāng)前的 Activity 實(shí)例；如果該位置仍然傳 this ，則獲取的是與 Activity 不同的 ViewModel 實(shí)例，這樣 Activity 點(diǎn)擊按鈕時(shí) Fragment 頁面的數(shù)值并不會(huì)變化。

val model : BlankViewModel by lazy{     
  ViewModelProvider(requireActivity(),BlankViewModel.BlankViewModelFactory()).get(BlankViewModel::class.java)
}

在觀察變化的方法中，也是同樣的道理：

  model.getNumber().observe(requireActivity(), Observer {
            left.text = it.toString()
 })

另一個(gè) Fragment 頁面和它一樣，這里就不添加了。

2. 第二種獲取方式

通過ktx簡化：
添加 ktx 依賴，這里要注意版本，我的 kotlin 版本過低，下載高版本會(huì)報(bào)紅：

implementation "androidx.fragment:fragment-ktx:1.2.5"
implementation "androidx.activity:activity-ktx:1.0.0-alpha03"

在 Activity 頁面中：

//這里省略掉其他部分
val model by viewModels<BlankViewModel>()

在 Fragment 頁面中

//這里省略掉其他部分
val model by activityViewModels<BlankViewModel>()
//這里可以正常傳this
model.getNumber().observe(this, Observer {
            Log.d("IT",""+it)
            left.text = it.toString()
})

以上就是獲取同一 ViewModel 實(shí)例的方法。如有不對(duì)，請(qǐng)指正。

到此這篇關(guān)于在 Kotlin 中ViewModel 的獲取及使用指南的文章就介紹到這了,更多相關(guān)Kotlin ViewModel 獲取內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: