作为项目引用 NuGet 与 SDK
本文旨在帮助开发人员选择是将其软件打包为 NuGet 包还是软件开发工具包 (SDK)。 具体而言，讨论在 Visual Studio 项目中引用两者之间的差异。
NuGet 是开放源代码包管理系统，可以简化将库合并到项目的过程。 对于 .NET（包括 .NET Core），NuGet 是 Microsoft 支持的共享代码机制。 NuGet 定义如何创建、托管和使用 .NET 包，并为每个角色提供工具。 在 Visual Studio 中，使用包管理器用户界面将 NuGet 包添加到项目。
SDK 是文件集合，Visual Studio 将其视为单个引用项。 当选择添加引用时，Visual Studio 中的“引用管理器”对话框会列出与当前项目相关的所有 SDK。 向项目中添加 SDK 时，可通过 IntelliSense、“工具箱”窗口、设计器、对象浏览器、MSBuild、部署、调试和打包访问该 SDK 的所有内容。
应使用哪种机制？
下表可帮助你比较 SDK 与 NuGet 的引用功能。
| 功能 | SDK 支持 | SDK 说明 | NuGet 支持 | NuGet 说明 |
|---|---|---|---|---|
| 机制引用一个实体后，便可使用所有文件和功能。 | Y | 因此，可以使用“引用管理器”对话框添加 SDK，以便在开发工作流期间使用所有文件和功能。 | Y | |
| MSBuild 自动使用程序集和 Windows 元数据 (.winmd) 文件。 | Y | SDK 中的引用会自动传递给编译器。 | Y | |
| MSBuild 自动使用的 .h 或 .lib 文件。 | Y | SDKName.props 文件中会介绍 Visual Studio 设置 Visual C++ 目录的方式等内容，让系统能自动使用 .h 或 .lib 文件。 | N | |
| MSBuild 自动使用 .js 或 .css 文件。 | Y | 在解决方案资源管理器中，可展开 JavaScript SDK 引用节点来显示单个 .js 和 .css 文件，然后通过将这些文件拖动到各自的源文件生成 <source include/> 标记。 SDK 支持 F5 和包自动安装。 |
Y | |
| MSBuild 自动添加“工具箱”中的控件。 | Y | “工具箱”可使用 SDK 并在指定的选项卡中显示控件。 | N | |
| 该机制支持扩展的 Visual Studio 安装程序 (VSIX)。 | Y | VSIX 具有特殊的清单和逻辑，用于创建 SDK 包 | Y | VSIX 可嵌入另一安装程序中。 |
| “对象浏览器”可枚举引用。 | Y | “对象浏览器”自动获取 SDK 中的引用列表并枚举它们。 | N | |
| 文件和链接自动被添加到“引用管理器”对话框（帮助链接等自动填充） | Y | “引用管理器”对话框连同帮助链接和 SDK 依赖项列表一起自动枚举 SDK。 | N | NuGet 提供其自身的“管理 NuGet 包”对话框。 |
| 该机制支持多个体系结构。 | Y | SDK 可以提供多个配置。 MSBuild 针对每个项目配置使用相应的文件。 | N | |
| 该机制支持多个配置。 | Y | SDK 可以提供多个配置。 根据项目体系结构，MSBuild 针对每个项目体系结构使用相应的文件。 | N | |
| 该机制可指定“不复制”。 | Y | 可控制将哪些文件复制到正在使用的应用程序的包中，这具体取决于文件置于 \redist 还是 \designtime 文件夹中。 | N | 需要声明包清单中要复制的文件。 |
| 内容显示在本地化文件中。 | Y | 自动包含 SDK 中已本地化的 XML 文档，以提供更好的设计时体验。 | N | |
| MSBuild 支持同时使用多个版本的 SDK。 | Y | SDK 支持同时使用多个版本。 | N | 这不会引用。 项目中不能一次同时拥有多个版本的 NuGet 文件。 |
| 该机制支持指定适用的目标框架、Visual Studio 版本和项目类型。 | Y | “引用管理器”对话框和“工具箱”仅显示适用于项目的 SDK，以便用户更轻松地选择适当的 SDK。 | Y（部分） | 透视是目标框架。 用户界面上没有筛选。 安装时可能会返回错误。 |
| 该机制支持为本机 WinMD 指定注册信息。 | Y | 可指定 SDKManifest.xml 中 winmd 文件和 .dll 文件之间的相关性。 | N | |
| 该机制支持指定其他 SDK 上的依赖关系。 | Y | SDK 仅通知用户；用户仍需手动安装和引用它们。 | Y | NuGet 自动提取它们；用户不会收到通知。 |
| 该机制与 Microsoft Store 概念（如应用清单和框架 ID）集成。 | Y | SDK 必须传递特定于 Store 的概念，以便包装和 F5 可以与 Store 提供的 SDK 一起正常工作。 | N | |
| 该机制与 Windows 8.x Store 应用的调试管道集成。 | Y | SDK 必须传递特定于 Store 的概念，以便包装和 F5 可以与 Store 提供的 SDK 一起正常工作。 | Y | NuGet 内容是项目的一部分。 无需特殊的 F5 考虑。 |
| 该机制与应用清单集成。 | Y | SDK 必须传递特定于 Store 的概念，以便包装和 F5 可以与 Store 提供的 SDK 一起正常工作。 | Y | NuGet 内容是项目的一部分。 无需特殊的 F5 考虑。 |
| 该机制部署非引用文件（例如，将部署要在其上运行 Windows 8.x Store 应用测试的测试框架）。 | Y | 如果将这些文件放入 \redist 文件夹中，它们将自动部署。 | Y | |
| 该机制会在 Visual Studio IDE 中自动添加平台 SDK。 | Y | 如果将 Windows 8 SDK 或 Windows Phone SDK 放入具有特定布局的特定位置，SDK 会自动与所有 Visual Studio 功能集成。 | N | |
| 该机制支持干净的开发者计算机。 （即，无需安装，只需来自源代码管理的简单检索即可工作。） | N | 由于引用 SDK，因此必须单独签入解决方案和 SDK。 可从两个非注册表默认位置（MSBuild 从该位置循环访问 SDK）签入 SDK（有关详细信息，请参阅创建软件开发工具包）。 作为替代方法，如果自定义位置包含 SDK，可以在项目文件中指定以下代码：<PropertyGroup><SDKReferenceDirectoryRoot>C:\MySDKs</SDKReferenceDirectoryRoot></PropertyGroup>然后将 SDK 签入该位置。 |
Y | 可以签出解决方案，Visual Studio 会立即识别并作用于文件。 |
| 可以加入大型现有包作者社区。 | 空值 | 社区是新增功能。 | Y | |
| 可以加入大型现有包使用者社区。 | 空值 | 社区是新增功能。 | Y | |
| 可以加入合作伙伴生态系统（自定义库和存储库等）。 | 空值 | 可用的存储库包括 Visual Studio Marketplace、Microsoft 下载中心和 Microsoft Store。 | Y | |
| 该机制与持续集成生成服务器集成，用于包创建和包使用。 | Y | SDK 必须将命令行上的签入位置（SDKReferenceDirectoryRoot 属性）传递到 MSBuild。 | Y | |
| 该机制同时支持稳定和预发布包版本。 | Y | SDK 支持向多个版本添加引用。 | Y | |
| 对于已安装的包，该机制支持自动更新。 | Y | 如果随附在 VSIX 或 Visual Studio 自动更新中，SDK 会自动发送通知。 | Y | |
| 该机制包含独立的 .exe 文件，用于创建和使用包。 | Y | SDK 包含 MSBuild.exe。 | Y | |
| 包可签入到版本控制。 | Y | 无法签入“文档”节点外的任何内容，这意味着可能无法签入扩展 SDK。 扩展 SDK 可能较大。 | Y | |
| 可使用 PowerShell 界面创建和使用包。 | Y（使用），N（创建） | 没有用于创建 SDK 的工具。 使用在命令行上正在执行 MSBuild。 | Y | |
| 可使用符号包调试支持。 | Y | 如果将 .pdb 文件放入 SDK 中，系统将自动提取它们。 | Y | |
| 该机制支持程序包管理器自动更新。 | 空值 | SDK 通过 MSBuild 进行修订。 | Y | |
| 该机制支持轻型清单格式。 | Y | SDKManifest.xml 支持多个属性，但通常只需要一个很小的子集。 | Y | |
| 该机制适用于所有 Visual Studio 版本。 | Y | SDK 支持所有 Visual Studio 版本。 | Y | NuGet 支持所有 Visual Studio 版本。 |