Marten 项目中自定义文档存储的代码生成问题解析

问题背景

在使用 Marten 这个 .NET 文档数据库和事件存储库时，开发者可能会遇到自定义文档存储接口的代码生成问题。具体表现为当尝试使用 dotnet run -- codegen write 命令预生成代码时，系统会抛出 ExpectedTypeMissingException 异常，提示无法加载预期的预构建类型。

核心问题分析

这个问题通常出现在以下场景中：

1. 开发者定义了一个自定义的文档存储接口，继承自 Marten 的 IDocumentStore
2. 该接口及其配置被放在一个公共程序集中
3. 多个服务项目(如 API 和后台工作程序)共享这个公共程序集
4. 当在主项目中执行代码生成命令时，系统无法正确识别和加载相关类型

技术细节

问题的根本原因在于 Marten 的代码生成系统在以下方面存在不足：

1. 类型加载机制：代码生成器默认只查找当前程序集中的类型，而不会自动扫描引用的程序集
2. 配置灵活性：缺乏直接指定额外程序集进行扫描的配置选项
3. 错误处理：当遇到跨程序集类型时，错误信息不够明确，难以快速定位问题

解决方案

虽然这个问题被标记为将在 Marten 8 中修复，但目前有以下几种可行的解决方案：

1. 调整 Wolverine 配置

options.CodeGeneration.TypeLoadMode = TypeLoadMode.Auto

或者

options.CodeGeneration.TypeLoadMode = TypeLoadMode.Dynamic

这两种模式都可以绕过严格的类型检查，允许动态加载或自动回退机制。

2. 显式指定程序集

options.ApplicationAssembly = yourAssembly

这种方法直接告诉代码生成器应该从哪个程序集加载预构建的二进制文件。

3. 环境感知配置

更健壮的解决方案是实现环境感知的配置逻辑：

if (environment.IsProduction())
{
    options.ApplicationAssembly = typeof(Startup).Assembly;
    options.CodeGeneration.TypeLoadMode = TypeLoadMode.Auto;
}
else
{
    options.CodeGeneration.TypeLoadMode = TypeLoadMode.Dynamic;
}

这种模式在生产环境中使用预构建的二进制文件(带有优雅回退)，在开发环境中则使用动态编译。

最佳实践建议

1. 项目结构规划：将共享的 Marten 配置和接口放在单独的程序集中
2. 环境区分：为不同环境(开发/生产)配置不同的类型加载策略
3. 版本控制：关注 Marten 8 的发布，该版本将原生解决这个问题
4. 错误监控：在生产环境中监控类型加载相关的异常，确保回退机制正常工作

总结

Marten 作为一个强大的文档数据库解决方案，在大多数场景下表现优异。这个特定的代码生成问题主要出现在复杂的多项目解决方案中。通过理解问题的本质和可用的解决方案，开发者可以有效地规避或解决这个问题，同时期待 Marten 8 提供的原生修复方案。