安装Nuget包时如何将自带C#文件覆盖写入目标.NET Core项目

.NET Core及更高版本的SDK风格项目修改了Nuget内容文件的默认处理逻辑，原来.NET Framework下直接将文件放到content目录即可复制到项目根的逻辑不再默认生效，按照以下步骤即可实现覆盖目标项目Program.cs的需求：

1. 调整打包项目的目录结构 #

在你要打包的C#项目根目录下创建层级文件夹 contentFiles/any/any/，两个any分别对应适配的目标框架和目标运行时，全平台生效直接保留any即可。将你要用于覆盖的Program.cs文件放到该目录下，示例内容如下：

class Program
{
   // 你的自定义逻辑
}

如果目标项目使用.NET 6+的顶级语句格式，你需要将包内的Program.cs也调整为对应的顶级语句格式，避免安装后出现编译冲突。

2. 修改打包项目的.csproj配置 #

在你的打包项目的.csproj文件中添加如下配置，指定contentFiles的打包规则，同时添加安装时自动执行的覆盖逻辑：

<Project Sdk="Microsoft.NET.Sdk">
  <!-- 原有项目配置，比如TargetFramework、PackageId、Version等 -->
  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <PackageId>你的自定义Nuget包名</PackageId>
    <Version>1.0.0</Version>
    <!-- 开启内容文件打包 -->
    <IncludeContentInPack>true</IncludeContentInPack>
  </PropertyGroup>

  <ItemGroup>
    <!-- 配置Program.cs的打包路径和属性 -->
    <Content Include="contentFiles/any/any/Program.cs" Pack="true" 
             PackagePath="contentFiles/any/any/Program.cs;content/Program.cs">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
      <PackageCopyToOutput>true</PackageCopyToOutput>
    </Content>
  </ItemGroup>

  <!-- 定义安装包时执行的覆盖目标 -->
  <Target Name="OverrideProgramCsOnInstall" AfterTargets="Install" 
          Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp' Or '$(TargetFrameworkIdentifier)' == '.NET'">
    <Copy SourceFiles="$(MSBuildThisFileDirectory)/../contentFiles/any/any/Program.cs" 
          DestinationFiles="$(ProjectDir)/Program.cs" 
          OverwriteReadOnlyFiles="true" 
          SkipUnchangedFiles="false" />
  </Target>

  <!-- 将覆盖逻辑打包为.targets文件，安装时自动触发 -->
  <ItemGroup>
    <None Include="$(MSBuildProjectFile)" Pack="true" PackagePath="build/$(PackageId).targets" />
  </ItemGroup>
</Project>

3. 重新打包上传 #

修改完成后重新执行dotnet pack命令打包，将新的版本上传到DevOps artifacts即可。

• 安装Nuget包前请关闭目标项目中打开的Program.cs文件，避免占用导致覆盖失败
• 如果需要兼容多种目标框架，可以将contentFiles/any/any/中的第一个any替换为对应目标框架 moniker，比如net6.0、net7.0分别配置对应版本的Program.cs

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