如何将Android Room生成的Schema转换为SQLite脚本用于数据库预填充
Room Schema导出SQLite可执行命令解决方案
Room自动生成的Schema为JSON格式,直接解析该文件即可批量提取可执行SQL语句,无需手动复制。
方法1:自定义Gradle任务自动提取(推荐,适配大体积Schema)
- 确认你项目Module级别的
build.gradle中已开启Schema导出配置(你已生成Schema,本步应该已经完成),示例配置如下:
android { defaultConfig { javaCompileOptions { annotationProcessorOptions { arguments += ["room.schemaLocation": "$projectDir/schemas".toString()] } } } }
- 在同个
build.gradle文件末尾新增自定义Gradle任务,用于解析Schema JSON、输出完整SQL脚本:
task extractRoomSql { // 替换为你自己的数据库全类名,对应schemas目录下的子文件夹名 def schemaPackagePath = "com.xxx.xxx.AppDatabase" def schemaDir = file("schemas/${schemaPackagePath}") // 自动取最新版本的Schema文件 def latestVersion = schemaDir.listFiles({ f -> f.name.endsWith('.json') } as FileFilter) .collect { it.name.replace(".json", "") as Integer } .max() def schemaFile = file("${schemaDir}/${latestVersion}.json") def outputSqlFile = file("${buildDir}/room_sql_v${latestVersion}.sql") doLast { def schema = new groovy.json.JsonSlurper().parse(schemaFile) def sqlLines = [] // 提取建表语句 schema.entities.each { entity -> sqlLines.add(entity.createSql + ";") // 提取表对应索引的创建语句 entity.indices.each { index -> sqlLines.add(index.createSql + ";") } } // 提取视图创建语句(如果你的库用到了Room视图) schema.views.each { view -> sqlLines.add(view.createSql + ";") } // 写入到输出文件 outputSqlFile.text = sqlLines.join("\n") } }
- 终端执行命令
./gradlew extractRoomSql,执行完成后即可在项目的build目录下拿到room_sql_v[版本号].sql文件,里面的所有语句都可以直接在SQLite客户端执行。
方法2:自行写脚本解析JSON(灵活度高)
如果不想改动Gradle配置,用Python/JS等任意语言写轻量脚本即可完成提取:
- 读取对应版本的Schema JSON文件
- 按顺序提取
entities下的createSql、indices.createSql、views.createSql三类字段内容 - 所有语句末尾追加
;后按顺序拼接输出到.sql文件即可
注意事项
Room生成的createSql字段已经自动替换了所有占位符,没有需要手动修改的内容,导出的SQL文件可以直接执行建库。如果需要包含历史迁移语句,额外提取JSON中migrations字段下的SQL内容按版本顺序拼接即可。
内容的提问来源于stack exchange,提问作者John Santos
相关产品推荐
相关产品推荐

