Elemento Import (MSBuild)

Artículo
06/19/2023

Importa el contenido de un archivo de proyecto en otro archivo de proyecto.

Sintaxis

<Import Project="ProjectPath"
    Condition="'String A'=='String B'" />

Atributos y elementos

En las siguientes secciones se describen los atributos, los elementos secundarios y los elementos primarios.

Atributos

Atributo	Descripción
`Project`	Atributo necesario. Ruta de acceso del archivo de proyecto que se va a importar. La ruta puede incluir caracteres comodín. Los archivos coincidentes se importan según el criterio de ordenación. Mediante esta característica, puede agregar código a un proyecto simplemente agregando el archivo de código a un directorio.
`Condition`	Atributo opcional. Condición que se va a evaluar. Para obtener más información, consulte Condiciones.
`Label`	Atributo opcional. Aplica un identificador a este elemento de importación.
`Sdk`	Atributo opcional. Hace referencia a un SDK de proyecto.

Elementos secundarios

Ninguno

Elementos primarios

Elemento	Descripción
Proyecto	Elemento raíz necesario de un archivo de proyecto de MSBuild.
ImportGroup	Contiene una colección de elementos `Import` agrupados en una condición opcional.

Observaciones

Mediante el elemento Import , puede reutilizar código común a muchos archivos de proyecto. El uso de importaciones facilita el mantenimiento del código, ya que las actualizaciones que realice en el código compartido se propagan a todos los proyectos que lo importen.

Por convención, los archivos de proyecto compartidos e importados se guardan como archivos .targets, pero son archivos de proyecto de MSBuild estándar. MSBuild no impide importar un proyecto con una extensión de nombre de archivo diferente, pero se recomienda usar la extensión .targets para mantener la coherencia.

Las rutas de acceso relativas de los proyectos importados se interpretan en relación con el directorio del proyecto que se importa (con algunas excepciones que se indican más adelante). Por lo tanto, si un archivo de proyecto se importa en varios archivos de proyecto en ubicaciones diferentes, las rutas de acceso relativas del archivo de proyecto importado se interpretarán de manera diferente para cada proyecto importado. Hay dos excepciones. Una excepción es que, en los elementos Import, la ruta de acceso siempre se interpreta en relación con el proyecto que contiene el elemento Import. Otra excepción es que UsingTask siempre interpreta la ruta de acceso relativa del atributo AssemblyFile en relación con el archivo que contiene el elemento UsingTask.

Se asignan valores basados en el archivo del proyecto que se importa a todas las propiedades reservadas de MSBuild relacionadas con el archivo de proyecto a las que se hace referencia en un proyecto importado (por ejemplo, MSBuildProjectDirectory y MSBuildProjectFile).

Si el proyecto importado no tiene un atributo DefaultTargets, los proyectos importados se examinan en el orden en que se importan y se usa el valor del primer atributo DefaultTargets detectado. Por ejemplo, si ProyectoA importa ProyectoB y ProyectoC (en ese orden), y ProyectoB importa ProyectoD, MSBuild primero busca el atributo DefaultTargets especificado en ProyectoA, después en ProyectoB, luego en ProyectoD y, por último, en ProyectoC.

El esquema de un proyecto importado es idéntico al de un proyecto estándar. Aunque MSBuild puede compilar un proyecto importado, es poco probable que lo haga porque un proyecto importado no suele contener información sobre las propiedades que se establecen o el orden en el que se ejecutan los destinos. El proyecto importado depende del proyecto en el que se importa para obtener esa información.

Caracteres comodín

En .NET Framework 4, MSBuild permite caracteres comodín en el atributo Project. Cuando hay caracteres comodín, se ordenan todas las coincidencias encontradas (para la reproducibilidad) y, después, se importan en ese orden como si dicho orden se hubiera establecido explícitamente.

Esto es útil si quiere ofrecer un punto de extensibilidad para que otra persona pueda importar un archivo sin que usted tenga que agregar explícitamente el nombre del archivo al archivo de importación. Para este propósito, Microsoft.Common.Targets contiene la siguiente línea en la parte superior del archivo.

<Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\$(MSBuildThisFile)\ImportBefore\*" Condition="'$(ImportByWildcardBeforeMicrosoftCommonTargets)' == 'true' and exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\$(MSBuildThisFile)\ImportBefore')"/>

Ejemplo

En el ejemplo siguiente se muestra un proyecto que tiene varios elementos y propiedades y que importa un archivo de proyecto general.

<Project DefaultTargets="Compile"
    xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

    <PropertyGroup>
        <resourcefile>Strings.resx</resourcefile>

        <compiledresources>
            $(O)\$(MSBuildProjectName).Strings.resources
        </compiledresources>
    </PropertyGroup>

    <ItemGroup>
        <CSFile Include="*.cs" />

        <Reference Include="System" />
        <Reference Include="System.Data" />
    </ItemGroup>

    <Import Project="$(CommonLocation)\General.targets" />
</Project>

Compartir vía