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

CKTIS / C#

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

Zapnite analýzu hodnôt `null` a opíšte oba výstupy metódy `Try*`, aby kompilátor vedel, že pri úspechu ani jeden nie je `null`.

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

Syntax

#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ína #nullable enable anotácie nulovateľnosti a príslušné upozornenia na nasledujúcich riadkoch, kým iná direktíva nezmení kontext alebo sa neskončí súbor. string? pripúšťa null; string deklaruje referenciu, ktorá by nemala byť null. Obe deklarácie majú rovnaký typ za behu a anotácia nepridáva žiadnu kontrolu za behu.

[NotNullWhen(true)] je skrátený zápis atribútu NotNullWhenAttribute z priestoru názvov System.Diagnostics.CodeAnalysis. Pri parametri out string? znamená, že ak metóda vráti true, práve tento výstup nie je null. Záruka platí len pre označený parameter, preto TryGetLabels označuje primary a secondary samostatne.

Metóda musí pred každým bežným návratom priradiť hodnoty obom parametrom out. Pre "menu" táto implementácia poskytne "Open" a "Close" a vráti true. Pre iný kľúč priradí obom parametrom null a vráti false. Je to rozhodnutie implementácie: atribút nevyžaduje, aby pri návrate false bola niektorá z výstupných hodnôt null.

Vo vetve if kompilátor považuje obe referencie za nenulové, takže možno čítať obe vlastnosti Length bez !. Vo vetve else môžu byť podľa kompilátora obe hodnoty null; ?? poskytne náhradný text. Atribút nevynucuje dodržanie zmluvy za behu. Na porovnanie [MaybeNull] povoľuje potenciálne nulový výstup aj pri deklarácii, ktorá null nepripúšťa, zatiaľ čo [MemberNotNull] opisuje stav uvedených polí alebo vlastností po návrate metódy, nie stav parametrov out.

Prí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ýsledok

4, 5
<null>, <null>

Prvý riadok obsahuje dĺžky oboch popisov, druhý zobrazuje obe značky pre `null`. Odstráňte atribút iba z `secondary` a znovu zostavte projekt: očakáva sa CS8602 pri `secondary.Length`, nie pri `primary.Length`.

Súvisiace lekcie

  • C# · Lekcia 53 · Pokročilá · Verzia: 3

Zdroje