SDK de proyectos de .NET

Artículo
10/15/2024

Los proyectos de .NET modernos están asociados a un kit de desarrollo de software (SDK) del proyecto. Cada SDK de proyecto es un conjunto de destinos de MSBuild y tareas asociadas que se encarga de compilar, empaquetar y publicar código. Un proyecto que hace referencia a un SDK de proyecto en ocasiones se denomina proyecto de estilo SDK.

SDK disponibles

Están disponibles los siguientes SDK:

ID	Descripción	Repo
`Microsoft.NET.Sdk`	SDK de .NET	https://github.com/dotnet/sdk
`Microsoft.NET.Sdk.Web`	SDK web de .NET	https://github.com/dotnet/sdk
`Microsoft.NET.Sdk.Razor`	SDK de Razor de .NET	https://github.com/dotnet/aspnetcore
`Microsoft.NET.Sdk.BlazorWebAssembly`	SDK de Blazor WebAssembly de .NET	https://github.com/dotnet/aspnetcore
`Microsoft.NET.Sdk.Worker`	SDK del servicio de trabajo de .NET
`Aspire.AppHost.Sdk`	El SDK de .NET Aspire	https://github.com/dotnet/aspire
`MSTest.Sdk`	El SDK de MSTest	https://github.com/microsoft/testfx

El SDK de .NET es el SDK base para .NET. Los otros SDK hacen referencia al SDK de .NET, y los proyectos asociados a los demás SDK disponen de todas las propiedades del SDK de .NET. El SDK web, por ejemplo, depende de los SDK de .NET y de Razor.

También puede crear un SDK propio que se puede distribuir a través de NuGet.

Para los proyectos de Windows Forms y Windows Presentation Foundation (WPF), se especifica el SDK de .NET (Microsoft.NET.Sdk) y se establecen algunas propiedades adicionales en el archivo de proyecto. Para obtener más información, consulte Habilitación del SDK de escritorio de .NET.

Archivos de proyecto

Los proyectos de .NET se basan en el formato MSBuild. Los archivos de proyecto, que tienen extensiones como .csproj para los proyectos de C# y .fsproj para los de F#, están en formato XML. El elemento raíz de un archivo de proyecto de MSBuild es Project. El elemento Project tiene un atributo Sdk opcional que especifica qué SDK (y versión) se van a usar. Para usar las herramientas de .NET y compilar el código, establezca el atributo Sdk en uno de los identificadores de la tabla SDK disponibles.

<Project Sdk="Microsoft.NET.Sdk">
  ...
</Project>

A partir de .NET Aspire 9, el ejemplo anterior podría usar en su lugar el SDK de .NET Aspire.

<Project Sdk="Microsoft.NET.Sdk">

    <Sdk Name="Aspire.AppHost.Sdk" Version="9.0.0-rc.1.24511.1" />
    <!-- Omitted for brevity... -->

</Project>

Para obtener más información, consulte Herramientas y configuración de .NET Aspire.

Para especificar un SDK que proviene de NuGet, incluya la versión al final del nombre, o bien especifique el nombre y la versión en el archivo global.json.

<Project Sdk="MSBuild.Sdk.Extras/2.0.54">
  ...
</Project>

Otra manera de especificar el SDK es mediante el elemento Sdk de nivel superior:

<Project>
  <Sdk Name="Microsoft.NET.Sdk" />
  ...
</Project>

Al hacer referencia a un SDK de una de estas formas, se simplifican enormemente los archivos de proyecto de .NET. Durante la evaluación del proyecto, MSBuild agrega importaciones implícitas para Sdk.props en la parte superior del archivo del proyecto y para Sdk.targets en la inferior.

<Project>
  <!-- Implicit top import -->
  <Import Project="Sdk.props" Sdk="Microsoft.NET.Sdk" />
  ...
  <!-- Implicit bottom import -->
  <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" />
</Project>

Sugerencia

En una máquina Windows, los archivos Sdk.props y Sdk.targets se pueden encontrar en la carpeta %ProgramFiles%\dotnet\sdk\[version]\Sdks\Microsoft.NET.Sdk\Sdk.

Procesamiento previo del archivo del proyecto

Puede ver el proyecto totalmente expandido como MSBuild lo ve después de incluir el SDK y sus destinos mediante el comando dotnet msbuild -preprocess. El conmutador preprocess del comando dotnet msbuild muestra qué archivos se han importado, sus orígenes y sus contribuciones a la compilación sin tener que compilar el proyecto realmente.

Si el proyecto tiene varias plataformas de destino, para centrar los resultados del comando en una sola, debe especificarla como una propiedad de MSBuild. Por ejemplo:

dotnet msbuild -property:TargetFramework=net8.0 -preprocess:output.xml

Inclusiones y exclusiones predeterminadas

Las inclusiones y exclusiones predeterminadas de los elementos Compile, los recursos insertados y los elementos None se definen en el SDK. A diferencia de los proyectos de .NET Framework que no son de SDK, no es necesario especificar estos elementos en el archivo del proyecto, ya que los valores predeterminados cubren los casos de uso más comunes. Este comportamiento hace que el archivo de proyecto sea más pequeño y más fácil de entender y editar manualmente, si es necesario.

