多模块中带有 Dagger 2 的 Android Room

Question

有没有一种方法或方法可以从模块/库提供可以在任何项目（应用程序模块）上使用的 Room DB 实例？

我面临的问题是扩展 RoomDatabase() 的抽象类位于我们的应用程序模块中，我们使用 @Database 注释定义我们的实体。这就是我无法提供来自应用程序模块以外的模块的 Room 实例的原因，因为创建 Room 实例需要您定义扩展 RoomDataBase() 的应用程序数据库类。

我的 :app:libs:common 模块中的示例。这是一个子模块，它有自己的存储库，可用于任何项目。 appName 在 AppModule 中提供，它驻留在应用程序模块本身中，并且与我创建的 SharedPreferences 一起使用。

 @Module
 CommonModule {
    
    @Provides
    @Singleton
    fun provideSharedPreferencesInstance(
        @Named("AppName") appName: String,
        application: Application
    ): SharedPreferences {
        application.apply {
            return getSharedPreferences(appName, MODE_PRIVATE)
        }
    }

    @Provides
    @Singleton
    fun provideAppSharedPrefImplInstance(
        sharedPreferences: SharedPreferences
    ): SharedPref = SharedPrefImpl(sharedPreferences)

    @Provides
    @Singleton
    fun provideRoomDatabaseInstance(
            application: Application,
            @Named("AppName") appName: String,
            @Named("AppDatabase") roomDatabase: RoomDatabase
        ): RoomDatabase {
            return Room
                .databaseBuilder(application, roomDatabase.javaClass, appName)
                .fallbackToDestructiveMigration()
                .build()
        }
    
}

这是应用程序模块。

@Module
object AppModule {
    @Provides
    @Singleton
    @Named("AppName")
    fun provideAppName(application: Application): String {
        application.apply {
            return getString(R.string.app_name)
        }
    }

    @Provides
    @Singleton
    fun provideAssetDao(@Named("AppDatabase") db: AppDatabase): AssetDao {
        return db.assetDao
    }
}

由于我们在扩展 RoomDatabase() 时使用抽象类，在本例中它是 AppDatabase 我尝试使用 @Binds 希望它能够工作。

@Module
abstract class RoomModule {

    @Binds
    @Singleton
    @Named("AppDatabase")
    abstract fun bindAppDatabase(appDatabase: AppDatabase): AppDatabase

}

我认为能够通过通用模块上的通用提供 AppDatabase 类将允许我解决这个问题

Answer 1

我就遇到过这种情况。
我编写了一个在 Android 项目中使用多个模块的样板，它包含房间数据库。
你可以参考我的repo
我的仓库

希望这对您有帮助