MSBuild问题：CopyToOutputDirectory未复制原生DLL至输出目录

问题 #

我有一个包含两个项目的解决方案：MSBuildQuestion.csproj和NativeLibrary.vcxproj。其中MSBuildQuestion.csproj生成MSBuildQuestion.exe，NativeLibrary.vcxproj生成NativeLibrary.dll。

MSBuildQuestion.csproj通过ProjectReference引用NativeLibrary.vcxproj，并配置CopyToOutputDirectory将NativeLibrary.dll复制到输出目录：

<ItemGroup>
    <ProjectReference Include="..\NativeLibrary\NativeLibrary.vcxproj" />
    <Content Include="..\$(Platform)\$(Configuration)\*.dll">
        <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
</ItemGroup>

清理所有输出文件夹后，通过命令行执行以下步骤构建并运行时，NativeLibrary.dll未被复制到MSBuildQuestion.csproj的输出目录，导致运行MSBuildQuestion.exe时出现“Unable to load DLL 'NativeLibrary.dll'”错误：

Get-ChildItem . -include bin,obj,x64 -Recurse | ForEach-Object ($_) { Remove-Item $_.FullName -Force -Recurse }
nuget restore
msbuild /p:Platform=x64 /p:Configuration=Release
.\MSBuildQuestion\bin\x64\Release\net6.0\MSBuildQuestion.exe

奇怪的是，连续运行两次msbuild /p:Platform=x64 /p:Configuration=Release后，NativeLibrary.dll会被复制且程序运行正常，MSBuild日志显示构建顺序是正确的：

Done Building Project "...\NativeLibrary.vcxproj"
Done Building Project "...\MSBuildQuestion.csproj"
Done Building Project "...\MSBuildQuestion.sln"

原因分析与解决方案 #

这不是MSBuild的Bug，而是你引用原生DLL的方式有误。

问题根源 #

Content项的评估时机是在项目加载阶段，此时Native项目还未完成构建，..\$(Platform)\$(Configuration)\*.dll对应的文件还不存在。MSBuild不会将不存在的文件标记为需要复制的项，因此第一次构建时不会执行复制操作。第二次构建时，Native项目已经生成了DLL文件，Content项能找到目标文件，所以会完成复制。

正确解决方案 #

不要用Content+CopyToOutputDirectory的方式，而是利用MSBuild的项目引用依赖机制来自动复制输出文件，修改MSBuildQuestion.csproj中的ProjectReference配置：

<ItemGroup>
    <ProjectReference Include="..\NativeLibrary\NativeLibrary.vcxproj">
        <ReferenceOutputAssembly>false</ReferenceOutputAssembly>
        <OutputItemType>Content</OutputItemType>
        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </ProjectReference>
</ItemGroup>

这个配置的作用：

• ReferenceOutputAssembly="false"：告诉MSBuild不需要将原生项目的输出作为程序集引用（因为是原生DLL，不是.NET程序集）
• OutputItemType="Content"：将原生项目的输出文件标记为Content类型
• CopyToOutputDirectory="PreserveNewest"：仅当源文件比目标文件新时才复制，保证输出目录的文件始终是最新的

这种方式会让MSBuild在Native项目构建完成后，自动跟踪并复制其输出的DLL文件，完全避免了文件不存在导致的复制失败问题。

备选方案（自定义Target） #

如果需要更灵活的控制，也可以通过自定义Target实现，在.NET项目构建完成后复制DLL：

<Target Name="CopyNativeDll" AfterTargets="Build" DependsOnTargets="BuildDependencies">
    <Copy SourceFiles="..\$(Platform)\$(Configuration)\NativeLibrary.dll" DestinationFolder="$(OutputPath)" />
</Target>

DependsOnTargets="BuildDependencies"确保这个Target在所有依赖项目（包括Native项目）构建完成后才执行，保证源文件已经存在。

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