CKTIS / C#
NotNullWhenAttribute — una garantía condicional de no nulidad
NotNullWhenAttribute describe la relación entre el resultado bool de un método y el estado null de un argumento. Permite que el análisis de nulabilidad reconozca la rama segura después de un método de comprobación o de estilo Try*, sin usar el operador !.
Versión: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Sintaxis
bool Method([NotNullWhen(true)] string? value)
bool TryMethod([NotNullWhen(true)] out string? value)
bool IsMissing([NotNullWhen(false)] string? value)NotNullWhenAttribute, del espacio de nombres System.Diagnostics.CodeAnalysis, es un atributo de parámetro que describe una poscondición condicional. [NotNullWhen(true)] significa que, después de que el método finalice normalmente con true, el argumento no es null, aunque su tipo lo permita. El nombre abreviado del atributo es NotNullWhen; su constructor acepta un bool y la propiedad ReturnValue expone ese valor.
Aplique el atributo a los parámetros, incluidos los parámetros out y ref, no al valor devuelto. [NotNullWhen(false)] vincula la garantía al resultado false. El resultado opuesto no significa por sí solo que el argumento sea null: el atributo no especifica su estado en esa rama.
Active el análisis de nulabilidad, por ejemplo, con #nullable enable. En el ejemplo, TryGetName garantiza un valor out no nulo cuando devuelve true, por lo que name.Length no necesita el operador !. El atributo no comprueba los valores en tiempo de ejecución ni los modifica; la implementación debe cumplir el contrato.
La API está disponible en el entorno de destino .NET 10. La configuración del repositorio LangVersion=preview no significa que este atributo sea una característica experimental.
Ejemplos
#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");
}
}
}Resultado
3 missing
El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.