如何在AAR库中使用Android Room？主应用与库项目如何共用单个RoomDatabase实例？

这个问题我之前在多模块Android项目里碰到过，刚好可以给你一个贴合需求的实现思路——核心是利用Room的编译时注解特性，结合类继承来拆分主应用和库项目的职责，既满足单数据库实例的要求，又能让每个项目只需要扩展基础数据库类。

步骤1：在库项目中定义基础组件 #

库项目只需要关注自身的实体、DAO以及提供一个不带@Database注解的基础抽象数据库类：

1.1 定义库的实体（Book） #

@Entity(tableName = "books")
data class Book(
    @PrimaryKey val id: String,
    val name: String,
    val author: String
)

1.2 定义库的DAO接口 #

@Dao
interface BookDao {
    @Insert
    suspend fun insertBook(book: Book)

    @Query("SELECT * FROM books WHERE id = :bookId")
    suspend fun getBookById(bookId: String): Book?
}

1.3 创建基础抽象数据库类 #

这个类不添加@Database注解，只负责声明库的DAO方法，还可以封装一些通用的数据库配置逻辑（比如迁移策略、构建器模板）：

abstract class BaseRoomDatabase : RoomDatabase() {
    // 声明库提供的DAO
    abstract fun bookDao(): BookDao

    // 可选：封装通用的数据库构建逻辑，供子类调用
    protected fun buildDatabaseBuilder(context: Context, dbClass: Class<out RoomDatabase>, dbName: String): RoomDatabase.Builder<*> {
        return Room.databaseBuilder(context, dbClass, dbName)
            // 这里可以添加通用配置，比如 fallbackToDestructiveMigration() 或者自定义迁移
            .fallbackToDestructiveMigration()
    }
}

步骤2：在主应用项目中实现最终的数据库 #

主应用需要汇总所有实体（自己的Student + 库的Book），并继承库的基础数据库类：

2.1 定义主应用的实体（Student） #

@Entity(tableName = "students")
data class Student(
    @PrimaryKey val studentId: String,
    val name: String,
    val grade: Int
)

2.2 定义主应用的DAO接口 #

@Dao
interface StudentDao {
    @Insert
    suspend fun insertStudent(student: Student)

    @Query("SELECT * FROM students WHERE studentId = :studentId")
    suspend fun getStudentById(studentId: String): Student?
}

2.3 实现最终的AppDatabase类 #

这个类是唯一带有@Database注解的类，需要指定所有实体，同时继承库的BaseRoomDatabase，并添加自己的DAO方法：

@Database(
    entities = [Book::class, Student::class], // 汇总库和主应用的实体
    version = 1,
    exportSchema = true
)
abstract class AppDatabase : BaseRoomDatabase() {
    // 声明主应用自己的DAO
    abstract fun studentDao(): StudentDao

    // 实现单例（或用Hilt等DI框架管理）
    companion object {
        @Volatile
        private var INSTANCE: AppDatabase? = null

        fun getInstance(context: Context): AppDatabase {
            return INSTANCE ?: synchronized(this) {
                val instance = buildDatabaseBuilder(
                    context.applicationContext,
                    AppDatabase::class.java,
                    "app_main_db"
                ).build() as AppDatabase
                INSTANCE = instance
                instance
            }
        }
    }
}

为什么这个方案可行？ #

Room的@Database注解是编译时处理的（RetentionPolicy.CLASS），必须在最终的数据库实现类上明确指定所有要包含的实体——这也是它和其他支持动态注册实体的数据库的核心区别。通过上述方案：

• 库项目只需要专注于自身的实体和DAO，无需关心主应用的内容
• 主应用作为“汇总者”，负责把所有模块的实体整合到@Database注解中，同时继承库的基础类，符合你“每个项目扩展基础数据库”的需求
• 整个App只存在一个RoomDatabase实例，避免了多数据库的资源浪费

注意事项 #

• 确保所有模块的实体表名不重复，建议给库的实体表名添加统一前缀（比如lib_books）
• 所有模块的Room依赖版本必须保持一致，避免编译时冲突
• 如果库的实体有结构变更，主应用需要同步升级数据库版本，并添加对应的迁移策略

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