【Jetpack】使用 Room Migration 升级数据库并导出 Schema 文件 ( Schema 文件简介 | 生成 Schema 文件配置 | 生成 Schema 文件过程 )

news2025/3/13 19:11:47

文章目录

  • 一、Schema 文件简介
  • 二、生成 Schema 文件配置
  • 三、生成 Schema 文件过程
    • 1、数据库版本 1 - 首次运行应用
    • 2、数据库版本 1 升级至 数据库版本 2 - 第二次运行应用
    • 3、数据库版本 2 升级至 数据库版本 3 - 第三次运行应用





一、Schema 文件简介


使用 Room Migration 升级数据库 , 需要根据当前数据库版本和目标版本编写一系列 Migration 迁移类 , 并生成一个升级的 Schema 文件 , 该文件是 json 格式的文件 , 其中包含如下内容 :

  • 版本信息 : 包括 当前版本 和 目标版本 ;
  • 创建表语句 : 包括 新增的表的 定义 和 字段信息 ;
  • 删除表语句 : 包括 需要删除的 表的名称 ;
  • 修改表语句 : 包括 需要修改的表的名称 和 需要修改的字段的定义信息 ;
  • 插入数据语句 : 包括 需要插入数据的表的名称 和 插入的数据 ;
  • 删除数据语句 : 包括 需要删除数据的表的名称 和 删除的条件 ;

Schema 文件是 描述 Room 数据库结构的文件 , 通过该文件 , 可以 很方便地开发者了解数据库的历史变更记录 , 方便排查问题 ;

Schema 文件 定义了数据库中的表、列、索引等元素的结构 , 并包含了创建和升级数据库的 SQL 脚本 ;


使用 Room 的 Migration 升级数据库 , 生成的 Schema 文件的方式通常是通过 Gradle 构建脚本中的 roomExportSchema 任务，它会将 Schema 文件导出到指定的目录中 , 该目录需要在 build.gradle 构建脚本中配置 ;





二、生成 Schema 文件配置


在进行 Room 数据库升级时 , 可以使用 Room Migration 工具生成 Schema 文件 ;

如果想要 导出 Schema 文件 , 需要在 RoomDatabase 实现类的 @Database 注解中 , 设置 exportSchema = true 参数 ;

@Database(entities = [Student::class], version = 3, exportSchema = true)
abstract class StudentDatabase: RoomDatabase() {

在之前的博客中 , exportSchema 参数都设置为了 false , 没有导出 Schema 文件 ;


此外 , 还要在 build.gradle 构建脚本中 配置 Schema 文件的生成位置 , 在 " android / defaultConfig / javaCompileOptions / annotationProcessorOptions " 层级中的 arguments 中 , 配置 "room.schemaLocation": "$projectDir/schemas".toString() 参数 ;

完整的配置层级如下 :

android {
    namespace 'kim.hsl.rvl'
    compileSdk 32

    defaultConfig {
        applicationId "kim.hsl.rvl"
        minSdk 21
        targetSdk 32

        javaCompileOptions {
            annotationProcessorOptions {
                // 指定 Room Migration 升级数据库导出的 Schema 文件位置
                arguments = ["room.schemaLocation": "$projectDir/schemas".toString()]
            }
        }
    }
}

projectDir 是 Module 模块的根目录 , 生成的 schemas 目录 , 与 src , build , build.gradle 是一个级别的文件 ;





三、生成 Schema 文件过程



1、数据库版本 1 - 首次运行应用


运行数据库版本 1 的应用 , 首次运行 ,

        fun inst(context: Context): StudentDatabase {
            if (!::instance.isInitialized) {
                synchronized(StudentDatabase::class) {
                    // 创建数据库
                    instance = Room.databaseBuilder(
                        context.applicationContext,
                        StudentDatabase::class.java,
                        "student_database.db")
                        //.addMigrations(MIGRATION_1_2)
                        //.addMigrations(MIGRATION_2_3)
                        //.fallbackToDestructiveMigration()
                        .allowMainThreadQueries() // Room 原则上不允许在主线程操作数据库
                                                  // 如果要在主线程操作数据库需要调用该函数
                        .build()
                }
            }
            return instance;
        }

将 Entity 实体类中 新增的字段 注释掉 ;

    /**
     * 性别字段
     * 数据库表中的列名为 sex
     * 数据库表中的类型为 INTEGER 文本类型
     */
    /*@ColumnInfo(name = "sex", typeAffinity = ColumnInfo.INTEGER)
    var sex: Int = 0*/

