Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / C#

C# — `#nullable enable`, `string?` a `[NotNullWhen(true)]` pro dva parametry `out`

Zapněte analýzu hodnot `null` a popište oba výstupy metody `Try*`, aby kompilátor věděl, že při úspěchu ani jeden není `null`.

Verze: C# 12 and .NET 8; later runtimes may add compatible features

Syntaxe

#nullable enable
using System.Diagnostics.CodeAnalysis;

static bool TryGetLabels(
    string key,
    [NotNullWhen(true)] out string? primary,
    [NotNullWhen(true)] out string? secondary)

V C# 12 na .NET 8 zapíná #nullable enable anotace nulovatelnosti a související upozornění na následujících řádcích, dokud jiná direktiva nezmění kontext nebo neskončí soubor. string? připouští null; string deklaruje referenci, která by neměla být null. Za běhu mají stejný typ a anotace nepřidává žádnou kontrolu za běhu.

[NotNullWhen(true)] je zkrácený zápis atributu NotNullWhenAttribute z oboru názvů System.Diagnostics.CodeAnalysis. U parametru out string? říká, že pokud metoda vrátí true, právě tento výstup není null. Záruka platí jen pro označený parametr, proto TryGetLabels označuje primary a secondary samostatně.

Metoda musí před každým běžným návratem přiřadit hodnoty oběma parametrům out. Pro "menu" tato implementace poskytne "Open" a "Close" a vrátí true. Pro jiný klíč přiřadí oběma parametrům null a vrátí false. Jde o rozhodnutí implementace: atribut nevyžaduje, aby některý z výstupů byl null, když metoda vrátí false.

Ve větvi if kompilátor považuje obě reference za nenulové, takže lze číst obě vlastnosti Length bez !. Ve větvi else mohou být z pohledu kompilátoru obě hodnoty null; ?? dodá náhradní text. Atribut nevynucuje smlouvu za běhu. Pro srovnání [MaybeNull] připouští na výstupu null i přes deklaraci nepřipouštějící null, zatímco [MemberNotNull] popisuje stav jmenovaných polí či vlastností po návratu metody, nikoli stav parametrů out.

Příklady

#nullable enable
using System;
using System.Diagnostics.CodeAnalysis;

foreach (string key in new[] { "menu", "other" })
{
    if (TryGetLabels(key, out string? primary, out string? secondary))
    {
        Console.WriteLine($"{primary.Length}, {secondary.Length}");
    }
    else
    {
        Console.WriteLine($"{primary ?? "<null>"}, {secondary ?? "<null>"}");
    }
}

static bool TryGetLabels(
    string key,
    [NotNullWhen(true)] out string? primary,
    [NotNullWhen(true)] out string? secondary)
{
    if (key == "menu")
    {
        primary = "Open";
        secondary = "Close";
        return true;
    }

    primary = null;
    secondary = null;
    return false;
}

Výsledek

4, 5
<null>, <null>

První řádek obsahuje délky obou popisků, druhý ukazuje obě značky pro `null`. Odeberte atribut pouze z `secondary` a sestavte projekt znovu: očekává se CS8602 u `secondary.Length`, nikoli u `primary.Length`.

Související lekce

  • C# · Lekce 53 · Pokročilá · Verze: 3

Zdroje