Inclure un package NuGet dans votre projetInclude a NuGet package in your project

NuGet est le gestionnaire de packages le plus répandu pour le développement .NET, et il est intégré à Visual Studio pour Mac et à Visual Studio sur Windows.NuGet is the most popular package manager for .NET development and is built in to Visual Studio for Mac and Visual Studio on Windows. Vous pouvez rechercher des packages et les ajouter à vos projets Xamarin, .NET Core et ASP.NET en utilisant l’un ou l’autre de ces IDE.You can search for and add packages to your Xamarin, .NET Core and ASP.NET projects using either IDE.

Cet article explique comment inclure un package NuGet dans un projet. De plus, il présente la chaîne d’outils qui permet d’exécuter le processus sans interruption.This article describes how to include a NuGet package in a project and demonstrates the tool chain that makes the process seamless.

NuGet dans Visual Studio pour MacNuGet in Visual Studio for Mac

Pour illustrer les fonctionnalités des packages NuGet, nous allons d’abord créer une application et y ajouter un package.To demonstrate the NuGet package functionality, we'll first walk through creating a new application and adding a package to it. Nous présenterons ensuite les fonctionnalités de l’IDE qui aident à gérer les packages.Then we'll discuss the IDE features that help manage packages.

Créer un projetCreate a new project

Pour commencer, créez un projet nommé HelloNuget, comme illustré ci-dessous.First, create a project named HelloNuget as illustrated below. Cet exemple montre le modèle Application avec affichage unique pour iOS, mais tous les types de projet pris en charge fonctionnent également :This example shows the iOS Single View Application template, but any supported project type would work:

Créer un projet iOS

Ajout d’un packageAdding a Package

Le projet étant ouvert dans Visual Studio pour Mac, cliquez avec le bouton droit sur le dossier Packages dans le Panneau Solutions, puis sélectionnez Add NuGet Packages (Ajouter des packages NuGet) :With the project open in Visual Studio for Mac, right-click on the Packages folder in the Solution Pad and select Add NuGet Packages:

Action contextuelle Ajouter un nouveau package NuGet

Ceci déclenche l’affichage de la fenêtre Ajouter des packages.This launches the Add Packages window. Vérifiez que la liste déroulante Source est définie sur nuget.org :Ensure that the Source drop-down, is set to nuget.org:

Liste déroulante Source

Quand la fenêtre s’ouvre, elle charge une liste de packages à partir de la source de packages par défaut : nuget.org. Les résultats initiaux sont similaires à ceci :When the window opens it loads a list of packages from the default package source: nuget.org. The initial results look like this:

Répertorier les packages NuGet

Utilisez la zone de recherche dans le coin supérieur droit pour rechercher un package spécifique, par exemple  azure mobile.Use the search box in the top-right corner to find a specific package, for example azure mobile. Une fois que vous avez trouvé un package à utiliser, sélectionnez-le, puis cliquez sur le bouton  Add Package (Ajouter le package) pour commencer l’installation.When you have found a package that you wish to use, select it and click the Add Package button to begin installation.

Ajouter le package NuGet Azure

Une fois le package téléchargé, il est ajouté à votre projet.Once the package has been downloaded, it will be added to your project. La solution est changée comme suit :The solution will change as follows:

  • Le nœud Références contient une liste de tous les assemblys qui font partie d’un package NuGet.The References node will contain a list of all the assemblies that are part of a NuGet package.
  • Le nœud Packages montre chaque package NuGet que vous avez téléchargé.The Packages node displays each NuGet package that you have downloaded. Vous pouvez mettre à jour ou supprimer un package dans cette liste.You can update or remove a package from this list.
  • Un fichier packages.config sera ajouté au projet.A packages.config file will be added to the project. Ce fichier XML est utilisé par l’IDE pour effectuer le suivi des versions du package qui sont référencées dans ce projet.This XML file is used by the IDE to track which package versions are referenced in this project. Ce fichier ne doit pas être modifié manuellement, mais vous devez le conserver dans la gestion de versions.This file should not be hand-edited, but you should keep it in version control. Notez qu’un fichier project.json peut être utilisé à la place d’un fichier packages.config.Note that a project.json file can be used instead of a packages.config file. Le fichier project.json est un nouveau format de fichier de package introduit avec NuGet 3, qui prend en charge la restauration transitive.The project.json file is a new package file format introduced with NuGet 3, which supports transitive restore. Pour plus d’informations sur project.json, consultez la documentation de NuGet.More detailed information on project.json can be found in the NuGet documentation. Le fichier project.json doit être ajouté manuellement, et le projet doit être fermé puis rouvert avant que ce fichier soit utilisé dans Visual Studio pour Mac.The project.json file needs to be added manually and the project closed and re-opened before the project.json file is used in Visual Studio for Mac.

Utilisation de packages NuGetUsing NuGet Packages

Une fois le package NuGet ajouté et les références du projet mises à jour, vous pouvez programmer en utilisant les API comme vous le feriez avec n’importe quelle référence de projet.Once the NuGet package has been added and the project references updated, you can program against the APIs as you would with any project reference.

