Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / C#

NotNullWhenAttribute — podmienená záruka nenulovej hodnoty

NotNullWhenAttribute opisuje vzťah medzi bool výsledkom metódy a stavom null jej argumentu. Analýze nullable umožňuje rozpoznať bezpečnú vetvu po kontrolnej metóde alebo metóde v štýle Try*, bez použitia operátora !.

Verzia: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Syntax

bool Method([NotNullWhen(true)] string? value)
bool TryMethod([NotNullWhen(true)] out string? value)
bool IsMissing([NotNullWhen(false)] string? value)

NotNullWhenAttribute v mennom priestore System.Diagnostics.CodeAnalysis je atribút parametra, ktorý opisuje podmienenú následnú podmienku. [NotNullWhen(true)] znamená, že po bežnom návrate metódy s výsledkom true argument nie je null, hoci to jeho typ povoľuje. Skrátený názov atribútu je NotNullWhen; jeho konštruktor prijíma bool a vlastnosť ReturnValue túto hodnotu sprístupňuje.

Atribút použite na parametroch vrátane parametrov out a ref, nie na návratovej hodnote. [NotNullWhen(false)] viaže záruku na výsledok false. Opačný výsledok sám osebe neznamená, že argument je null: atribút jeho stav v tejto vetve neurčuje.

Zapnite analýzu nullable, napríklad pomocou #nullable enable. V príklade metóda TryGetName zaručuje nenulovú hodnotu parametra out, keď vráti true, takže name.Length nepotrebuje operátor !. Atribút hodnoty za behu nekontroluje ani nemení; implementácia musí dodržať zmluvu.

Rozhranie API je dostupné v cieľovom prostredí .NET 10. Nastavenie repozitára LangVersion=preview neznamená, že tento atribút je experimentálnou funkciou.

Príklady

#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");
        }
    }
}

Výsledok

3
missing

Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.

Zdroje