MSBuild

le Microsoft Build Engine est une plateforme de création d’applications. Ce moteur, également appelé MSBuild, fournit un schéma XML pour un fichier projet qui contrôle la manière dont la plateforme de génération traite et génère les logiciels. Visual Studio utilise MSBuild, mais MSBuild ne dépend pas de Visual Studio. en appelant msbuild.exe sur votre fichier projet ou solution, vous pouvez orchestrer et générer des produits dans les environnements où Visual Studio n’est pas installé.

Visual Studio utilise MSBuild pour charger et générer des projets managés. Les fichiers projet de Visual Studio (.csproj, .vbproj, .vcxproj et autres) contiennent du code XML MSBuild qui s’exécute lors de la génération d’un projet avec l’environnement IDE. Les projets Visual Studio importent tous les paramètres et processus de génération nécessaires pour effectuer le travail de développement classique, mais vous pouvez les développer ou les modifier à partir de Visual Studio ou en utilisant un éditeur XML.

à compter de Visual Studio 2022, lorsque vous générez dans Visual Studio, la version 64 bits de MSBuild est utilisée.

pour plus d’informations sur MSBuild pour C++, consultez MSBuild (c++).

les exemples suivants illustrent les cas où vous pouvez exécuter des builds en appelant MSBuild à partir de la ligne de commande au lieu de l’IDE Visual Studio.

  • Visual Studio n'est pas installé. (télécharger MSBuild sans Visual Studio.)

  • vous souhaitez utiliser la version 64 bits de MSBuild et vous utilisez Visual Studio 2019 ou version antérieure. Cette version MSBuild est généralement inutile, mais elle permet à MSBuild d'accéder à plus de mémoire.

  • Vous souhaitez exécuter une build dans plusieurs processus. Toutefois, vous pouvez utiliser l'IDE pour obtenir le même résultat sur les projets dans C++ et C#.

  • Vous souhaitez modifier le système de génération. Par exemple, vous pouvez souhaiter effectuer les actions suivantes :

    • Prétraitez les fichiers avant qu'ils n'atteignent le compilateur.

    • Copiez les sorties de génération à un autre emplacement.

    • Créez des fichiers compressés à partir des sorties de génération.

    • Procédez à une étape de post-traitement. Par exemple, vous pouvez souhaiter horodater un assembly avec une version différente.

Vous pouvez écrire du code dans l'IDE de Visual Studio, mais les générations s'exécutent à l'aide de MSBuild. vous pouvez également générer du code dans l’IDE sur un ordinateur de développement, mais exécuter MSBuild à partir de la ligne de commande pour générer du code intégré à partir de plusieurs développeurs. vous pouvez également utiliser l' interface de ligne de commande (CLI) .net core, qui utilise MSBuild pour créer des projets .net core.

Notes

vous pouvez utiliser Azure Pipelines pour compiler, tester et déployer automatiquement votre application. Votre système de génération peut automatiquement exécuter des générations lorsque les développeurs archivent du code (par exemple, dans le cadre d'une stratégie continue d'intégration) ou selon une planification (par exemple, une build nocturne de test de vérification de build). Azure Pipelines compile votre code à l’aide de MSBuild. Pour plus d’informations, consultez Azure Pipelines.

Cet article fournit une vue d’ensemble de MSBuild. Pour un didacticiel d’introduction, consultez la Procédure pas à pas : utilisation de MSBuild.

Utiliser MSBuild dans une invite de commandes

pour exécuter MSBuild à partir d’une invite de commandes, transmettez un fichier projet à MSBuild.exe, ainsi que les options de ligne de commande appropriées. Les options de ligne de commande vous permettent de définir des propriétés, d'exécuter des cibles spécifiques et de définir d'autres options qui contrôlent le processus de génération. Par exemple, la syntaxe de ligne de commande suivante permet de générer le fichier MyProj.proj avec la propriété Configuration définie sur Debug.

MSBuild.exe MyProj.proj -property:Configuration=Debug

pour plus d’informations sur MSBuild options de ligne de commande, consultez référence de la ligne de commande.

Important

Avant de télécharger un projet, déterminez la crédibilité du code.

Fichier projet

MSBuild utilise un format de fichier projet XML qui est simple et extensible. le MSBuild format de fichier projet permet aux développeurs de décrire les éléments qui doivent être générés, ainsi que la façon dont ils doivent être générés pour différents systèmes d’exploitation et configurations. De plus, le format de fichier projet permet aux développeurs de créer des règles de génération réutilisables qui peuvent être réparties en fichiers distincts, de telle sorte que les builds puissent être exécutées de façon cohérente sur différents projets du produit.