En la tabla siguiente se muestra qué elementos y qué globs se incluyen y excluyen en el SDK de .NET:

Elemento	Glob para incluir	Glob para excluir	Glob para quitar
Compile	*/.cs (u otras extensiones de lenguaje)	*/.user; */.proj; /.sln; */.vssscc	N/D
EmbeddedResource	*/.resx	*/.user; */.proj; /.sln; */.vssscc	N/D
None	*/	*/.user; */.proj; /.sln; */.vssscc	*/.cs; */.resx

Nota:

De forma predeterminada, las carpetas ./bin y ./obj (representadas por las propiedades de MSBuild $(BaseOutputPath) y $(BaseIntermediateOutputPath)) se excluyen de los globs. Las exclusiones se representan mediante la propiedad DefaultItemExcludes.

El SDK de Escritorio de .NET tiene inclusiones y exclusiones adicionales para WPF. Para obtener más información, vea Inclusiones y exclusiones predeterminadas de WPF.

Si define explícitamente cualquiera de estos elementos en el archivo del proyecto, es probable que obtenga un error de compilación NETSDK1022. Para obtener información sobre cómo resolver el error, consulte NETSDK1022: Se han incluido elementos duplicados.

Directivas using implícitas

A partir de .NET 6, se agregan directivas global using implícitas a los proyectos de C# nuevos. Esto significa que puede usar los tipos definidos en estos espacios de nombres sin tener que especificar su nombre completo ni agregar manualmente una directiva using. El aspecto implícito hace referencia al hecho de que las directivas global using se agregan a un archivo generado en el directorio obj del proyecto.

Se agregan directivas global using implícitas para los proyectos que usan uno de los SDK siguientes:

Microsoft.NET.Sdk
Microsoft.NET.Sdk.Web
Microsoft.NET.Sdk.Worker
Microsoft.NET.Sdk.WindowsDesktop

Se agrega una directiva global using para cada espacio de nombres en un conjunto de espacios de nombres predeterminados basados en el SDK del proyecto. Estos espacios de nombres predeterminados se muestran en la tabla siguiente.

SDK	Espacios de nombres predeterminados
Microsoft.NET.Sdk	System System.Collections.Generic System.IO System.Linq System.Net.Http System.Threading System.Threading.Tasks
Microsoft.NET.Sdk.Web	Espacios de nombres Microsoft.NET.Sdk System.Net.Http.Json Microsoft.AspNetCore.Builder Microsoft.AspNetCore.Hosting Microsoft.AspNetCore.Http Microsoft.AspNetCore.Routing Microsoft.Extensions.Configuration Microsoft.Extensions.DependencyInjection Microsoft.Extensions.Hosting Microsoft.Extensions.Logging
Microsoft.NET.Sdk.Worker	Espacios de nombres Microsoft.NET.Sdk Microsoft.Extensions.Configuration Microsoft.Extensions.DependencyInjection Microsoft.Extensions.Hosting Microsoft.Extensions.Logging
Microsoft.NET.Sdk.WindowsDesktop (Windows Forms)	Espacios de nombres Microsoft.NET.Sdk System.Drawing System.Windows.Forms
Microsoft.NET.Sdk.WindowsDesktop (WPF)	Espacios de nombres Microsoft.NET.Sdk System.IO eliminado System.Net.Http eliminado

Si quiere deshabilitar esta característica o habilitar directivas global using implícitas en un proyecto de C# existente, puede hacerlo a través de la propiedad de MSBuild ImplicitUsings.

También puede especificar más directivas global using implícitas mediante la adición de elementos Using (o elementos Import para proyectos de Visual Basic) al archivo del proyecto, por ejemplo:

<ItemGroup>
  <Using Include="System.IO.Pipes" />
</ItemGroup>

Referencias implícitas del paquete

Cuando el proyecto tiene como destino .NET Standard 1.0-2.0, el SDK de .NET agrega referencias implícitas a determinados metapaquetes. Un metapaquete es un paquete basado en la plataforma que consta únicamente de dependencias en otros paquetes. Se hace referencia implícitamente a los metapaquetes en función de las plataformas de destino especificadas en la propiedad TargetFramework o TargetFrameworks (plural) del archivo del proyecto.

<PropertyGroup>
  <TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>

<PropertyGroup>
  <TargetFrameworks>netstandard2.0;net462</TargetFrameworks>
</PropertyGroup>

Si es necesario, puede deshabilitar las referencias de paquete implícitas mediante la propiedad DisableImplicitFrameworkReferences y agregar referencias explícitas solo a los marcos o paquetes que necesite.

Recomendaciones:

