盒子
盒子
文章目录
  1. 前言
  2. 添加依赖
  3. Room
    1. Entity
    2. DAO
    3. Database
    4. 使用
  4. 总结
  5. 相关文章
  6. 关注

Android Architecture Components Part1:Room

2018.06.07 Rouse android  热度 ℃

cover

前言

Android Architecture Components（AAC）首次发布与2017 GoogleI/O大会，经过近一年的维护，现在Google团队已经发布了稳定版（v1.1.1）。能够更好的帮助我们来构建自己的App应用，如果你还没有了解ACC现在时间刚刚好，来不及解释，赶紧上车吧。

ACC是一个架构组件，它能帮忙我们更好的来管理我们的App，方便我们的开发。它能帮助我们的App更好的存储数据、管理生命周期、进行模块化、避免常见的错误、减少样板文件的编写。

ACC主要由4个单一组件组成，分别为：Room、LiveData、Lifecycle与ViewModel。它们每一个都是独立存在的组件，我们可以单独使用其中几个，又或者可以将它们全部整合到一起。所以对于ACC它提供了更好的使用灵活性，方便我们集成到我们的App中。

今天主要是对ACC其中的Room组件进行分析。Room是一个稳健的SQL对象映射库，用来帮助我们快速的实现数据本地存储。至于为何要使用本地数据库，自然是当用户无网络或者网络差的时候，能够更好的提高用户对我们App的体验。

添加依赖

在使用Room之前，我们还是要在项目中对其进行依赖添加。
首先在你的项目的根目录下的build.gradle中添加google()库，代码如下：

1
2
3
4
5
6
allprojects {
    repositories {
        jcenter()
        google()
    }
}

之后打开你的App或者module中的build.gradle文件，在dependencies中添加如下代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
dependencies {
    def room_version = "1.1.0" // or, for latest rc, use "1.1.1-rc1"
 
    implementation "android.arch.persistence.room:runtime:$room_version"
    annotationProcessor "android.arch.persistence.room:compiler:$room_version"
 
    // optional - RxJava support for Room
    implementation "android.arch.persistence.room:rxjava2:$room_version"
 
    // optional - Guava support for Room, including Optional and ListenableFuture
    implementation "android.arch.persistence.room:guava:$room_version"
 
    // Test helpers
    testImplementation "android.arch.persistence.room:testing:$room_version"
}

Room

上面的依赖添加完成后，接下来我们可以正式使用Room。在Android App中进行本地数据的存储都是使用SQLite，当我们使用原生的SQLite进行本地数据库的编写时，我们不仅要定义数据库结构，还要创建SQLiteHelper，编写一连串的SQL语句。这样代码量与复杂度不断上升，这不是我们想要的。而Room正好可以帮助我们减少代码、简化复杂度。

对于Room的使用主要由三部分构成：

  1. Entity：标识数据库中的表结构
  2. DAO： 标识提供获取数据库表中的数据方法
  3. Database：标识所需要创建的数据库

以上三部分在代码中都是通过注释来实现，从而达到代码的精简。

Entity

Entity作用在model上，即我们与数据表中的字段所匹配的model类。现在我们来建立一个联系人相关的model，对于正常的model建立如下：

1
data class ContactsModel(val id: Int, val name: String, val phone: String)

现在我们要把ContactsModel映射到数据库中的一种表，只需进行如下操作：

1
2
3
4
5
6
7
8
9
10
@Entity(tableName = "contacts")
data class ContactsModel(
        @PrimaryKey
        @ColumnInfo(name = "contacts_id")
        val id: Int,
        @ColumnInfo(name = "name")
        val name: String,
        @ColumnInfo(name = "phone")
        val phone: String
)

首先我们在ContactsModel中添加@Entity注释，表明它将映射成一种表。在Entity中可以通过使用tableName来为该表命名，这里将其命名未contacts。

除此之外，使用@ColumnInfo来标明表中的字段，@PrimaryKey来标明表的主键。其中@ColumnInfo也可以通过(name = “name”)来命名字段名。当然还有别的注释例如外键的标明：@ForeignKey

DAO

数据库表建好了，现在是提供操作数据表中的数据的方法。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Dao
interface ContactsDao {
 
    @Query("SELECT * FROM contacts")
    fun getAllContacts(): List<ContactsModel>
 
    @Query("SELECT * FROM contacts WHERE contacts_id = :id")
    fun getContactsById(id: Int): LiveData<ContactsModel>
 
    @Insert(onConflict = OnConflictStrategy.REPLACE)
    fun insertContacts(contactsModel: ContactsModel)
 
