MongoDB Realm库中RealmModule被替换：如何维持正确数据库配置？

环境版本 #

MongoDB Realm: io.realm:realm-gradle-plugin:10.16.1

问题场景 #

1. 库侧定义了专属的Realm模块及配置方法：

@RealmModule(library=true, allClasses=true)
class LibraryModule() {}

return new RealmConfiguration.Builder()...modules(new LibraryModule()).build()

原本应用通过Realm.getInstance(LibraryDatabaseConfiguration())可以正常访问库的数据库Schema。

2. 当应用自身添加了自定义Realm模块和配置后：

@RealmModule(classes={storage1.class, storage2.class})
class AppModule() {}

return new RealmConfiguration.Builder()...modules(new AppModule()).build()

原本库的LibraryDatabaseConfiguration()返回的配置开始使用应用的Schema，而非库的Schema，已通过database.getSchema().getAll()验证该现象。

解决方法 #

1. 显式排除默认模块，强制仅加载库模块 #

Realm默认会自动扫描并包含所有可用的Realm模块，当应用添加自定义模块后，库的配置可能意外合并了应用模块。在库的配置构建时，必须加上excludeDefaultModules()，确保只加载指定的库模块：

return new RealmConfiguration.Builder()
        .excludeDefaultModules() // 核心：关闭自动模块扫描
        .modules(new LibraryModule())
        .build();

这一步能强制Realm只使用你指定的LibraryModule，不会混入应用侧的模块。

2. 确认库模块的library=true属性生效 #

确保库中LibraryModule的library=true设置正确，这个属性标记模块属于库组件，能避免被应用的默认模块扫描逻辑干扰。

3. 避免模块命名冲突 #

检查库和应用的模块是否存在同名情况，虽然少见，但同名可能引发类加载混淆，建议给库模块加上独特前缀（比如MyLibRealmModule）。

备注 #

该问题已向Realm官方提交Bug反馈，可关注官方后续修复动态。

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