Bootstrap

Android ViewModel

文章目录

Jetpack ViewModel

概述

ViewModel 类目的在于以注重生命周期的方式存储和管理界面相关数据。

ViewModel 可以让数据可在发生屏幕旋转等配置更改后继续留存。

官网

添加依赖库

//ktx
implementation "androidx.activity:activity-ktx:1.2.3"
implementation "androidx.fragment:fragment-ktx:1.3.6"

//Lifecycle
def lifecycle_version = "2.5.0"
//LiveData
implementation "androidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version"
implementation "androidx.lifecycle:lifecycle-common-java8:$lifecycle_version"
implementation "androidx.lifecycle:lifecycle-process:$lifecycle_version"
//ViewModel
implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version"

ViewModel生命周期

创建 ViewModel 的方法采用的是工厂模式，创建好之后将其缓存在ViewModelStore中。如果当前需要创建的ViewModel对象已经存在，则直接从ViewModelStore中取出。所以在屏幕旋转前后使用的ViewModel是同一个对象。也就是说在创建ViewModel的时候，只要传入的class对象是一样的，那么获取到的ViewModel就是同一个对象。

由于 ViewModel 的生命周期长于 Activity，因此不能将 View 或者 Activity 传递给 ViewModel，否则会引起内存泄露。

在这里插入图片描述

使用

简单使用

竖屏：

在这里插入图片描述

横屏：

在这里插入图片描述

ViewModel类实现

class MyViewModel : ViewModel() {
    private val _countLiveData = MutableLiveData<Int>()
    val countLiveData = _countLiveData
    private var count = 0

    fun increase() {
        _countLiveData.postValue(++count)
    }

    fun decrease() {
        _countLiveData.postValue(--count)
    }
}

获取ViewModel对象

// 方式一：
private val viewModel: MyViewModel by lazy {
    ViewModelProvider(this).get(MyViewModel::class.java)
}

// 方式二：
private val viewModel: MyViewModel by viewModels()

在Activity中使用

class SimpleActivity : BaseActivity() {
    private lateinit var tvOrientation: TextView
    private lateinit var tvCount: TextView

    private val viewModel: MyViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_simple)
        Log.e("TAG", "onCreate")

        tvOrientation = findViewById(R.id.tv_orientation)
        tvCount = findViewById(R.id.tv_count)

        tvOrientation.text =
            if (resources.configuration.orientation == Configuration.ORIENTATION_PORTRAIT) "竖屏" else "横屏"
        viewModel.countLiveData.observe(this, object : Observer<Int> {
            override fun onChanged(t: Int?) {
                tvCount.text = "${t}"
            }
        })
    }

    fun onIncrease(view: View) {
        viewModel.increase()
    }

    fun onDecrease(view: View) {
        viewModel.decrease()
    }

    override fun onDestroy() {
        super.onDestroy()
        Log.e("TAG", "onDestroy")
    }
}

AndroidViewModel

AndroidViewModel 是 ViewModel 的子类，拥有 Application 的实例，可以访问资源文件。

class MyAndroidViewModel(application: Application) : AndroidViewModel(application) {
    val appContext = application.applicationContext
    private val _countLiveData = MutableLiveData<Int>()
    val countLiveData = _countLiveData
    private var count = 0

    fun increase() {
        Log.e("TAG", "context:${appContext}")
        _countLiveData.postValue(++count)
    }

    fun decrease() {
        _countLiveData.postValue(--count)
    }

    override fun onCleared() {
        super.onCleared()
        Log.e("TAG", "onCleared")
    }
}

ViewModel添加依赖

定义ViewModel：

class UserViewModel(private var user: User) : ViewModel() {

    private val _userLiveData = MutableLiveData<User>()
    val userLiveData = _userLiveData

    fun showUser() {
        userLiveData.postValue(user)
    }

    fun changeUser() {
        user = User("小黑", 28, arrayOf<String>("上海市", "浦东区"))
        userLiveData.postValue(user)
    }
}

定义ViewModelFactory：

class UserViewModelFactory(private val user: User) : ViewModelProvider.Factory {

    @Suppress("UNCHECKED_CAST")
    override fun <T : ViewModel> create(modelClass: Class<T>): T {
        if (modelClass.isAssignableFrom(UserViewModel::class.java)) {
            return UserViewModel(user) as T
        }
        throw IllegalArgumentException("Unknown ViewModel class")
    }
}

使用：

class UserActivity : BaseActivity() {
    private lateinit var tvUser: TextView

    // 获取ViewModel对象，方式一：
    private val viewModel: UserViewModel by lazy {
        val factory = UserViewModelFactory(User("小白", 18, arrayOf("北京市", "朝阳区")))
        ViewModelProvider(this, factory).get(UserViewModel::class.java)
    }

    // 获取ViewModel对象，方式二：
    private val viewModel2: UserViewModel by viewModels {
        UserViewModelFactory(
            User(
                "小白",
                18,
                arrayOf("北京市", "朝阳区")
            )
        )
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_user)
        tvUser = findViewById(R.id.tv_user)

