Android(Kotlin)Jetpack组件之ViewModel使用与API

  该文章作为学习总结与API查询，如有错误欢迎各位大佬指正，对您有帮助的还望点赞支持下哟(* ^ ▽ ^ *)

  欢迎大家聊聊理解，互相探讨，同时我也会将经典的问题更新到文章中，方便学习。

ViewModel概述

  ViewModel的作用，是专门用于存放与界面相关的数据的，帮助Activity分担一部分工作。即，界面上能看到的数据，它的相关变量都应该存放在ViewModel中，而不是Activity中，以此来减少Activity中的逻辑。

• 当手机发生横竖屏切换时，ViewModel不会被重新创建，这样就可以保证界面上显示的数据不会丢失。
• 推荐写法：给每一个Activity和Fragment都创建一个对应的ViewModel
• ViewModel不能直接创建的原因，ViewModle有独立的生命周期，其生命周期比Activity长。如果在Activity的生命周期 如：onCreate() 中，创建一个新的ViewModel，那么每次回调都会进行创建，这样就没法保留界面上的数据了。
• 使用ViewModel，需要在Activity中，手动获取ViewModel中的最新数据。如果想数据发送变化时，主动通知Activity，可使用LiveData 。

  对于Activity，手机发生横竖屏切换时，Activity会被重新创建，同时存放在Activity中的数据也会丢失，这样导致在某些场景下，需要编写大量保存和恢复数据的相关逻辑，使用ViewModel就可以避免这种问题。
  Activity与ViewModel生命周期见下图

ViewModel使用

补充：编写这个例子时，遇到的问题

• 无法使用sp.edit1语法糖，原因是AndroidStudio默认安装jvm1.6进行编译的，需要在module的build.gradle文件中添加一下配置

android {
	// ...
    compileOptions {
        sourceCompatibility = 1.8
        targetCompatibility = 1.8
    }

    kotlinOptions {
        jvmTarget = "1.8"
    }

}

1.依赖库

  如果没有添加ViewModel依赖库的，先添加下面依赖库进行下载

在moudle的build.gradle中，添加下面依赖
dependencies {

   //如果使用2.2.0以及以前的版本，则加载下面依赖库，该依赖库中有ViewModelProviders.of方法，会被标识为弃用状态
    implementation "androidx.lifecycle:lifecycle-extensions:2.2.0"
    
    // 如果使用2.2.0之后版本，直接使用下面依赖库，该依赖库中没有ViewModelProviders.of方法
    implementation "androidx.lifecycle:lifecycle-process:2.2.0"

// 以上两种依赖lifecycle-extensions  与  lifecycle-process选择一种即可。
}

相关版本资料：lifecycle版本信息，google.cn官方地址

2.创建ViewModel

  我们不可以直接创建ViewModel实例，要通过ViewModelProviders 或 ViewModelProvider进行创建

在"androidx.lifecycle:lifecycle-extensions:2.2.0"及以前版本中，可以 使用ViewModelProviders.of 方法。

viewModel = ViewModelProviders.of(“定义的Activity或者Fragment实例”).get(“定义的Model名称”::class.java)

//例如:
class MainActivity : AppCompatActivity() {
    lateinit var viewModel: MyMainViewModel
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        viewModel = ViewModelProviders.of(this).get(MyMainViewModel::class.java)
    }

在"androidx.lifecycle:lifecycle-process:2.2.0"中， 没有ViewModelProviders.of的创建方式，改为下面的方式进行创建。

viewModel = ViewModelProvider(“定义的Activity或者Fragment实例”,
            ViewModelProvider.AndroidViewModelFactory.getInstance(application)).get(“定义的Model名称”::class.java)

//例如:
class MainActivity : AppCompatActivity() {
    lateinit var viewModel: MyMainViewModel
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        viewModel = ViewModelProvider(this,
           ViewModelProvider.AndroidViewModelFactory.getInstance(application)).get(MyMainViewModel::class.java)
    }

3.向ViewModel传递参数

  创建ViewModel实例时，我们无法通过构造函数传递一些参数。ViewModel提供了ViewModelProvider.Factory来解决参数传递问题，这样可以使用SharedPreferences实现退出程序之后再次打开时，数据仍然不会丢的效果。

创建一个实现了ViewModelProvider.Factory类，并在必须实现的create方法中创建自定义的ViewModel对象，以及需要传递的值。这样就只需在创建ViewModel地时，再赋值一个自定义创建的ViewModelProvider.Factory参数即可。

//例如:
class MainViewModelFactory(private val countResume: Int) : ViewModelProvider.Factory {
    override fun <T : ViewModel?> create(modelClass: Class<T>): T {
        return MainViewModel(countResume) as T
    }
}

4. 简单例子

例子的效果是：点击一次按钮，改变界面上的文字，并在屏幕旋转，退出程序后仍然可以记录上次的文字状态，以及重置文本内容的按钮。

布局相关 ： 一个文本，两个按钮

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    android:gravity="center"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/tv_content"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"/>

    <Button
        android:id="@+id/btn_add_one"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Show"/>

    <Button
        android:id="@+id/btn_clear_num"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Reset"/>

</LinearLayout>

MainActivity类

import android.content.Context
import android.content.SharedPreferences
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import androidx.lifecycle.ViewModelProviders
import kotlinx.android.synthetic.main.activity_main.*
import androidx.core.content.edit as edit1

class MainActivity : AppCompatActivity() {

    lateinit var viewModel: MainViewModel
    lateinit var sp: SharedPreferences

    val textList = listOf("1¥","2¥","3¥")
    var count = 0

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        //创建SharedPreferences
        sp = getPreferences(Context.MODE_PRIVATE)
        val textResume = sp.getString("textResume","1¥")
        viewModel = ViewModelProviders.of(this,MainViewModelFactory(textResume!!))
            .get(MainViewModel::class.java)

        btn_add_one.setOnClickListener {
            count++
            if (count > (textList.size - 1)){
                count = 0
            }
            viewModel.text = textList[count]
            updateUI()
        }

        btn_clear_num.setOnClickListener {
            count = 0
            viewModel.text = "1¥"
            updateUI()
        }
        updateUI()
    }

    private fun updateUI() {
        tv_content.text = viewModel.text
    }

    override fun onPause() {
        super.onPause()

        sp.edit1 {
            putString("textResume",viewModel.text)
        }
    }
}

自定义ViewModel的类 MainViewModel

import androidx.lifecycle.ViewModel

class MainViewModel(textResume: String) : ViewModel() {
    var text = textResume
}

自定义ViewModelProvider.Factory的类 MainViewModelFactory

import androidx.lifecycle.ViewModel
import androidx.lifecycle.ViewModelProvider

class MainViewModelFactory(private val textResume: String) : ViewModelProvider.Factory {
    override fun <T : ViewModel?> create(modelClass: Class<T>): T {
        return MainViewModel(textResume) as T
    }
}

觉得有帮助的点下赞哟，毕竟三连步骤更多，嘻嘻，谢谢大家的支持(* ^ ▽ ^ *)