KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / C#

C# — `#nullable enable`, `string?` en `[NotNullWhen(true)]` voor twee `out`-parameters

Schakel nullbaarheidsanalyse in en beschrijf beide uitkomsten van een `Try*`-methode, zodat de compiler weet dat bij succes geen van beide `null` is.

Versie: 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)

In C# 12 op .NET 8 schakelt #nullable enable nullbaarheidsannotaties en de bijbehorende waarschuwingen in voor de volgende regels, totdat een andere richtlijn de context wijzigt of het bestand eindigt. string? staat null toe; string declareert een referentie die niet null hoort te zijn. Beide hebben hetzelfde type tijdens de uitvoering, en de annotatie voegt geen controle tijdens de uitvoering toe.

[NotNullWhen(true)] is de korte schrijfwijze van het attribuut NotNullWhenAttribute uit System.Diagnostics.CodeAnalysis. Op een out string?-parameter betekent dit dat juist die uitvoer niet null is als de methode true retourneert. De garantie geldt alleen voor de geannoteerde parameter. Daarom annoteert TryGetLabels primary en secondary afzonderlijk.

De methode moet beide out-parameters vóór elke normale terugkeer een waarde geven. Voor "menu" levert deze implementatie "Open" en "Close" en retourneert ze true. Voor een andere sleutel krijgen beide parameters null en retourneert de methode false. Dat is een keuze van de implementatie: het attribuut vereist niet dat een van de uitkomsten null is wanneer de methode false retourneert.

In de if-tak behandelt de compiler beide referenties als niet-null, zodat je beide Length-eigenschappen zonder ! kunt lezen. In de else-tak ziet de compiler beide waarden als mogelijk null; ?? levert vervangende tekst. Het attribuut dwingt het contract tijdens de uitvoering niet af. Ter vergelijking: [MaybeNull] staat een mogelijk null-resultaat toe ondanks een niet-nullbare declaratie, terwijl [MemberNotNull] de toestand beschrijft van benoemde velden of eigenschappen nadat de methode terugkeert, niet die van out-parameters.

Voorbeelden

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

Resultaat

4, 5
<null>, <null>

De eerste regel bevat de lengtes van beide labels; de tweede toont beide aanduidingen voor `null`. Verwijder het attribuut alleen van `secondary` en bouw opnieuw: verwacht CS8602 bij `secondary.Length`, maar niet bij `primary.Length`.

Gerelateerde lessen

  • C# · Les 53 · Gevorderd · Versie: 3

Bronnen