    @Query("UPDATE contacts SET name = :name AND phone = :phone WHERE contacts_id = :id")
    fun updateContacts(id: Int, name: String, phone: String)
 
    @Query("DELETE FROM contacts WHERE contacts_id = :id")
    fun deleteContacts(id: Int)

这里我们只需创建一个接口，通过@Dao来标明它是提供操作数据表的方法集。要注意它必须为interface，在接口中我们只需定义接口方法即可。与平常的接口方法定义不同的是，我们必须在每一个接口方法上通过注释来标明该方法的作用。

例如getAllContacts()方法，我们为了让它实现获取contacts表中的所有数据，我们需要在其方法中添加@Query注释，由于是查询方法，自然是使用Query，如果是插入方法就是Insert(第三个方法)。其次()中的内容就是正常的查询语句。这里是获取所有的Contacts，所以我们使用

1
@Query("SELECT * FROM contacts")

对于有参数的sql语句编写，可以查看第二个方法，参数值只需在对应的方法参数名前加入:前缀，这就是传参的格式。

1
2
@Query("SELECT * FROM contacts WHERE contacts_id = :id")
fun getContactsById(id: Int): LiveData<ContactsModel>

Room就是这么简单，通过定义接口与接口方法的形式，再结合注释来简化代码量与复杂度。当然最终Room会根据注释，编译器会帮我们实现这些接口方法。我们可以build项目，然后我们就可以搜索到ContactsDao_Impl类，这个读者可以自行尝试。本质是ContactsDao_Impl实现了ContactsDao接口。

Room的强大之一是：它可以在编译时检测你的SQL语句是否编写正确，如果编写错误将导致编译失败。这样就可以避免App在运行时导致崩溃。这个读者可以自行测试一下。

Database

现在数据表有了，对表的操作方法也有了，最后就差数据库来保存各个数据表了。Talk is cheap. Show me the code。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Database(entities = arrayOf(ContactsModel::class), version = 1)
abstract class ContactsDataBase : RoomDatabase() {
 
    abstract fun contactsDao(): ContactsDao
 
    companion object {
        private var instance: ContactsDataBase? = null
        fun getInstance(context: Context): ContactsDataBase {
            if (instance == null) {
                instance = Room.databaseBuilder(context.applicationContext,
                        ContactsDataBase::class.java,
                        "contacts.db").build()
            }
            return instance as ContactsDataBase
        }
    }
}

没错，还是使用注释，这里我们定义ContactsDataBase抽象类，让它继承RoomDatabase抽象类。当然也是同@Database来标明它是一个数据库。它接收两个参数，分别为entities与version，前者接收的类型是Class[]数组，内容为对于表的Class；后者是int的数据库版本号。

在ContactsDataBase中还需定义一个抽象方法，让它返回由@Dao注释的ContactsDao，即提供获取数据表的方法。本质的为数据库暴露操作数据表的入口。至于它的具体方法实现也可以通过build来查看对应的自动生成文件ContactsDataBase_Impl类。

因为contactsDao是数据库的唯一入口，避免每次对数据库进行操作时都创建ContactsDataBase实例，如上代码我们可以使用单例模式来减少实例频繁创建的开销。

使用

经过上面的Entity、DAO与Database的创建，现在我们已经有了完整的本地数据库结构。接下来我们来看史上最简数据库使用的调用代码：

1
2
3
private val mContactsDao by lazy { ContactsDataBase.getInstance(application).contactsDao() }
 
fun getContactsById(id: Int): LiveData<ContactsModel> = mContactsDao.getContactsById(id)

你没看错只需两行代码，我们就能获取数据库中Contacts表中的所用数据。

第一行代码我们获取了ContactsDao实例，该实例包含操作数据表的所以方法。而第二行代码就是调用ContactsDao中的操作方法。返回我们所需的数据。

在第二行代码，细心的你们可能会发现它返回了LiveData类型数据。它是ACC的另一强大组件，这也是Room的另一强大之处，它可以直接返回LiveData数据类型，完美与LiveData结合。至于LiveData的作用，敬请关注下一篇文章Android Architecture Components Part2:LiveData。

总结

如果你的App使用了Room，那么你的App本地数据获取架构将会是这样的

Room

最后文章中的代码都可以在Github中获取到。使用时请将分支切换到feat_architecture_components

相关文章

Android Architecture Components Part2:LiveData
Android Architecture Components Part3:Lifecycle
Android Architecture Components Part4:ViewModel

关注

怪谈时间到了

支持一下
赞赏是一门艺术