        viewModel.userLiveData.observe(this, object : Observer<User> {
            override fun onChanged(user: User) {
                tvUser.text = "${user}"
            }
        })
    }

    fun onShow(view: View) {
        viewModel.showUser()
    }

    fun onChange(view: View) {
        viewModel.changeUser()
    }
}

规范Factory：

class UserViewModel(private var user: User) : ViewModel() {

    private val _userLiveData = MutableLiveData<User>()
    val userLiveData = _userLiveData

    companion object {
        fun provideFactory(user: User): ViewModelProvider.Factory {
            return object : ViewModelProvider.Factory {
                override fun <T : ViewModel> create(modelClass: Class<T>): T {
                    if (modelClass.isAssignableFrom(UserViewModel::class.java)) {
                        return UserViewModel(user) as T
                    }
                    throw IllegalArgumentException("Unknown ViewModel class")
                }
            }
        }
    }
}

使用：

private val viewModel: UserViewModel by viewModels {
    UserViewModel.provideFactory(User("小白", 18, arrayOf("北京市", "朝阳区")))
}

Fragment之间共享数据

优点：

  • Activity不需要做其他操作。
  • Fragment之间没有任何干扰，只需要约定共享的 ViewModel。

在这里插入图片描述

定义ViewModel：

class SharedViewModel : ViewModel() {
    private val _liveData = MutableLiveData<String>()
    val liveData = _liveData

    fun setData(item: String) {
        _liveData.postValue("$item detail")
    }
}

Activity类

class SharedDataActivity : BaseActivity(R.layout.activity_sharred_data) {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        supportFragmentManager.beginTransaction()
            .replace(R.id.fl_menu, MenuFragment.newInstance())
            .replace(R.id.fl_detail, DetailFragment.newInstance())
            .commit()
    }
}

MenuFragment

class MenuFragment : BaseFragment(R.layout.fragment_menu) {
    private val sharedViewModel: SharedViewModel by activityViewModels()

    companion object {
        fun newInstance() = MenuFragment()
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        val listView = view.findViewById<ListView>(R.id.listView)
        val data = ArrayList<String>().apply {
            for (i in 0..20) {
                add("menu$i")
            }
        }
        listView.adapter = ArrayAdapter(mContext, android.R.layout.simple_list_item_1, data)
        listView.setOnItemClickListener { parent, view, position, id ->
            sharedViewModel.setData(data[position])
        }
    }
}

DetailFragment

class DetailFragment : BaseFragment(R.layout.detail_fragment) {
    private val sharedViewModel: SharedViewModel by activityViewModels()

    companion object {
        fun newInstance() = DetailFragment()
    }
    
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        val textView = view.findViewById<TextView>(R.id.textView)
        sharedViewModel.liveData.observe(viewLifecycleOwner, object : Observer<String> {
            override fun onChanged(t: String?) {
                textView.text = t
            }
        })
    }
}

ViewModel与onSaveInstanceState()区别

  • ViewModel：适用于配置变更导致的数据恢复，这是因为内存容量相对较大，可以存储较多的数据。
  • onSaveInstanceState()：适用于被系统回收后重建时的数据恢复，这是因为系统回收时应用进程会消亡，因此不能用内存存储而是使用持久化存储，同时这部分数据需要通过Bundle机制传输数据，Bundle缓冲区有大小限制，只能适用于小规模数据。
ViewModelonSaveInstanceState()持久化
存储位置在内存中在内存中在磁盘或网络
配置修改后是否存在是是是
在系统启动的进程死亡后存活否是是
关闭activity或onFinish()后是否存在否否是
数据限制支持复制类型，空间受可用内存限制适用于基本数据类型和简单的小对象，如字符串仅受限于磁盘空间
读写效率快（内存操作）慢（需要序列化和反序列化）慢（需要磁盘读写）

ViewModel源码分析

悦读

道可道，非常道；名可名，非常名。 无名，天地之始，有名，万物之母。 故常无欲，以观其妙，常有欲，以观其徼。 此两者，同出而异名，同谓之玄，玄之又玄，众妙之门。

最新收录
2024年最新Windows+VScode配置与使用git，超详细教程，赶紧收藏吧(2)，2024年最新面试篇
百分点科技获2024数字中国创新大赛·数据要素赛道最佳创新应用奖
基于YOLOv5框架的数据增强策略研究与实现：针对小规模数据集的扩展与增强技术
入职阿里巴巴数据分析师——我的10个关键转折点
GVIM工具之gvim的配色方式
vue+element-ui 七牛云分片上传
【计算机毕业设计】基于SSM框架的购物商城系统的设计与实现【源码+lw+部署文档+讲解】
kafka-3
阐述MQ的可靠性
集群空间服务器接收不到消息,解决Redis集群条件下键空间通知服务器接收不到消息的问题...
;