Si el destino es .NET Framework o .NET Standard 1.0-2.0, no incluya una referencia explícita a los metapaquetes NETStandard.Library o mediante un elemento <PackageReference> en el archivo de proyecto. En los proyectos de .NET Standard 1.0-2.0, se hace referencia implícitamente a estos metapaquetes. En los proyectos de .NET Framework, si se necesita alguna versión de NETStandard.Library al usar un paquete NuGet basado en .NET Standard, NuGet instala automáticamente esa versión.
Si necesita una versión concreta del metapaquete NETStandard.Library cuando el destino es .NET Standard 1.0-2.0-2.0, puede usar la propiedad <NetStandardImplicitPackageVersion> y establecer la versión necesaria.

Eventos de compilación

En los proyectos de estilo SDK, use un destino de MSBuild denominado PreBuild o PostBuild, y establezca la propiedad BeforeTargets para PreBuild, o bien la propiedad AfterTargets para PostBuild.

<Target Name="PreBuild" BeforeTargets="PreBuildEvent">
    <Exec Command="&quot;$(ProjectDir)PreBuildEvent.bat&quot; &quot;$(ProjectDir)..\&quot; &quot;$(ProjectDir)&quot; &quot;$(TargetDir)&quot;" />
</Target>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
   <Exec Command="echo Output written to $(TargetDir)" />
</Target>

Nota:

Puede usar cualquier nombre para los destinos de MSBuild. A pesar de ello, el IDE de Visual Studio reconoce los destinos PreBuild y PostBuild, por lo que, al usar esos nombres, puede editar los comandos en el IDE.
No se recomiendan las propiedades PreBuildEvent ni PostBuildEvent en los proyectos de tipo SDK, ya que las macros como $(ProjectDir) no se resuelven. Por ejemplo, no se admite el código siguiente:

<PropertyGroup>
  <PreBuildEvent>"$(ProjectDir)PreBuildEvent.bat" "$(ProjectDir)..\" "$(ProjectDir)" "$(TargetDir)"</PreBuildEvent>
</PropertyGroup>

Personalización de la compilación

Hay varias maneras de personalizar una compilación. Es posible que quiera invalidar una propiedad y pasarla como argumento al comando msbuild o dotnet. También puede agregar la propiedad al archivo del proyecto o a un archivo Directory.Build.props. Para obtener una lista de propiedades útiles para los proyectos de .NET, consulte Referencia de MSBuild para proyectos de SDK de .NET.

Sugerencia

Una manera sencilla de crear un nuevo archivo Directory.Build.props desde la línea de comandos es mediante el comando dotnet new buildprops en la raíz del repositorio.

Destinos personalizados

Los proyectos de .NET pueden empaquetar propiedades y destinos de MSBuild personalizados para su uso en proyectos que consuman el paquete. Use este tipo de extensibilidad cuando quiera:

Extender el proceso de compilación.
Acceder a artefactos del proceso de compilación, como los archivos generados.
Inspeccionar una configuración en la que se va a invocar la compilación.

Para agregar propiedades o destinos de compilación personalizados, coloque los archivos con el formato <package_id>.targets o <package_id>.props (por ejemplo, Contoso.Utility.UsefulStuff.targets) en la carpeta build del proyecto.

El fragmento de código XML siguiente es de un archivo .csproj que indica al comando dotnet pack lo que debe empaquetar. El elemento <ItemGroup Label="dotnet pack instructions"> coloca los archivos de destino en la carpeta build dentro del paquete. El elemento <Target Name="CollectRuntimeOutputs" BeforeTargets="_GetPackageFiles"> coloca los ensamblados y los archivos .json en la carpeta build.

<Project Sdk="Microsoft.NET.Sdk">

  ...
  <ItemGroup Label="dotnet pack instructions">
    <Content Include="build\*.targets">
      <Pack>true</Pack>
      <PackagePath>build\</PackagePath>
    </Content>
  </ItemGroup>
  <Target Name="CollectRuntimeOutputs" BeforeTargets="_GetPackageFiles">
    <!-- Collect these items inside a target that runs after build but before packaging. -->
    <ItemGroup>
      <Content Include="$(OutputPath)\*.dll;$(OutputPath)\*.json">
        <Pack>true</Pack>
        <PackagePath>build\</PackagePath>
      </Content>
    </ItemGroup>
  </Target>
  ...

</Project>

Para consumir un destino personalizado en el proyecto, agregue un elemento PackageReference que apunte al paquete y su versión. A diferencia de las herramientas, el paquete de destinos personalizados se incluye en el cierre de dependencia del proyecto que lo usa.

Puede configurar cómo se usa el destino personalizado. Como es un destino de MSBuild, puede depender de un destino concreto, ejecutarse después de otro destino o bien invocarse de forma manual mediante el comando dotnet msbuild -t:<target-name>. Pero para proporcionar una mejor experiencia de usuario, puede combinar las herramientas y los destinos personalizados por proyecto. En este escenario, la herramienta por proyecto acepta los parámetros necesarios y los traduce en la invocación de dotnet msbuild necesaria que ejecuta el destino. Puede ver una muestra de esta clase de sinergia en el repositorio de ejemplos de MVP Summit 2016 Hackathon del proyecto dotnet-packer.

Compartir vía