Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / C#

C# — `#nullable enable`, `string?` et `[NotNullWhen(true)]` pour deux paramètres `out`

Activez l’analyse de nullabilité et décrivez séparément les deux sorties d’une méthode `Try*` pour que le compilateur sache qu’aucune ne vaut `null` en cas de succès.

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

En C# 12 sur .NET 8, #nullable enable active les annotations de nullabilité et les avertissements associés pour les lignes suivantes, jusqu’à ce qu’une autre directive change le contexte ou que le fichier se termine. string? autorise null ; string déclare une référence qui ne devrait pas valoir null. Le type à l’exécution est le même, et l’annotation n’ajoute aucun contrôle à l’exécution.

[NotNullWhen(true)] est la forme abrégée de l’attribut NotNullWhenAttribute, défini dans System.Diagnostics.CodeAnalysis. Sur un paramètre out string?, il signifie que si la méthode renvoie true, cette sortie précise ne vaut pas null. La garantie ne concerne que le paramètre annoté : TryGetLabels annote donc primary et secondary séparément.

La méthode doit affecter une valeur à chacun des deux paramètres out avant tout retour normal. Pour "menu", cette implémentation fournit "Open" et "Close", puis renvoie true. Pour une autre clé, elle affecte null aux deux paramètres et renvoie false. C’est un choix d’implémentation : l’attribut n’impose pas qu’une sortie vaille null lorsque la méthode renvoie false.

Dans la branche if, le compilateur considère les deux références comme non nulles : on peut lire les deux propriétés Length sans !. Dans else, les deux valeurs sont considérées comme potentiellement nulles ; ?? fournit un texte de remplacement. L’attribut ne fait pas respecter le contrat à l’exécution. À titre de comparaison, [MaybeNull] permet une sortie potentiellement nulle malgré une déclaration non nullable, tandis que [MemberNotNull] décrit l’état des champs ou propriétés nommés au retour de la méthode, et non celui des paramètres out.

Exemples

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

Résultat

4, 5
<null>, <null>

La première ligne contient les longueurs des deux libellés ; la seconde affiche les deux marqueurs de `null`. Retirez l’attribut de `secondary` uniquement et recompilez : CS8602 est attendu sur `secondary.Length`, mais pas sur `primary.Length`.

Leçons associées

  • C# · Leçon 53 · Avancé · Version : 3

Sources