    /**
     * degree字段
     * 数据库表中的列名为 sex
     * 数据库表中的类型为 INTEGER 文本类型
     */
    /*@ColumnInfo(name = "degree", typeAffinity = ColumnInfo.INTEGER)
    var degree: Int = 0*/

将数据块版本设置为 1 :

@Database(entities = [Student::class], version = 1, exportSchema = true)
abstract class StudentDatabase: RoomDatabase() {

首次运行应用 , 生成 数据库版本 1 的 Schema 文件 1.json ;

Schema 文件的生成位置是 " app/schemes/包名/1.json " 路径 ;

{
  "formatVersion": 1,
  "database": {
    "version": 1,
    "identityHash": "acca4b709e6c8b9b88d8328be36b9032",
    "entities": [
      {
        "tableName": "student",
        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `name` TEXT, `age` INTEGER NOT NULL)",
        "fields": [
          {
            "fieldPath": "id",
            "columnName": "id",
            "affinity": "INTEGER",
            "notNull": true
          },
          {
            "fieldPath": "name",
            "columnName": "name",
            "affinity": "TEXT",
            "notNull": false
          },
          {
            "fieldPath": "age",
            "columnName": "age",
            "affinity": "INTEGER",
            "notNull": true
          }
        ],
        "primaryKey": {
          "columnNames": [
            "id"
          ],
          "autoGenerate": true
        },
        "indices": [],
        "foreignKeys": []
      }
    ],
    "views": [],
    "setupQueries": [
      "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'acca4b709e6c8b9b88d8328be36b9032')"
    ]
  }
}

在这里插入图片描述


2、数据库版本 1 升级至 数据库版本 2 - 第二次运行应用


首先 , 设置 Entity 实体类中的字段 , 在 数据库版本 1 的基础上 , 添加 sex 字段 ;

    /**
     * 性别字段
     * 数据库表中的列名为 sex
     * 数据库表中的类型为 INTEGER 文本类型
     */
    @ColumnInfo(name = "sex", typeAffinity = ColumnInfo.INTEGER)
    var sex: Int = 0

然后 , 定义 数据库 版本 1 升级为 数据库 版本 2 的 Migration 迁移类 ,

        /**
         * 数据库版本 1 升级到 版本 2 的迁移类实例对象
         */
        val MIGRATION_1_2: Migration = object : Migration(1, 2) {
            override fun migrate(database: SupportSQLiteDatabase) {
                Log.i("Room_StudentDatabase", "数据库版本 1 升级到 版本 2")
                database.execSQL("alter table student add column sex integer not null default 1")
            }
        }

再后 , 调用 RoomDatabase.Builder#addMigrations 添加上述定义的 Migration 迁移类 ;

        fun inst(context: Context): StudentDatabase {
            if (!::instance.isInitialized) {
                synchronized(StudentDatabase::class) {
                    // 创建数据库
                    instance = Room.databaseBuilder(
                        context.applicationContext,
                        StudentDatabase::class.java,
                        "student_database.db")
                        .addMigrations(MIGRATION_1_2)
                        //.addMigrations(MIGRATION_2_3)
                        //.fallbackToDestructiveMigration()
                        .allowMainThreadQueries() // Room 原则上不允许在主线程操作数据库
                                                  // 如果要在主线程操作数据库需要调用该函数
                        .build()
                }
            }
            return instance;
        }

最后 , 修改数据库版本 为 2 ,

@Database(entities = [Student::class], version = 2, exportSchema = true)
abstract class StudentDatabase: RoomDatabase() {

生成的 数据库 版本 1 升级到 数据库 版本 2 的 Schema 文件如下 :

{
  "formatVersion": 1,
  "database": {
    "version": 2,
    "identityHash": "84fb235f8062b0a6b0c8d1a6d1035c4f",
    "entities": [
      {
        "tableName": "student",
        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `name` TEXT, `age` INTEGER NOT NULL, `sex` INTEGER NOT NULL)",
        "fields": [
          {
            "fieldPath": "id",
            "columnName": "id",
            "affinity": "INTEGER",
            "notNull": true
          },
          {
            "fieldPath": "name",
            "columnName": "name",
            "affinity": "TEXT",
            "notNull": false
          },
          {
            "fieldPath": "age",
            "columnName": "age",
            "affinity": "INTEGER",
            "notNull": true
          },
          {
            "fieldPath": "sex",
            "columnName": "sex",
            "affinity": "INTEGER",
            "notNull": true
          }
        ],
        "primaryKey": {
          "columnNames": [
            "id"
          ],
          "autoGenerate": true
        },
        "indices": [],
        "foreignKeys": []
      }
    ],
    "views": [],
    "setupQueries": [
      "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, '84fb235f8062b0a6b0c8d1a6d1035c4f')"
    ]
  }
}

在这里插入图片描述


3、数据库版本 2 升级至 数据库版本 3 - 第三次运行应用


首先 , 设置 Entity 实体类中的字段 , 在 数据库版本 2 的基础上 , 添加 degree 字段 ;

