Comparatif entre NuGet et SDK comme référence de projet
Cet article a pour but d'aider les développeurs à choisir entre le conditionnement de leur logiciel sous forme de package NuGet ou de kit de développement logiciel (SDK). Plus précisément, il aborde les différences entre les deux lorsqu'ils sont référencés dans un projet Visual Studio.
NuGet est un système de gestion de packages open source qui simplifie le processus d'incorporation de bibliothèques dans un projet. Pour .NET (y compris .NET Core), NuGet est le mécanisme de partage de code soutenu par Microsoft. NuGet définit la manière dont les packages pour .NET sont créés, hébergés et consommés, et fournit les outils pour chacun de ces rôles. Dans Visual Studio, vous ajoutez des packages NuGet à un projet en utilisant l'interface utilisateur du gestionnaire de packages.
Un SDK est un ensemble de fichiers que Visual Studio traite comme un élément de référence unique. La boîte de dialogue Reference Manager de Visual Studio répertorie tous les SDK pertinents pour le projet en cours lorsque vous choisissez Ajouter une référence. Lorsque vous ajoutez un SDK à un projet, vous pouvez accéder à tout le contenu de ce SDK via IntelliSense, la fenêtre de la boîte à outils, les concepteurs, le navigateur d'objets, MSBuild, le déploiement, le débogage et le package.
Quel mécanisme dois-je utiliser ?
Le tableau suivant vous permet de comparer les fonctionnalités de référencement d’un SDK avec celles de NuGet.
| Fonctionnalité | Prise en charge par le SDK | Notes concernant le SDK | Prise en charge par NuGet | Notes concernant NuGet |
|---|---|---|---|---|
| Le mécanisme référence une entité, et ensuite tous les fichiers et les fonctionnalités sont disponibles. | Y | Vous ajoutez un kit SDK à l’aide de la boîte de dialogue Gestionnaire de références et tous les fichiers et les fonctionnalités sont disponibles pendant le flux de travail de développement. | Y | |
| MSBuild consomme automatiquement les assemblys et les fichiers de métadonnées Windows (.winmd). | Y | Les références dans le kit SDK sont automatiquement passées au compilateur. | Y | |
| MSBuild consomme automatiquement les fichiers .h ou .lib. | Y | Le fichier SDKName.props indique à Visual Studio comment configurer le répertoire Visual C++, et ainsi de suite, pour la consommation automatique du fichier .h ou .lib. | N | |
| MSBuild consomme automatiquement les fichiers .js ou .css. | Y | Dans l’Explorateur de solutions, vous pouvez développer le nœud de référence du kit SDK JavaScript pour afficher des fichiers .js ou .css spécifiques, puis générer des balises <source include/> en faisant glisser ces fichiers vers leurs fichiers sources. Le kit SDK prend en charge F5 et l’installation automatique des packages. |
Y | |
| MSBuild ajoute automatiquement le contrôle à la Boîte à outils. | Y | La Boîte à outils peut consommer des kits SDK et afficher des contrôles dans les onglets que vous spécifiez. | N | |
| Le mécanisme prend en charge le programme d’installation de Visual Studio pour les extensions (VSIX). | Y | VSIX a un manifeste et une logique spéciaux pour créer des packages du SDK. | Y | L’extension VSIX peut être incorporée dans un autre programme d’installation. |
| L’Explorateur d’objets énumère les références. | Y | L’Explorateur d’objets obtient automatiquement la liste des références dans les kits SDK et les énumère. | N | |
| Les fichiers et les liens sont automatiquement ajoutés à la boîte de dialogue Gestionnaire de références (les liens d’aide et autres sont remplis automatiquement). | Y | La boîte de dialogue Gestionnaire de références énumère automatiquement les kits SDK, ainsi que les liens d’aide et la liste des dépendances aux kits SDK. | N | NuGet fournit sa propre boîte de dialogue Gérer les packages NuGet. |
| Le mécanisme prend en charge plusieurs architectures. | Y | Les kits SDK peuvent fournir plusieurs configurations. MSBuild consomme les fichiers appropriés pour chaque configuration de projet. | N | |
| Le mécanisme prend en charge plusieurs configurations. | Y | Les kits SDK peuvent fournir plusieurs configurations. En fonction de l’architecture du projet, MSBuild consomme les fichiers appropriés pour chaque architecture de projet. | N | |
| Le mécanisme peut spécifier de « ne pas copier ». | Y | Selon que les fichiers sont déposés dans le dossier \redist ou \designtime, vous pouvez contrôler les fichiers à copier dans le package de l’application consommatrice. | N | Vous déclarez les fichiers à copier dans le manifeste du package. |
| Le contenu apparaît dans les fichiers localisés. | Y | Les documents XML localisés dans les kits SDK sont automatiquement ajoutés, pour une meilleure expérience de conception. | N | |
| MSBuild prend en charge la consommation simultanée de plusieurs versions d’un kit SDK. | Y | Le kit SDK prend en charge la consommation simultanée de plusieurs versions. | N | Cela ne constitue pas une référence. Vous ne pouvez pas avoir plusieurs versions de fichiers NuGet dans votre projet en même temps. |
| Le mécanisme prend en charge la spécification de frameworks cibles, de versions de Visual Studio et de types de projets applicables. | Y | La boîte de dialogue Gestionnaire de références et la Boîte à outils affichent uniquement les kits SDK qui s’appliquent à un projet. Ainsi, il est plus facile aux utilisateurs de choisir ceux qui leur conviennent. | O (en partie) | Pivot est le framework cible. Il n’existe aucun filtrage sur l’interface utilisateur. Au moment de l’installation, une erreur peut être retournée. |
| Le mécanisme prend en charge la spécification d’informations d’inscription pour les WinMD natifs. | Y | Vous pouvez spécifier la corrélation entre le fichier .winmd et le fichier .dll dans SDKManifest.xml. | N | |
| Le mécanisme prend en charge la spécification de dépendances envers d’autres kits SDK. | Y | Le kit SDK notifie simplement l’utilisateur. Celui-ci doit toujours les installer et les référencer manuellement. | Y | NuGet les extrait automatiquement ; l’utilisateur n’est pas averti. |
| Le mécanisme s'intègre aux concepts du Microsoft Store tels que l'app manifest et le Framework ID. | Y | Le SDK doit transmettre les concepts spécifiques au Store afin que le package et F5 fonctionnent correctement avec les SDK disponibles dans leStore. | N | |
| Le mécanisme s'intègre au pipeline de débogage des applications pour les applications du Windows 8.x Store. | Y | Le SDK doit transmettre les concepts spécifiques au Store afin que le package et F5 fonctionnent correctement avec les SDK disponibles dans le Store. | Y | Le contenu NuGet devient partie intégrante du projet. Aucune attention particulière n’est nécessaire pour F5. |
| Le mécanisme s’intègre aux manifestes d’application. | Y | Le SDK doit transmettre les concepts spécifiques au Store afin que le package et F5 fonctionnent correctement avec les SDK disponibles dans le Store. | Y | Le contenu NuGet devient partie intégrante du projet. Aucune attention particulière n’est nécessaire pour F5. |
| Le mécanisme déploie des fichiers de non-référence (par exemple, déployer le cadre de test sur lequel exécuter les tests des applications du Windows 8.x Store). | Y | Si vous déposez les fichiers dans le dossier \redist, ceux-ci sont automatiquement déployés. | Y | |
| Le mécanisme ajoute automatiquement les kits SDK de plateforme dans l’IDE Visual Studio. | Y | Si vous déposez le SDK Windows 8 ou le SDK Windows Phone dans un emplacement spécifique avec une disposition spécifique, le SDK est automatiquement intégré à toutes les fonctionnalités de Visual Studio. | N | |
| Le mécanisme prend en charge un ordinateur de développeur propre. (Autrement dit, aucune installation n’est nécessaire, et la récupération simple à partir du contrôle de code source fonctionnera.) | N | Étant donné que vous référencez un kit SDK, vous devez l’archiver séparément de votre solution. Vous pouvez archiver le kit SDK à partir des deux emplacements par défaut hors du Registre à partir desquels MSBuild itère les kits SDK (pour plus d’informations, consultez Création d’un kit de développement logiciel). Autre solution : si un emplacement personnalisé se compose de kits SDK, vous pouvez spécifier le code suivant dans le fichier projet :<PropertyGroup><SDKReferenceDirectoryRoot>C:\MySDKs</SDKReferenceDirectoryRoot></PropertyGroup>Ensuite, archivez les kits SDK à cet emplacement. |
Y | Vous pouvez extraire la solution, et Visual Studio reconnaît immédiatement les fichiers et agit en conséquence. |
| Vous pouvez rejoindre une grande communauté d’auteurs de packages. | S/O | La communauté est nouvelle. | Y | |
| Vous pouvez rejoindre une grande communauté de consommateurs de packages. | S/O | La communauté est nouvelle. | Y | |
| Vous pouvez rejoindre un écosystème de partenaires (galeries personnalisées, dépôts, etc.). | S/O | Les référentiels disponibles comprennent Visual Studio Marketplace, Microsoft Download Center et Microsoft Store. | Y | |
| Le mécanisme s’intègre aux serveurs de build d’intégration continue pour la création et la consommation de packages. | Y | Le kit SDK doit passer l’emplacement archivé (propriété SDKReferenceDirectoryRoot) sur la ligne de commande à MSBuild. | Y | |
| Le mécanisme prend en charge les versions de package stables et préliminaires. | Y | Le kit SDK prend en charge l’ajout de références à plusieurs versions. | Y | |
| Le mécanisme prend en charge la mise à jour automatique des packages installés. | Y | S’il est fourni comme VSIX ou dans le cadre des mises à jour automatiques de Visual Studio, le kit SDK fournit des notifications automatiques. | Y | |
| Le mécanisme contient un fichier .exe autonome pour créer et consommer des packages. | Y | Le kit SDK contient MSBuild.exe. | Y | |
| Les packages peuvent être archivés dans la gestion de version. | Y | Vous ne pouvez rien archiver en dehors du nœud Documents, ce qui signifie que les kits SDK d’extension ne peuvent pas être archivés. Le kit SDK d’extension peut être volumineux. | Y | |
| Vous pouvez utiliser une interface PowerShell pour créer et consommer des packages. | O (consommation), N (création) | Aucun outil de création de SDK. La consommation exécute MSBuild sur la ligne de commande. | Y | |
| Vous pouvez utiliser un package de symbole pour la prise en charge du débogage. | Y | Si vous déposez des fichiers .pdb dans le kit SDK, ceux-ci sont récupérés automatiquement. | Y | |
| Le mécanisme prend en charge les mises à jour automatiques du gestionnaire de packages. | S/O | Le kit SDK est révisé avec MSBuild. | Y | |
| Le mécanisme prend en charge un format léger de manifeste. | Y | SDKManifest.xml prend en charge de nombreux attributs, mais un petit sous-ensemble est généralement nécessaire. | Y | |
| Le mécanisme est disponible pour toutes les éditions de Visual Studio. | Y | Le Kit de développement logiciel (SDK) prend en charge toutes les éditions Visual Studio. | Y | NuGet prend en charge toutes les éditions Visual Studio. |