使用Kotlin构建MVVM应用程序—第三部分：Room

时间 2019-11-30

标签使用 kotlin 构建 mvvm 应用程序第三部分 room 繁體版

原文原文链接

写在前面

这是使用Kotlin构建MVVM应用程序—第三部分：Roomhtml

在上一篇中咱们了解了MVVM是怎么处理网络数据的，而这一篇则介绍的是如何进行数据持久化。java

Room

Room是google推出的一个数据持久化库，它是 Architecture Component的一部分。它让SQLiteDatabase的使用变得简单，大大减小了重复的代码，而且把SQL查询的检查放在了编译时。android

Room使用起来很是简单，并且能够和RxJava配合使用，和咱们的技术体系十分契合。git

加入依赖

首先在项目的build.gradle中加入github

allprojects {
    repositories {
        maven {
            url 'https://maven.google.com'
        }
        jcenter()
    }
}
复制代码

接着在app的build.gradle中加入它的依赖sql

//room (local)
implementation 'android.arch.persistence.room:runtime:1.0.0'
implementation 'android.arch.persistence.room:rxjava2:1.0.0'
kapt 'android.arch.persistence.room:compiler:1.0.0'
//facebook出品，可在Chrome中查看数据库
implementation 'com.facebook.stetho:stetho:1.5.0'
复制代码

如今的结构数据库

这里咱们多了一层Repository，使用这一层来确保单一数据源，保证数据来源的惟一和正确性（即不论是来自网络或是本地缓存的）。ViewModel层并不须要知道它使用到的数据是怎么来的，就好似开发者并不须要知道设计师是如何画出UI图的同样。api

开始正文缓存

使用Room进行持久化

新建相应的表

Room为每一个用@Entity注解了的类建立一张表服务器

@Entity(tableName = "articles")
class Article(var title: String?){

    @PrimaryKey
    @ColumnInfo(name = "articleid")
    var id: Int = 0
    var content: String? = null
    var readme: String? = null
    @SerializedName("describe")
    var description: String? = null
    var click: Int = 0
    var channel: Int = 0
    var comments: Int = 0
    var stow: Int = 0
    var upvote: Int = 0
    var downvote: Int = 0
    var url: String? = null
    var pubDate: String? = null
    var thumbnail: String? = null
}
复制代码

建立相关的Dao

至关于Retrofit中的api接口

DAO负责定义操做数据库的方法。在SQLite实现的版本中，全部的查询都是在LocalUserDataSource文件中完成的，里面主要是使用了Cursor对象来完成查询的工做。有了Room，咱们再也不须要Cursor的相关代码，而只需在Dao类中使用注解来定义查询。

@Dao
interface PaoDao{

    @Insert(onConflict = OnConflictStrategy.REPLACE)
    fun insetAll(articles: List<Article>)

    @Query("SELECT * FROM Articles WHERE articleid= :id")
    fun getArticleById(id:Int):Single<Article>


    @Insert(onConflict = OnConflictStrategy.REPLACE)
    fun insertArticle(article :Article)

}
复制代码

建立数据库

至关于建立RetrofitClient对象

咱们须要定义一个继承了RoomDatabase的抽象类。这个类使用@Database来注解，列出它所包含的Entity以及操做它们的 DAO 。

@Database(entities = arrayOf(Article::class),version = 1)
abstract class AppDatabase :RoomDatabase(){

    abstract fun paoDao(): PaoDao

    companion object {
        @Volatile private var INSTANCE: AppDatabase? = null
        fun getInstance(context: Context): AppDatabase =
                INSTANCE ?: synchronized(this) {
                    INSTANCE ?: buildDatabase(context).also { INSTANCE = it }
                }

        private fun buildDatabase(context: Context) =
                Room.databaseBuilder(context.applicationContext,
                        AppDatabase::class.java, "app.db")
                        .build()
    }

}
复制代码

Over ，集成Room十分的简单。

更多关于Room的使用方法，它的迁移，表之间的关联和字段。

推荐查看泡网的Room专题：Room

实践

这里咱们对上一篇中的从服务器端获取到的Article文章进行持久化。

修改一下Model层的代码，添加Repository做为ViewModel层的数据源