le système de génération Visual Studio stocke la logique spécifique au projet dans le fichier de votre projet, et utilise les fichiers XML importés MSBuild avec des extensions telles que . props et . targets pour définir la logique de génération standard. les fichiers . props définissent MSBuild propriétés, et les fichiers . targets définissent MSBuild cibles. ces importations sont parfois visibles dans le fichier projet Visual Studio, mais dans les projets plus récents tels que .net Core, .net 5 et .net 6, vous ne voyez pas les importations dans le fichier projet. au lieu de cela, vous voyez une référence SDK. Il s’agit des projets de style SDK. Lorsque vous référencez un kit de développement logiciel (SDK) .NET, les importations des fichiers. props et. Target sont implicitement spécifiées par le kit de développement logiciel (SDK).

les sections suivantes décrivent certains des éléments de base du format de fichier projet MSBuild. pour obtenir un didacticiel sur la création d’un fichier projet de base, consultez procédure pas à pas : création d’un fichier de projet MSBuild à partir de zéro.

Propriétés

Les propriétés sont des paires clé/valeur qui peuvent être utilisées pour configurer les générations. Les propriétés sont déclarées en créant un élément portant le nom de la propriété comme enfant d’un élément PropertyGroup. Par exemple, le code suivant crée une propriété nommée BuildDir avec la valeur Build.

<PropertyGroup>
    <BuildDir>Build</BuildDir>
</PropertyGroup>

Vous pouvez définir une propriété conditionnellement en plaçant un attribut Condition dans l'élément. Le contenu des éléments conditionnels est ignoré, à moins que la condition ait la valeur true. Dans l'exemple suivant, l'élément Configuration est défini s'il n'a pas encore été défini.

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

Les propriétés peuvent être référencées dans tout le fichier projet à l’aide de la syntaxe $ ( <PropertyName> ). Par exemple, vous pouvez référencer les propriétés dans les exemples précédents en utilisant $(BuildDir) et $(Configuration).

Pour plus d’informations sur les propriétés, consultez Propriétés MSBuild.

Contenus

Les éléments sont des entrées du système de génération qui représentent généralement des fichiers. Les éléments sont regroupés en types d’éléments en fonction des noms d’élément définis par l’utilisateur. Ces types d’éléments peuvent être utilisés comme paramètres des tâches, lesquelles utilisent les éléments pour exécuter les étapes du processus de génération.

Les éléments sont déclarés dans le fichier projet en créant un élément avec le nom du type d’élément comme enfant d’un élément ItemGroup. Par exemple, le code suivant crée un type d'élément nommé Compile et composé de deux fichiers.

<ItemGroup>
    <Compile Include = "file1.cs"/>
    <Compile Include = "file2.cs"/>
</ItemGroup>

Les types d’éléments peuvent être référencés dans tout le fichier projet à l’aide de la syntaxe @ ( <ItemType> ). Par exemple, le type d'élément dans l'exemple serait référencé avec la syntaxe @(Compile).

Dans MSBuild, les noms d'éléments et des attributs respectent la casse. En revanche, ce n'est pas le cas pour les noms de propriétés, d'items et de métadonnées. L'exemple suivant crée le type d'élément Compile, comPile ou toute autre variation au niveau de la casse, et la valeur « one.cs;two.cs » est affectée au type d'item.

<ItemGroup>
  <Compile Include="one.cs" />
  <Compile Include="two.cs" />
</ItemGroup>

Les éléments peuvent être déclarés à l'aide de caractères génériques et peuvent contenir des métadonnées supplémentaires dans le cas de scénarios de génération plus avancés. Pour plus d’informations sur les éléments, consultez l’article Éléments MSBuild.

Tâches

les tâches sont des unités de code exécutable que MSBuild projets utilisent pour effectuer des opérations de génération. Par exemple, une tâche peut compiler des fichiers d'entrée ou exécuter un outil externe. Les tâches peuvent être réutilisées et partagées par plusieurs développeurs dans différents projets.

la logique d’exécution d’une tâche est écrite en code managé et mappée à MSBuild à l’aide de l’élément UsingTask . Vous pouvez écrire votre propre tâche en créant un type managé qui implémente l'interface ITask. Pour plus d’informations sur l’écriture de tâches, consultez écriture de tâches.

MSBuild comprend des tâches courantes que vous pouvez modifier en fonction de vos besoins. Voici des exemples : Copy, qui copie des fichiers, MakeDir, qui crée des répertoires et Csc, qui compile des fichiers de code source Visual C#. Pour obtenir la liste des tâches disponibles ainsi que des informations sur l’utilisation, consultez référence des tâches.

une tâche est exécutée dans un fichier projet MSBuild en créant un élément qui a le nom de la tâche comme enfant d’un élément Target . En général, les tâches acceptent les paramètres passés comme des attributs de l’élément. les propriétés et les éléments de MSBuild peuvent être utilisés en tant que paramètres. Par exemple, le code suivant appelle la tâche MakeDir et lui transmet la valeur de la propriété BuildDir déclarée dans l’exemple précédent.

<Target Name="MakeBuildDirectory">
    <MakeDir  Directories="$(BuildDir)" />
</Target>

Pour plus d’informations sur les tâches, consultez l’article Tâches MSBuild.

Compilé