Veillez à ajouter les directives using nécessaires en haut de votre fichier :Ensure that you add any required using directives to the top of your file:

using Newtonsoft.Json;

La plupart des packages NuGet fournissent des informations supplémentaires, comme un lien vers une page README ou Projet vers la source NuGet.Most NuGet provide additional information, such as a README or Project page link to the Nuget source. Vous pouvez normalement trouver ce lien dans le texte de présentation du package sur la page Ajouter des packages :You can normally find a link to this in the package blurb on the Add Packages page:

Lien Afficher la page du projetView Project Page link

Mises à jour d’un packagePackage Updates

Les mises à jour d’un package peuvent être effectuées toutes en même temps en cliquant sur le nœud Packages, ou bien individuellement sur chaque composant.Package updates can be done either all at once, by right-clicking on the Packages node, or individually on each component.

Cliquez avec le bouton droit sur Packages pour accéder au menu contextuel :Right-click on Packages to access the context menu:

Menu Packages

  • Add NuGet Packages (Ajouter des packages NuGet) : ouvre la fenêtre permettant d’ajouter des packages au projet.Add NuGet Packages - Opens the window to add more packages to the project.
  • Mettre à jour : recherche les versions les plus récentes des packages sur le serveur source et les télécharge.Update - Checks the source server for each package and downloads any newer versions.
  • Restaurer : télécharge les packages manquants (sans mettre à jour les packages existants vers leur version la plus récente).Restore - Downloads any missing packages (without updating existing packages to newer versions).

Les options Mettre à jour et Restaurer sont également disponibles au niveau de la solution, et elles affectent tous les projets de la solution.Update and Restore options are also available at the Solution level, and affect all the projects in the solution.

Vous pouvez aussi cliquer avec le bouton droit sur des packages individuels pour accéder à un menu contextuel :You can also right-click on individual packages to access a context menu:

Menu Packages

  • Numéro de version : le numéro de version est un élément de menu désactivé. Il est fourni uniquement à titre d’information.Version Number - The version number is a disabled menu item - it is provided for informational purposes only.
  • Mettre à jour : recherche une version plus récente sur le serveur source et si elle existe, la télécharge.Update - Checks the source server and downloads a newer version (if it exists).
  • Supprimer : supprime le package de ce projet et supprime les assemblys concernés des références du projet.Remove - Removes the package from this project and removes the relevant assemblies from the project's References.

Ajout de sources de packagesAdding Package Sources

Les packages disponibles pour l’installation sont initialement extraits de nuget.org. Cependant, vous pouvez ajouter d’autres emplacements de packages à Visual Studio pour Mac.Packages available for installation are initially retrieved from nuget.org. However, you can add other package locations to Visual Studio for Mac. Ceci peut être pratique pour tester vos propres packages NuGet en cours de développement, ou pour utiliser un serveur NuGet privé au sein de votre entreprise ou organisation.This can be useful for testing your own NuGet packages under development, or to use a private NuGet server inside your company or organization.

Dans Visual Studio pour Mac, accédez à Visual Studio > Préférences > NuGet > Sources pour voir et modifier la liste des sources de packages.In Visual Studio for Mac, navigate to Visual Studio > Preferences > NuGet > Sources to view and edit the list of package sources. Notez que les sources peuvent être un serveur distant (spécifié par une URL) ou un répertoire local.Note that sources can be a remote server (specified by a URL) or a local directory.

Sources de packages

Cliquez sur Ajouter pour configurer une nouvelle source.Click Add to set-up a new source. Entrez un nom convivial et l’URL (ou le chemin du fichier) vers la source du package.Enter a friendly name and the URL (or file path) to the package source. Si la source est un serveur web sécurisé, entrez le nom d’utilisateur et le mot de passe, sinon laissez ces entrées vides :If the source is a secure web server, enter the username and password as well, otherwise leave these entries blank:

Ajouter des sources de packages

Vous pouvez sélectionner différentes sources lors de la recherche de packages :Different sources can then be selected when searching for packages:

Ajouter des sources de packages

Gestion de versionVersion Control

La documentation de NuGet traite de l’utilisation de NuGet sans validation des packages auprès de contrôle de code source.The NuGet documentation discusses using NuGet without committing packages to source control. Si vous préférez ne pas stocker les fichiers binaires et les informations non utilisées dans le contrôle de code source, vous pouvez configurer Visual Studio pour Mac pour restaurer automatiquement les packages à partir du serveur.If you prefer not to store binaries and unused information in source control, you can configure Visual Studio for Mac to automatically restore packages from the server. En d’autres termes, quand un développeur récupère le projet à partir du contrôle de code source pour la première fois, Visual Studio pour Mac télécharge et installe automatiquement les packages nécessaires.This means that when a developer retrieves the project from source control for the first time, Visual Studio for Mac will automatically download and install the required packages.

Restaurer automatiquement les packages

Pour plus d’informations sur la façon d’exclure le répertoire packages du suivi, consultez la documentation spécifique à votre contrôle de code source.Refer to your particular source control documentation for details on how to exclude the packages directory from being tracked.

Voir aussiSee also