Room数据库maximumSize设置后onOpen回调未生效问题求助

尝试设置Room数据库的最大容量，在数据库onCreate()回调中设置maximumSize后，在onOpen()回调中检查该值并未发生更改。

代码实现 #

val db = Room.databaseBuilder(
    appContext,
    MyDatabase::class.java,
    "name",
).addCallback(
    object : RoomDatabase.Callback() {
        override fun onCreate(db: SupportSQLiteDatabase) {
            super.onCreate(db)
            db.maximumSize = 8796093014016
            Log.e("size in onCreate = ", db.maximumSize.toString())
        }

        override fun onOpen(db: SupportSQLiteDatabase) {
            super.onOpen(db)
            Log.e("size in onOpen = ", db.maximumSize.toString())
        }
    },
).build()

实际日志输出 #

size in onCreate = 8796093014016

size in onOpen = 4398046507008

预期日志输出 #

size in onCreate = 8796093014016

size in onOpen = 8796093014016

请问这种修改Room数据库容量的方式存在什么问题？

问题根源 #

• 在onCreate()中直接修改maximumSize属性，只是内存中临时生效，并没有将配置持久化到数据库文件中。当数据库关闭重开（比如触发onOpen()时），SQLite会读取数据库文件的默认配置，之前设置的值自然丢失。
• SQLite的数据库最大容量本质是通过PRAGMA max_page_count指令控制的，直接修改SupportSQLiteDatabase的maximumSize属性，并没有真正执行对应的PRAGMA指令来持久化配置。

正确实现方式 #

要让最大容量设置持久生效，需要执行SQLite的PRAGMA max_page_count指令，并且要在每次数据库打开时都执行（因为PRAGMA的会话级设置在连接关闭后会重置）。

修改后的代码示例：

val db = Room.databaseBuilder(
    appContext,
    MyDatabase::class.java,
    "name",
).addCallback(
    object : RoomDatabase.Callback() {
        override fun onCreate(db: SupportSQLiteDatabase) {
            super.onCreate(db)
            setDatabaseMaxCapacity(db)
            Log.e("size in onCreate = ", db.maximumSize.toString())
        }

        override fun onOpen(db: SupportSQLiteDatabase) {
            super.onOpen(db)
            setDatabaseMaxCapacity(db)
            Log.e("size in onOpen = ", db.maximumSize.toString())
        }

        private fun setDatabaseMaxCapacity(db: SupportSQLiteDatabase) {
            val targetMaxSize = 8796093014016L
            // SQLite通过max_page_count控制最大页数，需结合pageSize计算实际容量
            val maxPageCount = targetMaxSize / db.pageSize
            // 执行PRAGMA指令设置最大页数，确保配置生效
            db.execSQL("PRAGMA max_page_count = $maxPageCount")
            // 同步更新内存中的maximumSize属性
            db.maximumSize = targetMaxSize
        }
    },
).build()

补充说明 #

• 计算max_page_count时，必须使用当前数据库的pageSize（默认是4KB，即4096字节，但部分场景可能被修改），否则设置的容量会不符合预期。
• 必须在onOpen()回调中重复执行设置，因为每次新建数据库连接时，PRAGMA的会话级配置会恢复默认值，只有显式设置才能保证每次打开数据库时容量限制都生效。

内容的提问来源于stack exchange，提问作者pmw_14