База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / C#

C# — `#nullable enable`, `string?` и `[NotNullWhen(true)]` за два параметъра `out`

Включи анализа за `null` и опиши двата изхода на метод `Try*`, за да знае компилаторът, че при успех нито един не е `null`.

Версия: C# 12 and .NET 8; later runtimes may add compatible features

Синтаксис

#nullable enable
using System.Diagnostics.CodeAnalysis;

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

В C# 12 с .NET 8 директивата #nullable enable включва анотациите за допустимост на null и свързаните предупреждения за следващите редове, докато друга директива не промени контекста или до края на файла. string? допуска null, а string декларира референция, която не би трябвало да е null. Типът по време на изпълнение е един и същ и анотацията не добавя проверка при изпълнение.

[NotNullWhen(true)] е съкратеният запис на атрибута NotNullWhenAttribute от пространството от имена System.Diagnostics.CodeAnalysis. Върху параметър out string? той означава, че ако методът върне true, точно тази изходна стойност не е null. Гаранцията важи само за анотирания параметър, затова TryGetLabels анотира primary и secondary поотделно.

Методът трябва да присвои стойности и на двата параметъра out преди всяко нормално връщане. За "menu" тази реализация предоставя "Open" и "Close" и връща true. За друг ключ присвоява null и на двата параметъра и връща false. Това е решение на реализацията: атрибутът не изисква някой от изходите да е null, когато методът върне false.

В клона if компилаторът приема, че и двете референции са различни от null, затова можеш да прочетеш и двете свойства Length без !. В else компилаторът приема, че и двете стойности могат да са null; ?? осигурява заместващ текст. Атрибутът не налага договора по време на изпълнение. За сравнение, [MaybeNull] допуска изходна стойност null въпреки декларация, която не допуска null, а [MemberNotNull] описва състоянието на посочени полета или свойства след връщане от метод, не на параметри out.

Примери

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

Резултат

4, 5
<null>, <null>

Първият ред съдържа дължините на двата етикета, а вторият показва и двата маркера за `null`. Премахни атрибута само от `secondary` и компилирай отново: очаква се CS8602 при `secondary.Length`, но не и при `primary.Length`.

Свързани уроци

  • C# · Урок 53 · Напреднало · Версия: 3

Източници