    /**
     * 性别字段
     * 数据库表中的列名为 sex
     * 数据库表中的类型为 INTEGER 文本类型
     */
    @ColumnInfo(name = "sex", typeAffinity = ColumnInfo.INTEGER)
    var sex: Int = 0

    /**
     * degree字段
     * 数据库表中的列名为 sex
     * 数据库表中的类型为 INTEGER 文本类型
     */
    @ColumnInfo(name = "degree", typeAffinity = ColumnInfo.INTEGER)
    var degree: Int = 0

然后 , 定义 数据库 版本 2 升级为 数据库 版本 3 的 Migration 迁移类 ,

        /**
         * 数据库版本 2 升级到 版本 3 的迁移类实例对象
         */
        val MIGRATION_2_3: Migration = object : Migration(2, 3) {
            override fun migrate(database: SupportSQLiteDatabase) {
                Log.i("Room_StudentDatabase", "数据库版本 2 升级到 版本 3")
                database.execSQL("alter table student add column degree integer not null default 1")
            }
        }

再后 , 调用 RoomDatabase.Builder#addMigrations 添加上述定义的 Migration 迁移类 ;

        fun inst(context: Context): StudentDatabase {
            if (!::instance.isInitialized) {
                synchronized(StudentDatabase::class) {
                    // 创建数据库
                    instance = Room.databaseBuilder(
                        context.applicationContext,
                        StudentDatabase::class.java,
                        "student_database.db")
                        .addMigrations(MIGRATION_1_2)
                        .addMigrations(MIGRATION_2_3)
                        //.fallbackToDestructiveMigration()
                        .allowMainThreadQueries() // Room 原则上不允许在主线程操作数据库
                                                  // 如果要在主线程操作数据库需要调用该函数
                        .build()
                }
            }
            return instance;
        }

最后 , 修改数据库版本 为 3 ,

@Database(entities = [Student::class], version = 2, exportSchema = true)
abstract class StudentDatabase: RoomDatabase() {

生成的 数据库 版本 2 升级到 数据库 版本 3 的 Schema 文件如下 :

{
  "formatVersion": 1,
  "database": {
    "version": 3,
    "identityHash": "d88859680a038f5155613d94de7888cc",
    "entities": [
      {
        "tableName": "student",
        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `name` TEXT, `age` INTEGER NOT NULL, `sex` INTEGER NOT NULL, `degree` INTEGER NOT NULL)",
        "fields": [
          {
            "fieldPath": "id",
            "columnName": "id",
            "affinity": "INTEGER",
            "notNull": true
          },
          {
            "fieldPath": "name",
            "columnName": "name",
            "affinity": "TEXT",
            "notNull": false
          },
          {
            "fieldPath": "age",
            "columnName": "age",
            "affinity": "INTEGER",
            "notNull": true
          },
          {
            "fieldPath": "sex",
            "columnName": "sex",
            "affinity": "INTEGER",
            "notNull": true
          },
          {
            "fieldPath": "degree",
            "columnName": "degree",
            "affinity": "INTEGER",
            "notNull": true
          }
        ],
        "primaryKey": {
          "columnNames": [
            "id"
          ],
          "autoGenerate": true
        },
        "indices": [],
        "foreignKeys": []
      }
    ],
    "views": [],
    "setupQueries": [
      "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'd88859680a038f5155613d94de7888cc')"
    ]
  }
}

在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/646074.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

Windows Subsystem for Android (WSA) 下载：在 Windows 11 上运行 Android 应用 (June 2023)

Windows Subsystem for Android (WSA) 下载：在 Windows 11 上运行 Android 应用 (June 2023)

适用于 Android™️ 的 Windows 子系统，2023 年 6 月更新 请访问原文链接：https://sysin.org/blog/wsa/，查看最新版。原创作品，转载请保留出处。 作者主页：sysin.org 适用于 Android™️ 的 Windows 子系统使你的 Wi…
阅读更多...
Linux系统之ifconfig命令的基本使用

Linux系统之ifconfig命令的基本使用

Linux系统之ifconfig命令的基本使用 一、ifconfig命令介绍1. ifconfig简介2. ifconfig注意事项3. ifconfig命令特点 二、ifconfig命令的使用方法1. 查看ifconfig的帮助信息2. ifconfig的使用帮助 三、安装ifconfig命令工具1. 安装net-tools软件包2. 查看ifconfig工具的版本 四、…
阅读更多...
至暗时刻，显卡销量腰斩，NVIDIA提前掏出2000元档4060救场

至暗时刻，显卡销量腰斩，NVIDIA提前掏出2000元档4060救场

不知道大家有没有感觉，自从 RTX 40 系显卡面世后，玩家们对于装机热情却是反常理的不增反降。 以往每代新显卡出来，哪次不是掀起一阵装机热潮。 然而这次小忆听到最多的声音就是：手里 750Ti 还能再战、GTX 1060 永远滴神等。 当然…
阅读更多...
pandas链式操作与SettingWithCopyWarning详解

pandas链式操作与SettingWithCopyWarning详解

1.SettingWithCopyWarning问题 SettingWithCopyWarning是pandas中一个经典问题，也是pandas库中位数不多的坑之一。关于这个问题，我们先看下面的一个例子。 import pandas as pddef t1():data {name: [a, b, c, d, e, f],num: [1, 2, 3, 4, 5, 6],ss: …
阅读更多...
Linux系统命令与网络、磁盘参数和日志监控

Linux系统命令与网络、磁盘参数和日志监控

文章目录 1、grep搜索命令2、wc命令3、 uptime机器启动时间负载4、ulimit用户资源5、scp远程拷贝6、dos2unix和unix2dos7、sed 1、grep搜索命令 grep命令用于在文件中搜索，并显示匹配效果 # 1、在指定文件查找，查找int main grep int main server.c# 2…
阅读更多...
接口自动化测试丨如何处理 Header cookie

接口自动化测试丨如何处理 Header cookie

Cookie（复数形态：Cookies）是某些网站为了辨别用户身份而储存在用户本地终端上的数据。在接口测试过程中，如果网站采取了 Cookie 认证的方式，那么发送的请求需要附带 Cookie，才会得到正常的响应的结果。接口…
阅读更多...
C#中List＜T＞的排序相关的使用方法总结

C#中List＜T＞的排序相关的使用方法总结

C#中List<>的排序相关的使用方法 list的排序一般使用Sort和LINQ的Orderby方法&#xff0c;本文主要介绍其如何使用。 &#x1f32e;1.Sort和实现Comparable接口 此方式需要类去实现IComparable接口 public class OrderTest {[Test]public void OraderTest(){List<E…
阅读更多...
【Excel】如何给Excel表格（文档）加密/上锁

【Excel】如何给Excel表格（文档）加密/上锁

目录 0.环境 1.操作步骤 若只输入了【打开权限密码】 若只输入了【修改权限密码】 若同时输入两种密码 0.环境 windows excel2021版 适用情景&#xff1a; 希望给别人提供文档时&#xff0c;需要用密码打开这个文档&#xff0c;加密又分为【打开时加密】和【修改时加密…
阅读更多...
【sentinel】Sentinel规则的持久化

【sentinel】Sentinel规则的持久化

Sentinel规则的推送有下面三种模式: 推送模式说明优点缺点原始模式API将规则推送至客户端并直接更新到内存中简单&#xff0c;无任何依赖不保证一致性&#xff1b;规则保存在内存中&#xff0c;重启即消失。严重不建议用于生产环境Pull模式扩展写数据源&#xff08;WritableDa…
阅读更多...
【Flutter】MAC环境下打包APK

【Flutter】MAC环境下打包APK

1、打开终端生成签名文件 keytool -genkey -v -keystore ~/sign.jks -keyalg RSA -keysize 2048 -validity 10000 -alias sign 结果 输入**库口令: 再次输入新口令: 您的名字与姓氏是什么?[Unknown]: yuanzhiying 您的组织单位名称是什么?[Unknown]: gongsi 您的组织…
阅读更多...
第1章 信息化发展

第1章 信息化发展

文章目录 1.1信息与信息化1.1.1信息1.信息的定义2.信息的特征与质量 1.1.2信息系统1.信息系统及其特性2.信息系统生命周期 1.1.3信息化1.信息化内涵&#xff08;4个&#xff1a;体系、产业、环境、积累&#xff09;2.信息化体系&#xff08;国家信息化体系 6 要素&#xff1a;上…
阅读更多...
Spark SQL数据源：Hive表

Spark SQL数据源：Hive表

文章目录 一、Spark SQL支持读写Hive二、Spark配置hive-site.xml三、准备工作&#xff08;一&#xff09;启动Hive的metastore&#xff08;二&#xff09;启动Spark Shell 四、Spark读写Hive数据&#xff08;一&#xff09;导入SparkSession&#xff08;二&#xff09;创建Spar…
阅读更多...
阿里技术官肝了 3 个月才完成的 20 万字 Java 面试手册

阿里技术官肝了 3 个月才完成的 20 万字 Java 面试手册

金三银四已经过去&#xff0c;不知道你是已经上岸&#xff0c;还是在等秋招。为了让大家能在面试中如鱼得水&#xff0c;offe 能够手到擒来。小编在此分享一份阿里技术官肝了 3 个月才完成的 20 万字 Java 面试手册。 这份面试手册涉及的技术栈非常全面而且足够细致&#xff0…
阅读更多...
在字节跳动和阿里划水4年，过于真实了...

在字节跳动和阿里划水4年，过于真实了...

先简单交代一下吧&#xff0c;涛哥是某不知名211的本硕&#xff0c;18年毕业加入阿里&#xff0c;之后跳槽到了头条&#xff0c;一直从事测试开发相关的工作。之前没有实习经历&#xff0c;算是四年半的工作经验吧。 这四年半之间他完成了一次晋升&#xff0c;换了一家公司&am…
阅读更多...
MySQL数据库用户管理

MySQL数据库用户管理

MySQL数据库用户管理 一、MySQL常用的6大约束二、数据表的高级操作1.克隆表2.清空表&#xff0c;删除表内的所有数据3&#xff0e;创建临时表4&#xff0e;创建外键约束&#xff0c;保证数据的完整性和一致性 三、数据用户管理1.新建用户2&#xff0e;查看用户信息3&#xff0e…
阅读更多...
MongoDB 索引操作引起的 Crash

MongoDB 索引操作引起的 Crash

摘要&#xff1a;本文详细阐述了根据引起 Crash 操作进行从配置到源码的分析过程&#xff0c;层层递进&#xff0c;定位复现并给出解决故障方案。 作者&#xff1a;徐耀荣 爱可生南区交付服务部 DBA 团队成员&#xff0c;主要负责 MySQL 故障处理以及相关技术支持。爱好电影&am…
阅读更多...
c++学习之多态

c++学习之多态

目录 1&#xff0c;什么是多态&#xff1f; 2&#xff0c;什么是虚函数&#xff1f; 1.如何实现父类对各个派生子类的操作&#xff1f; 2&#xff0c;父类指针保存子类空间产生的问题。 3&#xff0c;虚函数的定义 4&#xff0c;虚函数的动态绑定机制 5&#xff0c;重载&…
阅读更多...
创新方案｜时尚品牌企业应用生成式AI的6大机会领域

创新方案｜时尚品牌企业应用生成式AI的6大机会领域

探讨生成式人工智能&#xff08;Generative AI&#xff09;在时尚产业中的应用&#xff0c;以及它对设计、生产和销售过程的影响。通过使用生成式AI技术&#xff0c;时尚品牌可以更快地设计和生产出更加个性化和符合潮流趋势的产品&#xff0c;同时减少浪费和成本。文章还介绍了…
阅读更多...
掌握Python文件操作：从基础到高阶的全方位探索

掌握Python文件操作：从基础到高阶的全方位探索

在本篇博客中&#xff0c;我们将全面、深入地探讨Python中的文件操作。文件操作在Python编程中是不可或缺的一部分&#xff0c;它包含了打开、读取、写入和关闭文件等各种操作。我们将从基础的文件操作讲解到高级的文件处理技巧&#xff0c;以及如何优雅地使用Python进行文件操…
阅读更多...
前端vue入门(纯代码)07

前端vue入门(纯代码)07

【07.TodoList案例】 1 拆分组件 一共拆分为4个组件&#xff1a;【因为header和HTML内置的标签<header>重名&#xff0c;故在之前都加了Todo】 TodoHeaderTodoItem【item是list的子组件】TodoListTodoFooter 2 组件化编码流程 实现静态组件&#xff1a;抽取组件&…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023