为何不能在SourceGenerator中执行文件IO？如何获取项目文件内容？

1. 为何不能在分析器/Source Generator中执行文件IO？ #

• 破坏增量编译机制：Source Generator的核心性能优化依赖增量编译，直接读取文件不会被编译器纳入依赖跟踪体系。当YML文件内容更新时，编译器无法感知变化，不会触发重新生成，导致生成的代码和配置文件内容不一致。
• 并发安全隐患：编译过程通常是多线程并行执行的，直接进行文件IO操作容易引发竞态条件——比如多个Generator实例同时读写同一文件，可能导致读取到不完整的内容，甚至抛出IO异常。
• 环境兼容性差：在CI/CD流水线、容器编译等场景中，文件系统的权限、路径结构可能和本地开发环境差异很大，直接硬编码路径或进行IO操作，很容易出现“本地正常、构建失败”的问题。
• 违反设计原则：分析器和Source Generator的设计目标是仅依赖编译器提供的上下文输入（如语法树、编译参数），避免外部依赖。直接文件IO会让Generator的行为不可预测，降低可靠性和可维护性。

2. 作为Source Generator的一部分，如何获取项目目录内文件的内容？ #

正确的做法是通过编译器提供的AdditionalFiles机制来处理，步骤如下：

步骤1：在csproj中配置文件 #

将需要读取的YML文件标记为AdditionalFiles，让编译器识别并传递给Source Generator：

<Project>
  <ItemGroup>
    <!-- 匹配项目目录下的所有YML文件，可根据实际路径调整 -->
    <AdditionalFiles Include="**/*.yml" />
  </ItemGroup>
</Project>

步骤2：在Source Generator中读取内容 #

在Generator的Execute方法中，通过GeneratorExecutionContext.AdditionalFiles获取文件内容，无需手动执行IO：

public void Execute(GeneratorExecutionContext context)
{
    foreach (var additionalFile in context.AdditionalFiles)
    {
        // 筛选出YML文件
        if (Path.GetExtension(additionalFile.Path).Equals(".yml", StringComparison.OrdinalIgnoreCase))
        {
            // 通过GetText()直接获取文件内容，编译器已处理IO和编码
            var fileContent = additionalFile.GetText()?.ToString();
            if (!string.IsNullOrEmpty(fileContent))
            {
                // 处理YML内容，生成代码
                GenerateFluentApiInterfaces(context, fileContent);
            }
        }
    }
}

额外提示 #

• 如果需要区分不同用途的配置文件，可以通过AdditionalFiles的元数据标记，比如：

  <AdditionalFiles Include="FluentApiStates/*.yml" GeneratorCategory="FluentApiConfig" />
  

  然后在Generator中通过additionalFile.GetMetadata("GeneratorCategory")筛选目标文件。
• 这种方式会自动纳入增量编译跟踪，当YML文件修改时，编译器会自动触发Source Generator重新执行，保证代码和配置同步。

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