MartenDB中处理同名文档类型跨不同数据库Schema的问题

问题背景

在使用MartenDB进行文档存储时，开发人员可能会遇到一个常见问题：当两个文档类型具有相同的类名但属于不同的数据库Schema时，MartenDB会抛出AmbiguousDocumentTypeAliasesException异常。这种情况通常发生在大型系统中，不同业务模块可能使用相同名称的实体类，但逻辑上属于不同的领域。

问题重现

假设我们有以下两个文档类型：

// 公共Schema中的MaterialEntity
[DatabaseSchemaName("public")]
public class MaterialEntity : BaseEntity
{
    // 属性定义
}

// 制造Schema中的MaterialEntity
[DatabaseSchemaName("manufacturing")]
public class MaterialEntity : AggregateBaseEntity
{
    // 属性定义
}

当尝试通过IDocumentSession查询这些文档时，MartenDB会检测到两个文档类型具有相同的别名（默认使用类名作为别名），从而抛出异常。

技术原理

MartenDB在内部使用文档类型的别名来映射数据库表和JSON文档。默认情况下，别名就是文档类型的类名。当MartenDB初始化时，它会检查所有文档映射，确保没有重复的别名存在。这种设计是为了避免在查询和存储文档时出现歧义。

解决方案

方案1：显式指定不同的文档别名

最直接的解决方案是为每个文档类型指定不同的别名：

[DatabaseSchemaName("public")]
[DocumentAlias("public_material")]
public class MaterialEntity : BaseEntity
{
    // 属性定义
}

[DatabaseSchemaName("manufacturing")]
[DocumentAlias("manufacturing_material")]
public class MaterialEntity : AggregateBaseEntity
{
    // 属性定义
}

通过DocumentAlias特性显式指定不同的别名，可以避免MartenDB的歧义检查。

方案2：使用不同的存储接口

MartenDB支持为不同的文档集合创建独立的存储接口：

// 注册公共Schema存储
services.AddMartenStore<IPublicStore>(opts =>
{
    opts.Connection(dbConnectionString);
    opts.DatabaseSchemaName = "public";
});

// 注册制造Schema存储
services.AddMartenStore<IManufacturingStore>(opts =>
{
    opts.Connection(dbConnectionString);
    opts.DatabaseSchemaName = "manufacturing";
});

然后通过不同的接口访问各自的文档集合：

public class MaterialRepository
{
    private readonly IPublicStore _publicStore;
    
    public MaterialRepository(IPublicStore publicStore)
    {
        _publicStore = publicStore;
    }
    
    public async Task<MaterialEntity> GetMaterial(string id)
    {
        using var session = _publicStore.LightweightSession();
        return await session.Query<MaterialEntity>().FirstOrDefaultAsync(x => x.SapId == id);
    }
}

方案3：自定义文档映射策略

对于更复杂的需求，可以实现自定义的文档映射策略：

public class SchemaAwareDocumentMapping : DocumentMapping
{
    public SchemaAwareDocumentMapping(Type documentType) : base(documentType)
    {
        // 使用完整类型名加上Schema名作为别名
        var schemaName = documentType.GetCustomAttribute<DatabaseSchemaNameAttribute>()?.Name ?? "public";
        Alias = $"{schemaName}_{documentType.FullName}";
    }
}

// 在Marten配置中注册自定义映射
var store = DocumentStore.For(opts =>
{
    opts.Connection(dbConnectionString);
    opts.MappingFor<MaterialEntity>(m => new SchemaAwareDocumentMapping(typeof(MaterialEntity)));
});

最佳实践建议

1. 命名规范：在项目初期建立明确的命名规范，避免不同领域的实体使用相同名称。

2. 模块化设计：将不同业务模块的文档类型放在不同的程序集中，利用命名空间进行区分。

3. 显式别名：对于必须使用相同类名的情况，始终显式指定文档别名。

4. 文档记录：在团队中明确记录文档类型与Schema的映射关系，避免后续开发人员混淆。

总结

MartenDB通过文档别名机制确保文档类型的唯一性，这在大多数情况下是有益的设计。当遇到跨Schema的同名文档类型时，开发人员可以通过显式指定别名、使用不同的存储接口或自定义映射策略来解决冲突。理解这些解决方案的原理和适用场景，可以帮助开发人员更好地设计基于MartenDB的应用程序架构。