class PaoRepo constructor(private val remote:PaoService,private val local :PaoDao){
	//首先查看本地数据库是否存在该篇文章
    fun getArticleDetail(id:Int)= local.getArticleById(id)
            .onErrorResumeNext {
              	//本地数据库不存在，会抛出EmptyResultSetException
              	//转而获取网络数据,成功后保存到数据库
                remote.getArticleDetail(id)
                        .doOnSuccess { local.insertArticle(it) }
            }
}
复制代码

咱们的目录结构会以下图所示：

修改咱们的ViewModel层的数据源

在上一篇中咱们使用的是PaoService网络数据做为数据源，这里只须要修改成PaoRepo

class PaoViewModel(private val repo: PaoRepo) 
复制代码

之后统一使用PaoRepo来为PaoViewModel提供数据

在View层中将PaoRepo注入到PaoViewModel

//////model
val remote=Retrofit.Builder()
        .baseUrl(Constants.HOST_API)
        .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
        .addConverterFactory(GsonConverterFactory.create())
        .build().create(PaoService::class.java)
val local=AppDatabase.getInstance(applicationContext).paoDao()
val repo = PaoRepo(remote, local)
/////ViewModel
mViewMode= PaoViewModel(repo)
////binding
mBinding.vm=mViewMode
复制代码

看看效果

Roomigrant

Roomigrant is a helper library to automatically generate Android Room library migrations using compile-time code generation.

这是一个帮助开发者进行Room数据迁移的库，使用起来很是方便。

在使用Room的过程当中，或多或少都会遇到增长表、改变表字段的状况。可是Room的迁移比较麻烦，能够看看理解Room的数据迁移这篇文章，增长新表还好，只须要修改版本号，可是若是须要修改表字段的话，因为sqlite的历史缘由：SQLite的ALTER TABLE命令很是局限，只支持重命名表以及添加新的字段。

所以咱们须要：

建立一个新的临时表，
把users表中的数据拷贝到临时表中
丢弃users表
把临时表重命名为users

使用Room，Migration的实现是这样的：

static final Migration MIGRATION_3_4 = new Migration(3, 4) {
    @Override
    public void migrate(SupportSQLiteDatabase database) {
        // Create the new table
        database.execSQL(
                "CREATE TABLE users_new (userid TEXT, username TEXT, last_update INTEGER, PRIMARY KEY(userid))");
// Copy the data
        database.execSQL(
                "INSERT INTO users_new (userid, username, last_update) SELECT userid, username, last_update FROM users");
// Remove the old table
        database.execSQL("DROP TABLE users");
// Change the table name to the correct one
        database.execSQL("ALTER TABLE users_new RENAME TO users");
    }
};
复制代码

对于开发者还须要编写大量的sql语句，能够说是不友好了。

可是幸运的是Roomigrant帮助咱们作到了以上的事，对于修改表字段，只须要简单的

自定义一个Rule，通知一下什么表下的哪一个字段须要修改

// version 3 的users表的字段uId
// version 4 相应的字段改成了userId
@FieldMigrationRule(version1 = 3, version2 = 4, table = "users", field = "uId")
fun migrate_3_4_Object1Dbo_intVal(): String {
	return "`users`.`userId`"
}
复制代码

这样Roomigrant即可以帮助咱们生成那些模板式的代码。

写在最后

本项目的github地址：github.com/ditclear/MV…

更多的例子能够查看：github.com/ditclear/Pa…

这是使用Kotlin构建MVVM项目的第三部分，主要讲了怎么在MVVM中进行数据的持久化以及为ViewModel层提供Repository做为惟一的数据源。

总结一下前三篇的内容即是:

使用Retrofit提供来自服务端的数据，使用Room来进行持久化，而后提供一个Repository来为ViewModel提供数据，ViewModel层利用RxJava来进行数据的转换，配合DataBinding引发View层的变化。

逻辑很清晰了，但惟一的遗憾即是为了提供一个ViewModel咱们须要写太多模板化的代码了

//////model
val remote=Retrofit.Builder()
        .baseUrl(Constants.HOST_API)
        .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
        .addConverterFactory(GsonConverterFactory.create())
        .build().create(PaoService::class.java)
val local=AppDatabase.getInstance(applicationContext).paoDao()
val repo = PaoRepo(remote, local)
/////ViewModel
mViewMode= PaoViewModel(repo)
复制代码

若是能不写该多好。

上帝说：能够。

因此下一篇的内容即是依赖注入—Dagger2，从入门到放弃到恍然大悟到爱不释手。。。