【Jetpack】Room + ViewModel + LiveData 综合使用 ( 核心要点说明 )

Jetpack 是一个由 Android 官方推出的一套组件，旨在帮助开发人员更便捷地构建高质量的应用程序。在 Jetpack 中，Room、ViewModel 和 LiveData 都是非常重要的组件，在实际开发中，它们经常被用于构建较复杂的应用。本文将围绕着如何综合使用 Room、ViewModel 和 LiveData 这三个核心组件展开，为大家详细介绍其核心要点和代码示例。

1.核心要点说明

1.1 Room

Room 是针对 SQLite 数据库的一个 ORM（对象关系映射）库，它提供了一种类型安全、方便快捷的方式来访问 SQLite 数据库。使用 Room 可以避免直接操作 SQLiteDatabase 的逻辑，减少程序员的工作量和出错概率。

1.2 ViewModel

ViewModel 是一个设计模式，它可以使得应用程序的 UI 和数据逻辑分离，从而更方便地管理数据。ViewModel 的核心作用就是保存和管理数据，例如将数据从 Model 中提取到 ViewModel 中，也可以在 ViewModel 内进行数据处理，而不必将数据交给 View 层或者 Model 层处理。

1.3 LiveData

LiveData 是一个可以观察数据的组件，它可以保证数据的及时更新，并且这种更新方式是基于数据的生命周期的。LiveData 具备数据驱动、生命周期感知、线程安全等特性，可以更好的协助数据和界面的交互。

2.组合方式

在实际开发中，可以通过将 Room、ViewModel 和 LiveData 组合起来使用，来构建一个更加高效的应用程序。下面是以 Room 为数据源，ViewModel 作为数据管理层，LiveData 作为数据传递媒介的组合方式：

2.1 构建 Room 数据库

首先，需要通过 Room 的注解定义需要保存的数据实体类，并且需要创建一个继承于 RoomDatabase 的抽象基类。

@Entity(tableName = "user")
data class User(
    @PrimaryKey(autoGenerate = true)
    var id: Int = 0,
    var name: String,
    var age: Int
)

@Dao
interface UserDao {
    @Insert
    suspend fun insertUser(user: User)

    @Update
    suspend fun updateUser(user: User)

    @Query("SELECT * FROM user WHERE id = :userId")
    suspend fun getUserById(userId: Int): User?
}

@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao

    companion object {
        private const val DATABASE_NAME = "app_database"

        @Volatile
        private var instance: AppDatabase? = null

        fun getInstance(context: Context): AppDatabase {
            return instance ?: synchronized(this) {
                instance ?: Room.databaseBuilder(
                    context.applicationContext,
                    AppDatabase::class.java,
                    DATABASE_NAME
                ).build()
            }
        }
    }
}

2.2 创建 ViewModel

创建一个继承于 AndroidViewModel 的 ViewModel 类，并将数据源指向 Room 数据库，同时在 ViewModel 中使用协程进行数据访问操作，以此来确保异步访问 Room 的线程安全。

class UserViewModel(application: Application): AndroidViewModel(application) {
    private val userDao = AppDatabase.getInstance(application).userDao()

    private val _userByIdLiveData = MutableLiveData<User>()
    val userByIdLiveData: LiveData<User>
        get() = _userByIdLiveData

    fun getUserById(userId: Int) {
        viewModelScope.launch {
            val user = userDao.getUserById(userId)
            user?.let {
                _userByIdLiveData.postValue(user)
            }
        }
    }

    fun insertUser(user: User) {
        viewModelScope.launch {
            userDao.insertUser(user)
        }
    }

    fun updateUser(user: User) {
        viewModelScope.launch {
            userDao.updateUser(user)
        }
    }
}

2.3 使用 LiveData 传递数据

在 Activity 或 Fragment 中，通过获取 ViewModel 实例，可以观察 LiveData 中的数据，并且在数据变化时相应地进行 UI 的更新。

