创建 Nuget 包时如何在 nuspec 文件中正确指定依赖信息？

Question

我第一次尝试从 Visual Studio 2017 类库创建 Nuget 包。它是一个 .NET Framework 4.6.2 项目。 类库正在引用解决方案资源管理器下的引用部分中的其他一些 nuget 包、dll、exe。

以下是我查看一些 youtube 视频和 Microsoft 文档后采取的步骤：

右键单击项目并选择属性。 构建选项，将配置设置为发布。已保存和关闭的项目属性。 打开 csproj 文件并将配置更改为发布

<Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>

现在以发布模式构建项目。我可以在

下看到dll

MyProject\bin\Release and also under MyProject\bin\Debug

然后我使用

创建规范文件

nuget 规范 打开它并进行适当的更改，然后

nuget 包 MyProject.nuspec

我收到了许多警告，例如 Debug 和 Release 目录：

WARNING: NU5100: The assembly 'bin\Debug\Encryption.dll' is not inside the 'lib' folder and hence it won't be added as a reference when the package is installed into a project. Move it into the 'lib' folder if it needs to be referenced.

虽然类库（我正在创建 Nuget）有一个 packages.config 并且有引用：

<?xml version="1.0" encoding="utf-8"?>
<packages>
  <package id="Encryption" version="1.1.0" targetFramework="net462" />
    ...
    ...
    ...
<package id="TeraData" version="16.20.8" targetFramework="net462" />
</packages>

由于收到警告，我尝试在 nuspec 文件中输入依赖项信息。这是我的 nuspec 文件的样子

   <?xml version="1.0" encoding="utf-8"?>
    <package >
      <metadata>
        <id>ProjectTitle</id>
        <version>1.0.0</version>
        <title>ProjectTitle</title>
        <authors>auther name</authors>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <description>desc of package</description>
        <releaseNotes>release notes text</releaseNotes>
        <copyright>Copyright info</copyright>
        <tags>some tages</tags>
    
        <dependencies>
          <dependency id="Encryption" version="1.1.0" />
    ...
          <dependency id="TeraData" version="16.20.8" />
        </dependencies>
      </metadata>
    </package>

但仍然收到相同的警告。如果可以，请提供一个示例 nuspec 中的依赖信息应该是什么样子，那真的很有帮助！ 如有遗漏请指教！

Answer 1

我认为这只是你的 nuget pack 方法的命令的问题。

我们通常不使用nuget pack xxx.nusepc命令打包nuget包，因为它不能自动将包含主nuget项目的dll的已生成的dll,pdb文件打包到nupkg中。

你必须用它写整个nuspec 节点。您必须在 nuspec 文件中写入 <files> 节点以包含您的主项目的 dll，以便删除缺少依赖项的警告。你不应该额外添加<references>节点。

喜欢：

 <?xml version="1.0" encoding="utf-8"?>
    <package >
      <metadata>
        <id>ProjectTitle</id>
        <version>1.0.0</version>
        <title>ProjectTitle</title>
        <authors>auther name</authors>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <description>desc of package</description>
        <releaseNotes>release notes text</releaseNotes>
        <copyright>Copyright info</copyright>
        <tags>some tages</tags>
    
        <dependencies>
          <dependency id="Encryption" version="1.1.0" />
    ...
          <dependency id="TeraData" version="16.20.8" />
        </dependencies>
      </metadata>
<files>
<file src="bin\Release\ProjectTitle.dll" target="lib\net462" />

.....
</files>
    </package>

然后，使用 nuget pack xxx.nuspec -Properties Configuration=Release 命令打包。您应该以这种方式打包主项目的 dll。如果您的项目引用了其他程序集 dll 或额外的 exe 文件。

你应该添加它们：

  <file src="bin\Release\extra_assembly.dll" target="lib\net462" />
  <file src="bin\Release\extra_exe.exe" target="lib\net462" />

==========================================

但是，这个功能不是很方便。而且我们通常不需要它们，我们通常使用这个：

nuget pack xxx.csproj

通常，我们使用nuget pack xxx.csproj -Properties Configuration=Release进行打包，无需任何其他节点。在此之前，您应该cd xxx\<project folder>。

使用这个nuspec 文件：

 <?xml version="1.0" encoding="utf-8"?>
        <package >
          <metadata>
            <id>ProjectTitle</id>
            <version>1.0.0</version>
            <title>ProjectTitle</title>
            <authors>auther name</authors>
            <requireLicenseAcceptance>false</requireLicenseAcceptance>
            <description>desc of package</description>
            <releaseNotes>release notes text</releaseNotes>
            <copyright>Copyright info</copyright>
            <tags>some tages</tags>
        
            <dependencies>
              <dependency id="Encryption" version="1.1.0" />
        ...
              <dependency id="TeraData" version="16.20.8" />
            </dependencies>
          </metadata>
  <!--If you have any other referenced assembly dll files or pdb files, exe files, you should add them here.-->
    <files>
    .....
    </files>
        </package>

您不应使用 <file> 节点添加主 nuget 项目的 dll，它会使用该命令自动添加到您的 nupkg。

当你创建你的nuget包的新发布版本时，首先卸载你项目下的旧版本，然后删除C:\Users\xxx\.nuget\packages下的所有缓存文件。之后，在您的新项目中重新安装新版本。

Answer 2

这是使用 .NET 框架的 nuspec 文件结构，最终对我有用：

   <?xml version="1.0" encoding="utf-8"?>
    <package >
      <metadata>
        <id>ClasslibProj </id>
        <version>1.0.0.0</version>
        <title> ClasslibProj</title>
        <authors>author(s) name</authors>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <description>desc</description>
        <releaseNotes>release notes</releaseNotes>
        <copyright>Copyright @ Company name 2021</copyright>
        <tags>tags to search </tags>
        <references>
          <group targetFramework=".NETFramework4.6.2">
            <reference file="SomeOtherNugetpackage1.dll"/>
           <reference file="anyexecutable.exe"/>
    …
    
            <reference file="ClasslibProj.dll"/> //dll you are working with
          </group>
        </references>
      </metadata>
      <files>
        <file src="bin\Release\SomeNugetOtherpackage1.dll" target="lib\net20"/>
       <file src="bin\Release\anyexecutable.exe" target="lib"/>
    ..
        <file src="bin\Release\ClasslibProj.dll" target="lib\net462"/>
      </files>
    </package>

在发布模式下构建项目。 使用命令：

nuget pack ClasslibProj.csproj 

正如 Sara Liu 所说，避免使用 ClasslibProj.nuspec
或者你可以使用详细的命令：

nuget pack ClasslibProj.csproj -Properties Configuration=Release