CKTIS / C#
C# — `#nullable enable`, `string?` e `[NotNullWhen(true)]` para dois parâmetros `out`
Ativa a análise de nulabilidade e descreve as duas saídas de um método `Try*` para que o compilador saiba que nenhuma é `null` em caso de sucesso.
Versão: C# 12 and .NET 8; later runtimes may add compatible features
Sintaxe
#nullable enable
using System.Diagnostics.CodeAnalysis;
static bool TryGetLabels(
string key,
[NotNullWhen(true)] out string? primary,
[NotNullWhen(true)] out string? secondary)Em C# 12 sobre .NET 8, #nullable enable ativa as anotações de nulabilidade e os avisos associados nas linhas seguintes, até outra diretiva alterar o contexto ou até ao fim do ficheiro. string? admite null; string declara uma referência que não deve ser null. O tipo em tempo de execução é o mesmo e a anotação não acrescenta verificações em tempo de execução.
[NotNullWhen(true)] é a forma abreviada do atributo NotNullWhenAttribute do espaço de nomes System.Diagnostics.CodeAnalysis. Num parâmetro out string?, indica que, se o método devolver true, aquela saída em particular não é null. A garantia aplica-se apenas ao parâmetro anotado, pelo que TryGetLabels anota primary e secondary em separado.
O método tem de atribuir valores aos dois parâmetros out antes de cada retorno normal. Para "menu", esta implementação fornece "Open" e "Close" e devolve true. Para outra chave, atribui null a ambos e devolve false. Trata-se de uma opção da implementação: o atributo não obriga a que qualquer das saídas seja null quando o método devolve false.
No ramo if, o compilador considera que nenhuma referência é nula, pelo que podes ler ambas as propriedades Length sem !. No ramo else, considera que os dois valores podem ser nulos; ?? fornece texto alternativo. O atributo não impõe o contrato em tempo de execução. Em contraste, [MaybeNull] admite uma saída potencialmente nula apesar de uma declaração não anulável, enquanto [MemberNotNull] descreve o estado dos campos ou propriedades indicados após o retorno do método, não o dos parâmetros out.
Exemplos
#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;
}Resultado
4, 5 <null>, <null>
A primeira linha contém os comprimentos das duas etiquetas; a segunda apresenta ambos os marcadores de `null`. Retira o atributo apenas de `secondary` e volta a compilar: é esperado o aviso CS8602 em `secondary.Length`, mas não em `primary.Length`.
Lições relacionadas
- C# · Lição 53 · Avançado · Versão: 3