Android Room 之存储 Objects 中的 List

前言

Room 是官方推出的一个在 SQLite 上提供抽象层的持久存储库,提供了强大而可靠的 SQL 对象映射能力,并且支持 LiveDataRxJava

在项目中添加以下依赖

    def room_version = "2.1.0-alpha04"
    def lifecycle_version = "2.0.0"
    def rxjava_version = '2.1.7'
    def rxandroid_version = '2.1.0'
    // Room
    implementation "androidx.room:room-runtime:$room_version"
    kapt "androidx.room:room-compiler:$room_version"
    implementation "androidx.room:room-rxjava2:$room_version"
    // RxJava
    implementation "io.reactivex.rxjava2:rxjava:$rxjava_version"
    implementation "io.reactivex.rxjava2:rxandroid:$rxandroid_version"
    // ViewModel and LiveData
    implementation "androidx.lifecycle:lifecycle-extensions:$lifecycle_version"
    implementation 'com.google.code.gson:gson:2.8.5'

    // 查看数据库
    implementation 'com.facebook.stetho:stetho-okhttp3:1.5.0'

当异步查询数据的时候,返回的对象可以是一个 LiveData 或者 Flowable 。如:

    @Query("SELECT * FROM user")
    abstract fun getAllUsers(): Flowable<List<User>>

    @Query("SELECT * FROM user")
    abstract fun getAllUser(): LiveData<List<User>>

当我们存储的实体类中包含 List ,如果按照普通的方式去定义 Entity。编译的时候就会报以下错误:

Cannot figure out how to save this field into database. You can consider adding a type converter for it.

这是因为 Room 无法直接存储 List 类型的数据,接下来我们将解决这个问题。

实践

  • 假设一个 User 对象会有很多本喜欢的书籍,一般定义的 Entity 类是以下格式:

    
    @Entity(tableName = "user")
    data class User(
    
        @PrimaryKey(autoGenerate = true)
        @ColumnInfo(name = "id")
        val id: Int,
    
        @ColumnInfo(name = "name")
        val name: String,
    
        @ColumnInfo(name = "books")
        val books: List<Book>
    
    )
    
    data class Book(
        val bookName: String
    )
    
  • 目前的情况下,编译项目就会遇到前面提到的错误。我们可以借助 @TypeConverter 去转换任意对象。例如定义一个 BookConverters

    class BookConverters {
    
        @TypeConverter
        fun stringToObject(value: String): List<Book> {
            val listType = object : TypeToken<List<Book>>() {
    
            }.type
            return Gson().fromJson(value, listType)
        }
    
        @TypeConverter
        fun objectToString(list: List<Book>): String {
            val gson = Gson()
            return gson.toJson(list)
        }
    }
    
  • 在实体类中添加 @TypeConverters 注解

    @Entity(tableName = "user")
    @TypeConverters(BookConverters::class)
    data class User(
    
        @PrimaryKey(autoGenerate = true)
        @ColumnInfo(name = "id")
        val id: Int,
    
        @ColumnInfo(name = "name")
        val name: String,
    
        @ColumnInfo(name = "books")
        val books: List<Book>
    
    )
    
    data class Book(
        val bookName: String
    )
    
    

@TypeConverters

这个注解的作用,就是告诉 Room 可以使用哪些额外的类型转换器。

一般定义的转换器类格式都是固定的:

class AnyConverters {

    @TypeConverter
    fun stringToObject(value: String): List<Any> {
        val listType = object : TypeToken<List<Any>>() {

        }.type
        return Gson().fromJson(value, listType)
    }

    @TypeConverter
    fun objectToString(list: List<Any>): String {
        val gson = Gson()
        return gson.toJson(list)
    }
}

使用 Facebook 推出的 Stetho 可以很方便的查看数据库中内容:

数据库中的数据

代码示例

参考资料

stackoverflow
官方文档

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345