Validar estruturas compatíveis

Os pacotes que contêm estruturas compatíveis precisam garantir que o código compilado em um possa ser executado em relação a outro. Exemplos de pares de estrutura compatíveis são:

• .NET Standard 2.0 e .NET 7
• .NET 6 e .NET 7

Em ambos os casos, os consumidores podem criar em relação ao .NET Standard 2.0 ou .NET 6 e executar no .NET 7. Se os binários não forem compatíveis entre essas estruturas, os consumidores poderão acabar com erros de tempo de compilação ou de tempo de execução.

A validação de pacote captura esses erros na hora de empacotar. Este é um cenário de exemplo:

Suponha que você esteja escrevendo um jogo que manipula cadeias de caracteres. Você precisa dar suporte a consumidores do .NET Framework e do .NET (.NET Core). Originalmente, seu projeto tinha como destino o .NET Standard 2.0, mas agora você deseja aproveitar o Span<T> no .NET 6 para evitar alocações de cadeias de caracteres desnecessárias. Para fazer isso, você quer ter vários destinos para .NET Standard 2.0 e .NET 6.

Você gravou o seguinte código:

#if NET6_0_OR_GREATER
    public void DoStringManipulation(ReadOnlySpan<char> input)
    {
        // use spans to do string operations.
    }
#else
    public void DoStringManipulation(string input)
    {
        // Do some string operations.
    }
#endif

Em seguida, você tenta empacotar o projeto (usando dotnet pack ou o Visual Studio) e ele falha com o seguinte erro:

D:\demo>dotnet pack
Microsoft (R) Build Engine version 17.0.0-preview-21460-01+8f208e609 for .NET
Copyright (C) Microsoft Corporation. All rights reserved.

  Determining projects to restore...
  All projects are up-to-date for restore.
  You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
  You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
  PackageValidationThrough -> D:\demo\bin\Debug\netstandard2.0\PackageValidationThrough.dll
  PackageValidationThrough -> D:\demo\bin\Debug\net6.0\PackageValidationThrough.dll
  Successfully created package 'D:\demo\bin\Debug\PackageValidationThrough.1.0.0.nupkg'.
C:\Program Files\dotnet\sdk\6.0.100-rc.1.21463.6\Sdks\Microsoft.NET.Sdk\targets\Microsoft.NET.Compatibility.Common.targets(32,5): error CP0002: Member 'A.B.DoStringManipulation(string)' exists on lib/netstandard2.0/PackageValidationThrough.dll but not on lib/net6.0/PackageValidationThrough.dll [D:\demo\PackageValidationThrough.csproj]

Você percebe que, em vez de excluir DoStringManipulation(string) para o .NET 6, basta fornecer um método DoStringManipulation(ReadOnlySpan<char>) adicional para o .NET 6:

#if NET6_0_OR_GREATER
    public void DoStringManipulation(ReadOnlySpan<char> input)
    {
        // use spans to do string operations.
    }
#endif
    public void DoStringManipulation(string input)
    {
        // Do some string operations.
    }

Você tenta empacotar o projeto novamente e ele é bem-sucedido.

Modo estrito

Você pode habilitar o modo estrito para esse validador definindo a propriedade EnableStrictModeForCompatibleFrameworksInPackage em seu arquivo de projeto. Habilitar o modo estrito altera algumas regras e executa algumas outras regras ao obter as diferenças. Isso é útil quando você quer que ambos os lados que está comparando sejam estritamente iguais em sua área de superfície e identidade. Para obter mais informações, confira o modo estrito.