| 房產 | 價值觀 |
|---|---|
| 規則識別碼 | CA2026 |
| 標題 | 優先 JsonElement.Parse 於 JsonDocument.Parse().RootElement |
| 類別 | Reliability |
| 修正是破壞性或非破壞性 | Non-breaking |
| 在 .NET 10 中預設啟用 | 建議 |
原因
程式碼使用 JsonDocument.Parse().RootElement 將 JSON 解析成 JsonElement。
規則描述
JsonElement.Parse 比呼叫 JsonDocument.Parse().RootElement更有效率。 該JsonDocument類型實作IDisposable，並從ArrayPool<T>租用陣列。如果您沒有正確處理文件，這可能會導致記憶體洩漏或增加 GC 壓力。 此 JsonElement.Parse 方法在 .NET 10 中引入，可將 JSON 直接剖解析為 ， JsonElement 而不需要這些問題，使其更有效率且不易出錯。
如何修正違規
將對 的 JsonDocument.Parse().RootElement 呼叫取代為 JsonElement.Parse()。
範例
下列程式碼片段顯示違反 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
下列程式碼片段可修正違規：
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
隱藏警告的時機
不要隱藏此規則中的警告。 如果您以 .NET 10 或更新版本為對象，應該使用 JsonElement.Parse() 以獲得更好的效能和資源管理。
隱藏警告
如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。
#pragma warning disable CA2026
// The code that's violating the rule is on this line.
#pragma warning restore CA2026
若要停用檔案、資料夾或項目的規則，請在組態檔
[*.{cs,vb}]
dotnet_diagnostic.CA2026.severity = none
如需詳細資訊，請參閱 如何隱藏程式碼分析警告。
