CA2026: Prefira JsonElement.Parse em vez de JsonDocument.Parse(). RootElement

Motivo

O código usa JsonDocument.Parse().RootElement para analisar JSON em um JsonElement.

Descrição da regra

JsonElement.Parse é mais eficiente do que chamar JsonDocument.Parse().RootElement. O tipo JsonDocument implementa IDisposable e aluga matrizes de ArrayPool<T>, o que pode levar a vazamentos de memória ou aumento da pressão do coletor de lixo (GC) se você não gerenciar corretamente o documento. O JsonElement.Parse método, introduzido no .NET 10, analisa o JSON diretamente em um JsonElement sem essas preocupações, tornando-o mais eficiente e menos propenso a erros.

Como corrigir violações

Substitua chamadas por JsonDocument.Parse().RootElementJsonElement.Parse().

Exemplos

O snippet de código a seguir mostra uma violação da CA2026:

public static void ProcessJsonViolation(string json)
{
    JsonElement element = JsonDocument.Parse(json).RootElement;
    //...
}

Public Sub ProcessJsonViolation(json As String)
    Dim element As JsonElement = JsonDocument.Parse(json).RootElement
    '...
End Sub

O snippet de código a seguir corrige a violação:

public static void ProcessJsonFixed(string json)
{
    JsonElement element = JsonElement.Parse(json);
    //...
}

Public Sub ProcessJsonFixed(json As String)
    Dim element As JsonElement = JsonElement.Parse(json)
    '...
End Sub

Quando suprimir avisos

Não suprima avisos dessa regra. Se você estiver direcionando para o .NET 10 ou posterior, deve usar JsonElement.Parse() para melhorar o desempenho e o gerenciamento de recursos.

Suprimir um aviso

Se você quiser suprimir apenas uma única violação, adicione diretivas de pré-processamento ao arquivo de origem para desabilitar e, em seguida, habilitar novamente a regra.

#pragma warning disable CA2026
// The code that's violating the rule is on this line.
#pragma warning restore CA2026

Para desabilitar a regra para um arquivo, pasta ou projeto, defina sua severidade none no arquivo de configuração.

[*.{cs,vb}]
dotnet_diagnostic.CA2026.severity = none

Para obter mais informações, consulte Como suprimir avisos de análise de código.

Consulte também

• Regras de confiabilidade
• JsonElement.Parse
• JsonDocument.Parse