Érvényesítés alapcsomag-verzióval

A csomagérvényesítés segíthet ellenőrizni a kódtárprojektet a csomag egy korábban kiadott, stabil verziójával szemben. A csomagérvényesítés engedélyezéséhez adja hozzá a PackageValidationBaselineVersion tulajdonságot a PackageValidationBaselineName projektfájlhoz.

A csomagérvényesítés észleli a szállított cél keretrendszerek kompatibilitástörő változásait. Azt is észleli, hogy a cél-keretrendszer támogatása el lett-e adva.

Vegyük például a következő forgatókönyvet: Az AdventureWorks.Client NuGet csomagon dolgozik, és meg szeretné győződni arról, hogy nem hajt végre véletlenül kompatibilitástörő módosításokat. A projektet úgy konfigurálja, hogy utasítsa a csomagérvényesítési eszközt az API-kompatibilitási ellenőrzések futtatására a csomag előző verziójával szemben.

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

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <PackageVersion>1.1.0</PackageVersion>
    <EnablePackageValidation>true</EnablePackageValidation>
    <PackageValidationBaselineVersion>1.0.0</PackageValidationBaselineVersion>
  </PropertyGroup>

</Project>

Néhány héttel később a program arra a feladatra vár, hogy támogatást adjon a tárhoz a kapcsolat időtúllépéséhez. A Connect metódus jelenleg így néz ki:

public static HttpClient Connect(string url)
{
    // ...
}

Mivel a kapcsolat időtúllépése speciális konfigurációs beállítás, úgy gondolhatja, hogy egyszerűen hozzáadhat egy opcionális paramétert:

public static HttpClient Connect(string url, TimeSpan timeout = default)
{
    // ...
}

Amikor azonban megpróbál csomagolni, az hibát jelez.

D:\demo>dotnet pack
MSBuild version 17.3.2+561848881 for .NET
  Determining projects to restore...
  All projects are up-to-date for restore.
  AdventureWorks.Client -> D:\demo\bin\Debug\net6.0\AdventureWorks.Client.dll
C:\Program Files\dotnet\sdk\6.0.413\Sdks\Microsoft.NET.Sdk\targets\Microsoft.NET.Compatibility.Common.targets(33,5): error CP0002: Member 'A.B.Connect(string)' exists on [Baseline] lib/net6.0/AdventureWorks.Client.dll but not on lib/net6.0/AdventureWorks.Client.dll [D:\demo\AdventureWorks.Client.csproj]

Tisztában van azzal, hogy bár ez nem egy forrástörési változás, ez bináris kompatibilitástörő változás. Ezt a problémát úgy oldhatja meg, hogy új túlterhelést ad hozzá a meglévő metódushoz paraméter hozzáadása helyett:

public static HttpClient Connect(string url)
{
    return Connect(url, Timeout.InfiniteTimeSpan);
}

public static HttpClient Connect(string url, TimeSpan timeout)
{
    // ...
}

Most, hogy becsomagolja a projektet, az sikeres lesz.

A 2.0.0-s verzió esetében úgy dönt, hogy eltávolítja az egyetlen string paramétert tartalmazó elavult Connect metódust. Alapos megfontolás után úgy dönt, hogy elfogadja ezt a kompatibilitástörő változást.

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

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <PackageVersion>2.0.0</PackageVersion>
    <EnablePackageValidation>true</EnablePackageValidation>
    <PackageValidationBaselineVersion>1.1.0</PackageValidationBaselineVersion>
  </PropertyGroup>

</Project>

- public static HttpClient Connect(string url)
- {
-     return Connect(url, Timeout.InfiniteTimeSpan);
- }

public static HttpClient Connect(string url, TimeSpan timeout)
{
    // ...
}

Ha el szeretné tiltani a CP0002 szándékos kompatibilitástörő módosítás hibáját, hozzáadhat egy CompatibilitySuppressions.xml fájlt a projekthez. Az elnyomási fájlt automatikusan létrehozhatja egyszeri hívással dotnet pack /p:GenerateCompatibilitySuppressionFile=true . A fájl letiltja a csomag során előforduló összes érvényesítési hibát. További információt a Letiltás című témakörben talál.

Ebben a példában a CompatibilitySuppressions.xml tartalmazza a hiba letiltását CP0002 :

<?xml version="1.0" encoding="utf-8"?>
<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Suppression>
    <DiagnosticId>CP0002</DiagnosticId>
    <Target>M:A.B.Connect(System.String)</Target>
    <Left>lib/net6.0/AdventureWorks.Client.dll</Left>
    <Right>lib/net6.0/AdventureWorks.Client.dll</Right>
    <IsBaselineSuppression>true</IsBaselineSuppression>
  </Suppression>
</Suppressions>

Ezt a fájlt ellenőrizni kell a forrásvezérlőben a lekéréses kérelemben és a közelgő kiadásban végrehajtott kompatibilitástörő módosítások dokumentálásához és áttekintéséhez.

Miután kiadta a csomag 2.0.0-s verzióját, törölheti a CompatibilitySuppressions.xml fájlt, és frissítheti a tulajdonságot, PackageValidationBaselineVersion hogy érvényesítse a jövőbeli módosításokat az új kiadáshoz.

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

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <PackageVersion>2.1.0</PackageVersion>
    <EnablePackageValidation>true</EnablePackageValidation>
    <PackageValidationBaselineVersion>2.0.0</PackageValidationBaselineVersion>
  </PropertyGroup>

</Project>