美文网首页android 集结号
Android Room 之存储 Objects 中的 List

Android Room 之存储 Objects 中的 List

作者: 13kmsteady | 来源:发表于2019-03-05 21:00 被阅读267次

    前言

    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
    官方文档

    相关文章

      网友评论

        本文标题:Android Room 之存储 Objects 中的 List

        本文链接:https://www.haomeiwen.com/subject/tmrfsqtx.html