Jetpack Room数据库升级

前言

Room持久性库在SQLite的基础上提供了一个抽象层,让用户能够在充分利用SQLite的强大功能的同时,获享更强健的数据库访问机制。

场景

在实际开发中,开发者肯定会遇到数据库版本的升级,Room自然也是提供类似api供开发者升级数据库版本使用的。

正文
数据库实体对象:

首先是创建数据库实体对象,具体字段自定义,这里不阐述,这里的表名称就叫"Download"

@Entity(tableName = "Download")
open class DownloadBean(

    @PrimaryKey
    @NonNull
    var aaa: String = "",//0

    XXXXX

)
数据库对象:

其次是创建数据库对象,entities就是刚才的数据库实体对象,version就是数据库的版本,DownloadDao是数据库操作的接口

@Database(
    entities = [DownloadBean::class],
    version = 1
)
abstract class DownloadDatabase : RoomDatabase() {

    abstract fun downloadDao(): DownloadDao

}
数据库接口:

这里定义了数据库的增删改查操作,相信大家都看得懂

@Dao
interface DownloadDao {

    @Insert
    fun insert(data: DownloadBean)

    @Delete
    fun delete(data: DownloadBean)

    @Update
    fun update(data: DownloadBean)

    @Query("SELECT * FROM download WHERE aaa=:value")
    fun find(value: String): DownloadBean?

    @Query("SELECT * FROM download")
    fun findAll(): MutableList<DownloadBean>?

}
数据库管理类:

最后是数据库管理类,这里获取数据库对象的单例,然后操作Dao去改变数据库,这里的"Download"是数据库名称,和刚才的表名称不要混淆了

class DownloadDbManager {

    companion object {

        private var db: DownloadDatabase? = null

        fun getInstance(): DownloadDatabase {
            if (db == null) {
                db = Room.databaseBuilder(
                    MarketApplication.getRootContext(),
                    DownloadDatabase::class.java,
                    "Download"
                )
                    .allowMainThreadQueries()//允许在主线程中查询
                    .build()
            }
            return db!!
        }

    }

    //操作DownloadDao

}
数据库升级:

重点来了,如何升级数据库,假设一开始只有aaa这个字段,现在是版本1,后面我们要升级数据库到版本2,增加bbb和ccc字段,该怎么做呢?
很简单,首先创建Migration,然后使用addMigrations()去添加Migration即可,这里的MIGRATION_1_2就是从数据库版本1升级到版本2时的操作,我这里新增了bbb和ccc两个String类型的字段。

class DownloadDbManager {

    companion object {

        private val MIGRATION_1_2 = object : Migration(1, 2) {
            override fun migrate(database: SupportSQLiteDatabase) {
                database.execSQL("ALTER TABLE Download " + " ADD COLUMN bbb TEXT ")
                database.execSQL("ALTER TABLE Download " + " ADD COLUMN ccc TEXT ")
            }
        }

        private var db: DownloadDatabase? = null

        fun getInstance(): DownloadDatabase {
            if (db == null) {
                db = Room.databaseBuilder(
                    MarketApplication.getRootContext(),
                    DownloadDatabase::class.java,
                    "Download"
                )
                    .allowMainThreadQueries()//允许在主线程中查询
                    .addMigrations(MIGRATION_1_2)
                    .build()
            }
            return db!!
        }

    }

    //Database操作Dao

}

同时切记别忘记升级数据库版本到2。

@Database(
    entities = [DownloadBean::class],
    version = 2
)
abstract class DownloadDatabase : RoomDatabase() {

    abstract fun downloadDao(): DownloadDao

}
数据库跳跃升级:

假设我们下一个版本又要新增ddd和eee字段呢?但用户还停留在版本1,如何升级到版本3呢?
实际开发中肯定不可能永远都是1->2,2->3的,实际上1->3、1->4或者2->4这种场景居多,这个时候我们可以帮用户去跳跃升级,帮用户从1->3,1->4,所以如何跳跃升级呢?
其实是一样的,因为addMigrations()可以添加多个Migration,只要把规则写清楚即可。

class DownloadDbManager {

    companion object {

        private val MIGRATION_1_2 = object : Migration(1, 2) {
            override fun migrate(database: SupportSQLiteDatabase) {
                database.execSQL("ALTER TABLE Download " + " ADD COLUMN bbb TEXT ")
                database.execSQL("ALTER TABLE Download " + " ADD COLUMN ccc TEXT ")
            }
        }

        private val MIGRATION_2_3 = object : Migration(2, 3) {
            override fun migrate(database: SupportSQLiteDatabase) {
                database.execSQL("ALTER TABLE Download " + " ADD COLUMN ddd TEXT ")
                database.execSQL("ALTER TABLE Download " + " ADD COLUMN eee INTEGER ")
            }
        }

        private var db: DownloadDatabase? = null

        fun getInstance(): DownloadDatabase {
            if (db == null) {
                db = Room.databaseBuilder(
                    MarketApplication.getRootContext(),
                    DownloadDatabase::class.java,
                    "Download"
                )
                    .allowMainThreadQueries()//允许在主线程中查询
                    .addMigrations(MIGRATION_1_2, MIGRATION_2_3)
                    .build()
            }
            return db!!
        }

    }

    //Database操作Dao

}

还是别忘记升级数据库版本到3。

@Database(
    entities = [DownloadBean::class],
    version = 3
)
abstract class DownloadDatabase : RoomDatabase() {

    abstract fun downloadDao(): DownloadDao

}

做完这些操作后,最重要的是测试过程,要仔细测试版本1升级到版本2,版本3时,版本1的数据能否正常看到和使用,如果都没什么问题,数据库的升级才算成功。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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