class MainActivity : AppCompatActivity() {
    private lateinit var binding: ActivityMainBinding
    private lateinit var userViewModel: UserViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        binding = DataBindingUtil.setContentView(this, R.layout.activity_main)

        userViewModel = ViewModelProvider(this).get(UserViewModel::class.java)

        binding.button.setOnClickListener {
            userViewModel.getUserById(1)
        }

        userViewModel.userByIdLiveData.observe(this, Observer<User> {
            binding.textView.text = it?.name
        })
    }
}

3.代码示例

上述示例代码可能还不够直观，下面提供一个完整的代码示例来展示 Room、ViewModel 和 LiveData 的组合用法。

3.1 定义数据实体类

@Entity(tableName = "user")
data class User(
    @PrimaryKey(autoGenerate = true)
    var id: Int = 0,
    var name: String = "",
    var age: Int = 0
)

3.2 定义 Dao 接口

@Dao
interface UserDao {
    @Insert
    suspend fun insertUser(user: User)

    @Update
    suspend fun updateUser(user: User)

    @Query("SELECT * FROM user WHERE id = :userId")
    suspend fun getUserById(userId: Int): User?
}

3.3 创建 Room 数据库

@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao

    companion object {
        private const val DATABASE_NAME = "app_database"

        @Volatile
        private var instance: AppDatabase? = null

        fun getInstance(context: Context): AppDatabase {
            return instance ?: synchronized(this) {
                instance ?: Room.databaseBuilder(
                    context.applicationContext,
                    AppDatabase::class.java,
                    DATABASE_NAME
                ).build()
            }
        }
    }
}

3.4 创建 ViewModel

class UserViewModel(application: Application): AndroidViewModel(application) {
    private val userDao = AppDatabase.getInstance(application).userDao()

    private val _userByIdLiveData = MutableLiveData<User>()
    val userByIdLiveData: LiveData<User>
        get() = _userByIdLiveData

    fun getUserById(userId: Int) {
        viewModelScope.launch {
            val user = userDao.getUserById(userId)
            user?.let {
                _userByIdLiveData.postValue(user)
            }
        }
    }

    fun insertUser(user: User) {
        viewModelScope.launch {
            userDao.insertUser(user)
        }
    }

    fun updateUser(user: User) 
        viewModelScope.launch {
            userDao.updateUser(user)
        }
    }
}

3.5 在 Activity 中使用 ViewModel 和 LiveData

class MainActivity : AppCompatActivity() {
    private lateinit var binding: ActivityMainBinding
    private lateinit var userViewModel: UserViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        binding = DataBindingUtil.setContentView(this, R.layout.activity_main)

        userViewModel = ViewModelProvider(this).get(UserViewModel::class.java)

        binding.button.setOnClickListener {
            userViewModel.getUserById(1)
        }

        userViewModel.userByIdLiveData.observe(this, Observer<User> {
            binding.textView.text = it?.name
        })
    }
}

在这个示例中，我们已经成功地将 Room、ViewModel 和 LiveData 组合起来使用，从而构建了一个高效的应用程序。我们可以通过定义数据实体类、创建 Room 数据库、创建 ViewModel 以及在 Activity（或 Fragment）中使用 ViewModel 和 LiveData 来实现这一目标。

4.总结

Room、ViewModel 和 LiveData 是 Android Jetpack 最常用的三个组件之一，它们的功能和作用都非常明确，可以分别负责数据存储、数据管理以及数据传递等方面的工作。在实际开发中，我们可以结合使用这三个组件来构建一个高效的应用程序，并且可以通过协程等方式来确保 Room 数据库的线程安全和异步访问。

总的来说，Room、ViewModel 和 LiveData 的组合使用可以极大地提升应用程序的性能和可维护性，同时也可以帮助开发者更好地理解和掌握 Android Jetpack 的相关知识。