.NET Core中使用<contentFiles>部署NuGet包内嵌JSON文件遇阻求助

我来帮你排查这个困扰你的问题，在.NET Core 2的场景下，要让自定义NuGet包里的JSON文件跟着网站一起部署，确实有几个容易忽略的细节，咱们一步步梳理：

1. 确认nuspec里的contentFiles配置是否准确 #

.NET Core项目主要依赖contentFiles节点来处理NuGet中的内容文件，老的content节点在PackageReference模式下已经不生效了，你需要确保配置里的几个关键点：

• 目标框架匹配：要明确指定netcoreapp2.x（比如你的网站用的是netcoreapp2.0还是2.1），不能用通配符或者写错框架名
• 复制和构建动作：必须设置copyToOutput="true"和buildAction="Content"，示例配置如下：

  <contentFiles>
    <files include="any/netcoreapp2.0/**/*.json" buildAction="Content" copyToOutput="true" flatten="false" />
  </contentFiles>
  

2. 检查NuGet包内文件的实际路径 #

把你的NuGet包改成.zip后缀解压，看看JSON文件是不是在contentFiles/any/netcoreapp2.0目录下——这是contentFiles机制识别的标准路径。如果文件放在老的content目录下，.NET Core 2的项目不会自动复制这些文件。

如果是用dotnet pack打包，你需要在项目.csproj里配置好文件的打包路径，比如：

<ItemGroup>
  <Content Include="你的JSON文件相对路径/**/*.json">
    <Pack>true</Pack>
    <PackagePath>contentFiles/any/netcoreapp2.0/wwwroot/data/</PackagePath>
  </Content>
</ItemGroup>

或者直接在nuspec的files节点里指定：

<files>
  <file src="本地JSON文件路径/*.json" target="contentFiles/any/netcoreapp2.0/wwwroot/data/" />
</files>

3. 排查项目的PackageReference设置 #

.NET Core 2默认用PackageReference管理NuGet包，要确保你的包引用没有排除内容文件：

<PackageReference Include="你的NuGet包名称" Version="x.x.x">
  <PrivateAssets>none</PrivateAssets>
  <ExcludeAssets>none</ExcludeAssets>
</PackageReference>

如果设置了ExcludeAssets="contentFiles"，那内容文件肯定不会被复制到项目里。

4. 清理缓存并重建项目 #

有时候NuGet缓存或者项目的bin/obj目录会导致配置不生效，执行以下步骤试试：

• 清理NuGet缓存：运行dotnet nuget locals all --clear
• 删除项目根目录下的bin和obj文件夹
• 重新执行dotnet restore和dotnet build

5. 检查网站的发布配置 #

如果前面都没问题，发布的时候还要确保内容文件会被复制到发布目录，可以在网站的.csproj里添加全局配置兜底：

<ItemGroup>
  <Content Include="**/*.json" CopyToPublishDirectory="PreserveNewest" />
</ItemGroup>

最容易踩的坑就是contentFiles的路径不匹配，或者目标框架写错，先从检查NuGet包内的文件路径和nuspec配置开始排查，应该能解决问题。

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