【C#】ContainsKeyはKeyの存在チェックのみをします【Dictionary】

こんにちは！
今日はC#における「Dictionary」クラスと、その中のメソッド「ContainsKey」についてお話しします。
プログラミングをしていると、特定のキーが辞書型のコレクションに存在するかどうかをチェックする場面によく遭遇しますよね。
そんな時に役立つのが「ContainsKey」です。

このメソッドは、辞書に特定のキーが存在するかどうかを調べる際に非常に便利です。
辞書型コレクションを使うとき、キーの存在を確認せずに値にアクセスしようとすると、存在しないキーに対しては例外が発生してしまいます。
そこで「ContainsKey」の出番です。
このメソッドを使うことで、安全にキーの存在をチェックし、プログラムのエラーを未然に防ぐことができるんです。

この記事では、まず「ContainsKey」の基本的な使い方を説明し、次に「TryGetValue」メソッドとの違いを比較しながら、いつどちらを使うべきかを見ていきます。
それでは、C#の「ContainsKey」メソッドについて、さっそく詳しく見ていきましょう！

この記事でわかること

ContainsKeyの役割
ContainsKeyの使い方
ContainsKeyとTryGetValueの違い

Contents

ContainsKeyはKeyの存在チェックを行う
ContainsKeyの使い方
Dictionaryから値を取得するならTryGetValueがおすすめ
まとめ

ContainsKeyはKeyの存在チェックを行う

「ContainsKey」メソッドは、C#のDictionaryクラスに備わっているメソッドで、特定のキーが辞書内に存在するかどうかを確認するために使用されます。
このメソッドは非常にシンプルで、キーをパラメータとして受け取り、そのキーが辞書内に存在すれば「true」を、存在しなければ「false」を返します。

なぜこのメソッドが重要なのでしょうか？Dictionaryを使用する際、キーに基づいて値を取得しようとすると、そのキーが存在しない場合に例外が発生します。
これを防ぐためには、値にアクセスする前にキーの存在を確認する必要があります。
この時に「ContainsKey」が役立ちます。

たとえば、ユーザーIDとユーザー名を保持する辞書があり、特定のユーザーIDがその辞書内にあるかを確認する必要がある場合、先に「ContainsKey」を使用してIDの存在を確認することができるのです。
これにより、安全に辞書から値を取得することができ、プログラムの安定性が向上します。

簡単に言えば、「ContainsKey」は「安全チェック」の役割を果たし、プログラムの安全性を高めるために不可欠なメソッドなんです。

ContainsKeyの使い方

「ContainsKey」の使い方を具体的に見ていきましょう。
このメソッドは、Dictionaryクラスのインスタンスに対して呼び出され、チェックしたいキーを引数として渡します。
戻り値はbool型で、キーが存在すれば「true」、存在しなければ「false」を返します。

では、簡単なサンプルコードを見てみましょう。
ここでは、文字列のキーと整数の値を持つDictionaryを作成し、特定のキーが存在するかを「ContainsKey」でチェックします。


using System;
using System.Collections.Generic;

class Program
{
	static void Main()
	{
		var dictionary = new Dictionary<string, int>
		{
			{"apple", 1},
			{"banana", 2},
			{"cherry", 3}
		};

		var keyToCheck = "apple";
		if (dictionary.ContainsKey(keyToCheck))
		{
			Console.WriteLine($"{keyToCheck} is in the dictionary.");
		}
		else
		{
			Console.WriteLine($"{keyToCheck} is not in the dictionary.");
		}
	}
}

このコードでは、まずいくつかのフルーツと数字のペアをDictionaryに追加しています。
そして、「apple」というキーがDictionaryに存在するかを「ContainsKey」でチェックしています。
存在する場合はコンソールに「apple is in the dictionary.」と出力され、存在しない場合は「apple is not in the dictionary.」と出力されます。

このように「ContainsKey」を使うことで、キーの存在を効率的に確認し、例外のリスクを減らすことができるんです。

Dictionaryから値を取得するならTryGetValueがおすすめ

「ContainsKey」がキーの存在チェックに特化しているのに対して、もう一つの便利なメソッド「TryGetValue」は、キーの存在チェックと同時に値の取得も行います。
これは特に、キーが存在するか不明な状況で、値を取得しようとする際に役立つメソッドです。

「TryGetValue」は、キーと、そのキーに対応する値を出力するための変数を引数として受け取ります。
このメソッドも戻り値はbool型で、キーが存在すれば「true」を返し、同時に出力引数に値をセットします。
キーが存在しない場合は「false」を返します。

サンプルコードを見てみましょう。


using System;
using System.Collections.Generic;

class Program
{
	static void Main()
	{
		var dictionary = new Dictionary<string, int>
		{
			{"apple", 1},
			{"banana", 2},
			{"cherry", 3}
		};

		if (dictionary.TryGetValue("apple", out var value))
		{
			Console.WriteLine($"The value of 'apple' is {value}.");
		}
		else
		{
			Console.WriteLine("'apple' is not in the dictionary.");
		}
	}
}

このコードでは、「apple」というキーの存在をチェックしながら、その値も同時に取得しています。
この方法は、まず「ContainsKey」でキーの存在をチェックし、その後キーに基づいて値を取得する、という2ステップの処理を1ステップで行うことができます。

「TryGetValue」の使用は、特にパフォーマンスが重要な場面で有用です。
キーの存在チェックと値の取得を一度の操作で行うことで、辞書の検索処理を最適化し、プログラムの効率を高めることができるんですよ。

TryGetValueについては、こちらの記事も参考にしてください。