Mapperly项目中的并发修改异常问题分析与解决方案

问题背景

在Mapperly这个强大的.NET对象映射库中，开发者报告了一个在Visual Studio环境下特有的编译时异常。当使用Mapperly进行简单的DTO与模型之间的映射时，VS会抛出"Collection was modified; enumeration operation may not execute"的异常，导致生成的映射代码无法被正确编译。

问题现象

开发者在使用Mapperly进行基础的对象映射时，Visual Studio会显示以下警告信息：

警告 CS8785 Generator 'MapperGenerator' failed to generate source. It will not contribute to the output and compilation errors may occur as a result. Exception was of type 'InvalidOperationException' with message 'Collection was modified; enumeration operation may not execute.'

有趣的是，这个问题仅在Visual Studio中出现，而在Rider IDE或命令行构建中却能正常工作。生成的代码本身是正确的，但由于VS中的生成过程失败，导致这些代码无法被包含在最终构建中。

技术分析

通过深入分析问题堆栈和代码执行流程，我们发现问题的根源在于：

1. 集合修改与枚举的并发问题：在ObjectMemberMappingBodyBuilder.BuildMappingBody方法中，代码在枚举_unmappedTargetMemberNames集合的同时，又对该集合进行了修改（移除了已处理的成员）。

2. VS特有的行为：Visual Studio的增量编译和代码生成机制可能导致对生成器的调用方式与其他环境不同，从而触发了这个并发修改问题。

3. HashSet枚举的敏感性：底层使用的是HashSet<T>.Enumerator，它对并发修改特别敏感，一旦检测到集合被修改就会立即抛出异常。

解决方案

针对这个问题，Mapperly团队提出了以下修复方案：

1. 避免在枚举时修改集合：将需要处理的成员名称先复制到一个临时集合中，然后对这个副本进行枚举，这样即使原始集合被修改也不会影响枚举过程。

2. 防御性编程：在处理集合时采用更安全的方式，确保不会在枚举过程中修改被枚举的集合。

经验总结

这个案例给我们带来了几个重要的启示：

1. IDE差异：不同的开发环境可能对代码生成器有不同的调用方式，开发者需要考虑各种环境下的兼容性。

2. 集合操作安全：在操作集合时，特别是在复杂的代码生成场景中，需要特别注意枚举过程中的集合修改问题。

3. 测试覆盖：除了常规的单元测试外，还应该在不同开发环境下进行测试，确保代码生成器在各种场景下都能正常工作。

结论

Mapperly团队通过分析问题根源并实施修复方案，成功解决了这个Visual Studio特有的代码生成问题。这个案例展示了开源社区如何协作解决复杂的技术问题，也提醒我们在开发工具和库时要考虑各种使用环境的差异。对于开发者来说，当遇到类似问题时，可以尝试在不同环境下构建项目，这有助于快速定位问题是出在代码本身还是特定环境的交互方式上。