Utiliser la même cible dans plusieurs fichiers projet

  • Article

Si vous avez créé plusieurs fichiers projet MSBuild, vous avez peut-être découvert que vous devez utiliser les mêmes tâches et cibles dans les différents fichiers projet. Au lieu d’inclure la description complète de ces tâches ou de ces cibles dans chaque fichier projet, vous pouvez enregistrer une cible dans un fichier projet distinct et importer ensuite ce projet dans un autre projet qui doit utiliser la cible.

Utiliser l’élément Import

L’élément Import est utilisé pour insérer un fichier projet dans un autre fichier projet. Le fichier projet importé doit être un fichier projet MSBuild valide, et contenir du code XML bien formé. L’attribut Project spécifie le chemin du fichier projet importé. Pour plus d’informations sur l’élément Import, consultez Import, élément (MSBuild).

Pour importer un projet

  1. Dans le fichier projet importateur, définissez toutes les propriétés et les éléments qui sont utilisés comme paramètres des propriétés et des éléments dans le projet importé.

  2. Utilisez l’élément Import pour importer le projet. Par exemple :

    <Import Project="MyCommon.targets"/>

  3. Après l’élément Import, définissez toutes les propriétés et tous les éléments qui doivent remplacer les définitions par défaut des propriétés et des éléments dans le projet importé.

Ordre d’évaluation

Quand MSBuild atteint un élément Import, le projet importé est effectivement inséré dans le projet importateur à l’emplacement de l’élément Import. Par conséquent, l’emplacement de l’élément Import peut affecter les valeurs des propriétés et des éléments. Il est important de comprendre les propriétés et les éléments qui sont définis par le projet importé, ainsi que les propriétés et les éléments utilisés par le projet importé.

Quand le projet est généré, toutes les propriétés sont évaluées en premier, suivies par les éléments. Par exemple, le code XML suivant définit le fichier projet importé MyCommon.targets :

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <Name>MyCommon</Name>
    </PropertyGroup>

    <Target Name="Go">
        <Message Text="Name=$(Name)"/>
    </Target>
</Project>

Le code XML suivant définit MyApp.proj, qui importe MyCommon.targets :

<Project
    DefaultTargets="Go"
    xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <Name>MyApp</Name>
    </PropertyGroup>
    <Import Project="MyCommon.targets"/>
</Project>

Quand le projet est généré, le message suivant est affiché :

Name="MyCommon"

Comme le projet est importé après que la propriété Name a été définie dans MyApp.proj, la définition de Name dans MyCommon.targets remplace la définition dans MyApp.proj. Si le projet est importé avant la définition de la propriété Name, la génération affiche le message suivant :

Name="MyApp"

Utilisez l’approche suivante lors de l’importation de projets

  1. Dans le fichier projet, définissez toutes les propriétés et les éléments qui sont utilisés comme paramètres des propriétés et des éléments dans le projet importé.

  2. Importez le projet.

  3. Définissez dans le fichier projet toutes les propriétés et tous les éléments qui doivent remplacer les définitions par défaut des propriétés et des éléments dans le projet importé.

Exemple 1

L’exemple de code suivant montre le fichier MyCommon.targets qui est importé par le deuxième exemple de code. Le fichier .targets évalue les propriétés du projet importateur pour configurer la build.

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <Flavor Condition="'$(Flavor)'==''">DEBUG</Flavor>
        <Optimize Condition="'$(Flavor)'=='RETAIL'">yes</Optimize>
        <appname>$(MSBuildProjectName)</appname>
    <PropertyGroup>
    <Target Name="Build">
        <Csc Sources="hello.cs"
            Optimize="$(Optimize)"
            OutputAssembly="$(appname).exe"/>
    </Target>
</Project>

Exemple 2

L’exemple de code suivant importe le fichier MyCommon.targets.

<Project DefaultTargets="Build"
    xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <Flavor>RETAIL</Flavor>
    </PropertyGroup>
    <Import Project="MyCommon.targets"/>
</Project>

Contenu connexe