Les cibles regroupent les tâches selon un ordre particulier et exposent les sections du fichier projet comme points d’entrée du processus de génération. Les cibles sont souvent groupées en sections logiques afin d'accroître la lisibilité et de permettre une expansion. L'éclatement des étapes de génération en plusieurs cibles permet d'appeler une partie du processus de génération à partir d'autres cibles sans copier cette section de code dans chaque cible. Par exemple, si plusieurs points d'entrée du processus de génération requièrent la génération de références, vous pouvez créer une cible qui génère les références et exécuter cette cible à partir de chaque point d'entrée nécessaire.

Les cibles sont déclarées dans le fichier projet avec l’élément Target. Par exemple, le code suivant crée une cible nommée Compile, qui appelle ensuite la tâche Csc comportant la liste d’éléments déclarée dans l’exemple précédent.

<Target Name="Compile">
    <Csc Sources="@(Compile)" />
</Target>

Dans des scénarios plus avancés, les cibles peuvent être utilisées pour décrire les relations entre chacune d'elles et exécuter une analyse de dépendance, qui permet d'ignorer des sections entières du processus de génération si la cible correspondante est à jour. Pour plus d’informations sur les cibles, consultez l’article Targets (Cibles MSBuild).

Journaux d’activité de génération

Vous pouvez consigner les erreurs de build, les avertissements et les messages dans la console ou un autre périphérique de sortie. Pour plus d’informations, consultez obtention de journaux de génération et journalisation dans MSBuild.

Utiliser MSBuild dans Visual Studio

Visual Studio utilise le format de fichier de projet MSBuild pour stocker des informations de génération sur les projets managés. Project paramètres ajoutés ou modifiés à l’aide de l’interface Visual Studio sont reflétés dans le . * fichier proj généré pour chaque projet. Visual Studio utilise une instance hébergée de MSBuild pour générer des projets managés. cela signifie qu’un projet managé peut être généré dans Visual Studio ou à partir d’une invite de commandes (même si Visual Studio n’est pas installé), et les résultats sont identiques.

Pour suivre un didacticiel sur l’utilisation de MSBuild dans Visual Studio, consultez la Procédure pas à pas : utilisation de MSBuild.

MULTICIBLAGE

en utilisant Visual Studio, vous pouvez compiler une application pour qu’elle s’exécute sur n’importe quelle version de .NET Framework. par exemple, vous pouvez compiler une application pour qu’elle s’exécute sur .NET Framework 2,0 sur une plateforme 32 bits, et vous pouvez compiler la même application pour qu’elle s’exécute sur .NET Framework 4,5 sur une plateforme 64 bits. Le multi-ciblage désigne la possibilité de compiler en plusieurs Frameworks.

Voici une partie des avantages offerts par le multi-ciblage :

  • vous pouvez développer des applications qui ciblent des versions antérieures de .NET Framework, par exemple, les versions 3,5 et 4.7.2.

  • Vous pouvez cibler un profil Framework, qui est un sous-ensemble prédéfini d’une version cible de .NET Framework.

  • si un Service Pack pour la version actuelle de .NET Framework est libéré, vous pouvez le cibler.

  • Le multi-ciblage garantit qu'une application utilise uniquement les fonctionnalités qui sont disponibles dans le framework et la plateforme cibles.

Pour plus d’informations, consultez l’article Multiciblage de MSBuild.

Voir aussi

Titre Description
Procédure pas à pas : Créer un fichier projet MSBuild à partir de zéro Indique comment créer de façon incrémentielle un fichier projet de base, en utilisant uniquement un éditeur de texte.
Procédure pas à pas : Utilisation de MSBuild Présente les composantes de MSBuild et indique comment écrire, manipuler et déboguer des projets MSBuild sans fermer l'IDE de Visual Studio.
Concepts MSBuild Présente les quatre composantes de MSBuild : propriétés, éléments, cibles et tâches.
Éléments décrit les concepts généraux sous-jacents au format de fichier MSBuild et à la façon dont les éléments s’imbriquent.
MSBuild (propriétés) Présente les propriétés et les collections de propriétés. Les propriétés sont des paires clé/valeur qui peuvent être utilisées pour configurer les générations.
Cibles Explique comment grouper les tâches dans un ordre particulier et autoriser des sections du processus de génération à être appelées sur la ligne de commande.
Tâches montre comment créer une unité de code exécutable qui peut être utilisée par MSBuild pour effectuer des opérations de génération atomiques.
Conditions Explique comment utiliser l'attribut Condition dans un élément MSBuild.
Concepts avancés Présente le traitement par lot, l'exécution de transformations, le multiciblage, ainsi que d'autres techniques avancées.
Journalisation dans MSBuild Décrit comment consigner des événements, des messages et des erreurs de build.
Comment MSBuild génère des projets Décrit le processus de génération interne utilisé dans MSBuild
Ressources supplémentaires Répertorie les ressources de communauté et de prise en charge pour des informations supplémentaires sur MSBuild.

Référence

  • référence MSBuild
    Renvoie aux rubriques contenant les informations de référence.

  • Glossaire
    Définit les termes courants relatifs à MSBuild.