CKTIS / C#
C# — `#nullable enable`, `string?` und `[NotNullWhen(true)]` für zwei `out`-Parameter
Aktiviere die Nullbarkeitsanalyse und beschreibe beide Ausgaben einer `Try*`-Methode, damit der Compiler im Erfolgsfall beide als nicht null erkennt.
Version: 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 auf .NET 8 aktiviert #nullable enable Nullbarkeitsannotationen und die zugehörigen Warnungen für die folgenden Zeilen, bis eine andere Direktive den Kontext ändert oder die Datei endet. string? lässt null zu; string deklariert eine Referenz, die nicht null sein soll. Beide haben denselben Laufzeittyp, und die Annotation fügt keine Laufzeitprüfung hinzu.
[NotNullWhen(true)] ist die Kurzform des Attributs NotNullWhenAttribute aus System.Diagnostics.CodeAnalysis. An einem out string?-Parameter bedeutet es: Gibt die Methode true zurück, ist genau dieser Ausgabewert nicht null. Die Zusicherung gilt nur für den annotierten Parameter. Deshalb annotiert TryGetLabels sowohl primary als auch secondary separat.
Die Methode muss beiden out-Parametern vor jeder normalen Rückkehr einen Wert zuweisen. Für "menu" liefert diese Implementierung "Open" und "Close" und gibt true zurück. Für einen anderen Schlüssel weist sie beiden null zu und gibt false zurück. Das ist eine Entscheidung der Implementierung: Das Attribut verlangt bei false für keinen Ausgabewert null.
Im if-Zweig behandelt der Compiler beide Referenzen als nicht null. Deshalb lassen sich beide Length-Eigenschaften ohne ! lesen. Im else-Zweig können beide Werte aus Sicht des Compilers null sein; ?? liefert Ersatztext. Das Attribut erzwingt den Vertrag zur Laufzeit nicht. Im Gegensatz dazu lässt [MaybeNull] trotz einer nicht-nullbaren Deklaration einen möglicherweise nullwertigen Ausgabewert zu, während [MemberNotNull] den Zustand benannter Felder oder Eigenschaften nach der Rückkehr einer Methode beschreibt, nicht den von out-Parametern.
Beispiele
#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;
}Ergebnis
4, 5 <null>, <null>
Die erste Zeile enthält die Längen der beiden Beschriftungen, die zweite zeigt beide Platzhalter für `null`. Entferne das Attribut nur von `secondary` und kompiliere erneut: CS8602 ist bei `secondary.Length` zu erwarten, nicht bei `primary.Length`.
Zugehörige Lektionen
- C# · Lektion 53 · Fortgeschritten · Version: 3