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

CKTIS / C#

NotNullWhenAttribute — условна гаранция за ненулева стойност

NotNullWhenAttribute описва връзката между bool резултата на даден метод и null-състоянието на негов аргумент. Позволява на анализа nullable да разпознае безопасния клон след проверяващ метод или метод в стил Try*, без да се използва операторът !.

Версия: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Синтаксис

bool Method([NotNullWhen(true)] string? value)
bool TryMethod([NotNullWhen(true)] out string? value)
bool IsMissing([NotNullWhen(false)] string? value)

NotNullWhenAttribute в пространството от имена System.Diagnostics.CodeAnalysis е атрибут на параметър, който описва условно постусловие. [NotNullWhen(true)] означава, че след нормалното завършване на метода с резултат true аргументът не е null, въпреки че типът му го допуска. Съкратеното име на атрибута е NotNullWhen; конструкторът му приема bool, а свойството ReturnValue предоставя тази стойност.

Прилагайте атрибута към параметри, включително параметри out и ref, а не към върнатата стойност. [NotNullWhen(false)] свързва гаранцията с резултата false. Противоположният резултат сам по себе си не означава, че аргументът е null: атрибутът не определя състоянието му в този клон.

Активирайте анализа nullable, например с #nullable enable. В примера TryGetName гарантира ненулева стойност на параметъра out, когато върне true, затова name.Length не изисква оператор !. Атрибутът нито проверява стойностите по време на изпълнение, нито ги променя; имплементацията трябва да спазва договора.

API е наличен в целевата среда .NET 10. Настройката на хранилището LangVersion=preview не означава, че този атрибут е експериментална функционалност.

Примери

#nullable enable
using System;
using System.Diagnostics.CodeAnalysis;

internal static class Program
{
    private static bool TryGetName(int id, [NotNullWhen(true)] out string? name)
    {
        name = id == 1 ? "Ada" : null;
        return name is not null;
    }

    private static void Main()
    {
        foreach (int id in new[] { 1, 2 })
        {
            if (TryGetName(id, out string? name))
                Console.WriteLine(name.Length);
            else
                Console.WriteLine("missing");
        }
    }
}

Резултат

3
missing

Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.

Източници