Udostępnij za pośrednictwem

Weryfikowanie zgodnych struktur

  • Artykuł

Pakiety zawierające zgodne struktury muszą mieć pewność, że kod skompilowany na jednym z nich może być uruchamiany względem innego. Przykłady zgodnych par struktury to:

  • .NET Standard 2.0 i .NET 7
  • .NET 6 i .NET 7

W obu tych przypadkach użytkownicy mogą tworzyć kompilacje na platformie .NET Standard 2.0 lub .NET 6 i uruchamiać je na platformie .NET 7. Jeśli pliki binarne nie są zgodne z tymi strukturami, użytkownicy mogą napotkać błędy czasu kompilacji lub czasu wykonywania.

Walidacja pakietu przechwytuje te błędy w czasie pakowania. Oto przykładowy scenariusz:

Załóżmy, że piszesz grę, która manipuluje ciągami. Musisz obsługiwać zarówno użytkowników platform .NET Framework, jak i .NET (.NET Core). Pierwotnie projekt dotyczył platformy .NET Standard 2.0, ale teraz chcesz korzystać z Span<T> platformy .NET 6, aby uniknąć niepotrzebnych alokacji ciągów. W tym celu chcesz mieć wiele obiektów docelowych dla platformy .NET Standard 2.0 i .NET 6.

Napisałeś następujący kod:

#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

Następnie spróbuj utworzyć pakiet projektu (przy użyciu programu dotnet pack Visual Studio lub Visual Studio) i kończy się niepowodzeniem z powodu następującego błędu:

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]

CompatibleFrameworks

Zdajesz sobie sprawę, że zamiast wykluczać DoStringManipulation(string) platformę .NET 6, należy po prostu podać dodatkową DoStringManipulation(ReadOnlySpan<char>) metodę dla platformy .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.
    }

Spróbuj ponownie spakować projekt i zakończy się powodzeniem.

CompatibleFrameworksSuccessful

Tryb ścisły

Tryb ścisły dla tego modułu sprawdzaniaEnableStrictModeForCompatibleFrameworksInPackage poprawności można włączyć, ustawiając właściwość w pliku projektu. Włączenie trybu ścisłego zmienia niektóre reguły i wykonuje inne reguły podczas uzyskiwania różnic. Jest to przydatne, gdy chcesz, aby obie strony były porównywane dokładnie tak samo na ich powierzchni i tożsamości. Aby uzyskać więcej informacji, zobacz Tryb ścisły.