美文网首页Android开发
Jetpack Room数据库升级

Jetpack Room数据库升级

作者: 渐渐懂了吧 | 来源:发表于2023-05-28 19:55 被阅读0次

前言

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的数据能否正常看到和使用,如果都没什么问题,数据库的升级才算成功。

相关文章

网友评论

    本文标题:Jetpack Room数据库升级

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