CKTIS / C#
NotNullWhenAttribute — pogojno jamstvo, da vrednost ni null
NotNullWhenAttribute opisuje povezavo med bool rezultatom metode in stanjem null njenega argumenta. Analizi nullable omogoča, da po preverjalni metodi ali metodi v slogu Try* prepozna varno vejo, ne da bi uporabili operator !.
Različica: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Sintaksa
bool Method([NotNullWhen(true)] string? value)
bool TryMethod([NotNullWhen(true)] out string? value)
bool IsMissing([NotNullWhen(false)] string? value)NotNullWhenAttribute v imenskem prostoru System.Diagnostics.CodeAnalysis je atribut parametra, ki opisuje pogojni končni pogoj. [NotNullWhen(true)] pomeni, da argument po običajnem zaključku metode z rezultatom true ni null, čeprav njegov tip to dovoljuje. Skrajšano ime atributa je NotNullWhen; konstruktor sprejme bool, lastnost ReturnValue pa to vrednost razkrije.
Atribut uporabite pri parametrih, vključno s parametri out in ref, ne pa pri vrnjeni vrednosti. [NotNullWhen(false)] poveže jamstvo z rezultatom false. Nasprotni rezultat sam po sebi ne pomeni, da je argument null: atribut njegovega stanja v tej veji ne določa.
Omogočite analizo nullable, na primer z #nullable enable. V primeru TryGetName zagotavlja, da vrednost parametra out ni null, ko metoda vrne true, zato name.Length ne potrebuje operatorja !. Atribut vrednosti med izvajanjem ne preverja in jih ne spreminja; implementacija mora upoštevati pogodbo.
API je na voljo v ciljnem okolju .NET 10. Nastavitev repozitorija LangVersion=preview ne pomeni, da je ta atribut eksperimentalna funkcija.
Primeri
#nullable enable
using System;
using System.Diagnostics.CodeAnalysis;
internal static class Program
{
private static bool TryGetName(int id, [NotNullWhen(true)] out string? name)
{
name = id == 1 ? "Ada" : null;
return name is not null;
}
private static void Main()
{
foreach (int id in new[] { 1, 2 })
{
if (TryGetName(id, out string? name))
Console.WriteLine(name.Length);
else
Console.WriteLine("missing");
}
}
}Rezultat
3 missing
Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.