使用Kotlin構建MVVM應用程式—第三部分：Room

ditclear發表於2018-04-17
KotlinMVVMOOM

使用Kotlin構建MVVM應用程式—第三部分：Room

目錄

寫在前面

這是使用Kotlin構建MVVM應用程式—第三部分：Room

在上一篇中我們瞭解了MVVM是怎麼處理網路資料的，而這一篇則介紹的是如何進行資料持久化。

Room

Room是google推出的一個資料持久化庫，它是 Architecture Component的一部分。它讓SQLiteDatabase的使用變得簡單，大大減少了重複的程式碼，並且把SQL查詢的檢查放在了編譯時。

Room使用起來非常簡單，而且可以和RxJava配合使用，和我們的技術體系十分契合。

加入依賴

首先在專案的build.gradle中加入

allprojects {
    repositories {
        maven {
            url 'https://maven.google.com'
        }
        jcenter()
    }
}
複製程式碼

接著在app的build.gradle中加入它的依賴

//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'
複製程式碼

現在的結構

MVVM

這裡我們多了一層Repository，使用這一層來確保單一資料來源，保證資料來源的唯一和正確性（即不管是來自網路或是本地快取的）。ViewModel層並不需要知道它使用到的資料是怎麼來的，就好似開發者並不需要知道設計師是如何畫出UI圖的一樣。

開始正文

使用Room進行持久化

  1. 新建相應的表

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
}
複製程式碼

  1. 建立相關的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)

}
複製程式碼

  1. 建立資料庫

    相當於建立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文章進行持久化。

  1. 修改一下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) }
            }
}
複製程式碼

我們的目錄結構會如下圖所示：

結構

  1. 修改我們的ViewModel層的資料來源

在上一篇中我們使用的是PaoService網路資料作為資料來源，這裡只需要修改為PaoRepo

class PaoViewModel(private val repo: PaoRepo) 
複製程式碼

以後統一使用PaoRepo來為PaoViewModel提供資料

  1. 在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
複製程式碼

看看效果

image

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，從入門到放棄到恍然大悟到愛不釋手。。。

相關文章