CA1854: IDictionary.TryGetValue(TKey, out TValue)
メソッドを優先する
プロパティ | 値 |
---|---|
ルール ID | CA1854 |
Title | IDictionary.TryGetValue(TKey, out TValue) メソッドを優先する |
[カテゴリ] | パフォーマンス |
修正が中断ありか中断なしか | なし |
.NET 9 では既定で有効 | 提案として |
原因
IDictionary.ContainsKey
チェックによって保護される IDictionary
要素アクセス。
規則の説明
IDictionary
の要素がアクセスされたとき、インデクサー実装によって、IDictionary.ContainsKey
メソッドが呼び出され、null 値がないか確認されます。 if
句で IDictionary.ContainsKey
も呼び出し、値参照を保護する場合、1 つだけ必要なとき、2 つの参照が実行されます。
違反の修正方法
IDictionary.ContainsKey
呼び出しと要素のアクセスを IDictionary.TryGetValue
メソッドの呼び出しで置換します。
違反:
public string? GetValue(string key)
{
if (_dictionary.ContainsKey(key))
{
return _dictionary[key];
}
return null;
}
Public Function GetValue(key As String) As String
If _dictionary.ContainsKey(key) Then
Return _dictionary(key)
End If
Return Nothing
End Function
修正:
public string? GetValue(string key)
{
if (_dictionary.TryGetValue(key, out string? value))
{
return value;
}
return null;
}
Public Function GetValue(key As String) As String
Dim value as String
If _dictionary.TryGetValue(key, value) Then
Return value
End If
Return Nothing
End Function
どのようなときに警告を抑制するか
IDictionary.ContainsKey
チェック中に値参照を回避する IDictionary
のカスタム実装を使用している場合、この警告は非表示にして問題ありません。
警告を抑制する
単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。
#pragma warning disable CA1854
// The code that's violating the rule is on this line.
#pragma warning restore CA1854
ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none
に設定します。
[*.{cs,vb}]
dotnet_diagnostic.CA1854.severity = none
詳細については、「コード分析の警告を抑制する方法」を参照してください。
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
.NET