如何让预构建事件生成的源文件在首次构建时被纳入C#项目编译？

问题场景 #

我希望从FlatBuffer Schema生成C#类，且不将生成文件提交到代码库，而是在构建流程中自动生成。现有一个包含两个项目的C#解决方案：

• MessageDefinitions.csproj：配置了预构建事件，调用FlatBuffer Schema编译器将生成的C#源文件输出到MessageDefinitions/Messages/文件夹
• MessageConsumer.csproj：已引用MessageDefinitions项目，需使用生成的类型

核心问题：首次构建时，MessageDefinitions.dll未包含生成的类型，导致MessageConsumer构建失败；二次构建时生成文件已存在，构建才能成功。需要实现首次构建就将生成的源文件纳入编译流程。

解决方案 #

方法1：显式在项目文件中声明生成文件（推荐） #

直接修改MessageDefinitions.csproj，添加对生成文件的引用，即使文件初始不存在，MSBuild也会等待预构建事件生成文件后再执行编译。

在.csproj文件中加入以下配置：

<ItemGroup>
  <!-- 包含Messages文件夹下所有生成的C#文件，文件不存在时仍会被纳入编译计划 -->
  <Compile Include="Messages\*.cs" />
</ItemGroup>

此方式让MSBuild明确知晓需要编译这些文件，会严格按“预构建事件生成文件 → 编译所有包含文件”的顺序执行，首次构建即可包含生成的类型。

方法2：用BeforeBuild目标替代预构建事件 #

若默认预构建事件的执行时机不可靠，可在.csproj中自定义BeforeBuild目标，确保文件生成操作在编译前完成：

<Target Name="BeforeBuild">
  <!-- 替换为你的FlatBuffer编译命令 -->
  <Exec Command="flatc --cs -o Messages\ YourSchema.fbs" />
</Target>

这种方式比IDE设置的预构建事件更可控，MSBuild会严格遵循目标执行顺序，先完成文件生成再进入编译阶段。

方法3：配置增量构建依赖 #

通过定义文件依赖关系，让MSBuild自动检测Schema文件变更，同时确保生成操作在核心编译前完成：

<ItemGroup>
  <!-- 声明你的FlatBuffer Schema文件 -->
  <FlatBufferSchema Include="YourSchema.fbs" />
</ItemGroup>

<Target Name="GenerateFlatBufferClasses" BeforeTargets="CoreCompile" Inputs="@(FlatBufferSchema)" Outputs="Messages\*.cs">
  <Exec Command="flatc --cs -o Messages\ %(FlatBufferSchema.FullPath)" />
</Target>

Inputs和Outputs定义了依赖逻辑：只有当Schema文件更新时，才会重新生成C#类；同时BeforeTargets="CoreCompile"确保生成操作在编译前执行，首次构建即可生成并包含类文件。

额外注意事项 #

• 确保Messages文件夹存在，可在生成命令前添加创建文件夹的指令（如mkdir Messages 2>nul）
• 将Messages\*.cs添加到版本控制忽略列表，避免误提交生成文件
• 修改.csproj后需重新加载Visual Studio项目，确保配置生效

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