Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

C# — `#nullable enable`, `string?` i `[NotNullWhen(true)]` dla dwóch parametrów `out`

Włącz analizę wartości `null` i opisz osobno oba wyniki metody `Try*`, aby kompilator rozpoznawał, że po sukcesie żaden z nich nie jest `null`.

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

Składnia

#nullable enable
using System.Diagnostics.CodeAnalysis;

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

W C# 12 na .NET 8 dyrektywa #nullable enable włącza adnotacje nullowalności i związane z nią ostrzeżenia od następnego wiersza do kolejnej dyrektywy, która zmieni kontekst, lub do końca pliku. string? dopuszcza null, a string oznacza referencję, która nie powinna być null. Obie deklaracje mają ten sam typ w czasie wykonania; adnotacja nie dodaje kontroli podczas działania programu.

[NotNullWhen(true)] to skrócony zapis atrybutu NotNullWhenAttribute z przestrzeni nazw System.Diagnostics.CodeAnalysis. Na parametrze out string? oznacza: jeśli metoda zwróci true, ten konkretny wynik nie jest null. Gwarancja dotyczy tylko oznaczonego parametru, więc TryGetLabels oznacza osobno primary i secondary.

Metoda musi przypisać wartości obu parametrom out przed każdym zwykłym powrotem. W tym przykładzie dla "menu" przekazuje "Open" i "Close" oraz zwraca true. Dla innego klucza przypisuje obu null i zwraca false. To decyzja implementacji: atrybut nie mówi, że wynik musi być null po zwróceniu false.

W gałęzi if kompilator uznaje obie referencje za niebędące null, więc można odczytać obie właściwości Length bez operatora !. W else obie wartości są traktowane jako potencjalnie null; operator ?? podstawia tekst zastępczy. Atrybut nie wymusza kontraktu podczas wykonania. Dla kontrastu [MaybeNull] dopuszcza null jako wynik mimo deklaracji niedopuszczającej null, a [MemberNotNull] opisuje stan wskazanych pól lub właściwości po powrocie z metody, nie parametrów out.

Przykłady

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

Wynik

4, 5
<null>, <null>

Pierwszy wiersz zawiera długości obu etykiet, drugi pokazuje oba znaczniki `null`. Usuń atrybut tylko z `secondary` i skompiluj ponownie: oczekiwane ostrzeżenie CS8602 dotyczy `secondary.Length`, a nie `primary.Length`.

Powiązane lekcje

  • C# · Lekcja 53 · Zaawansowany · Wersja: 3

Źródła