C#のDictionary.ContainsKey()メソッドの使い方を徹底解説！サンプルコード付き

C#のDictionary.ContainsKey()メソッドは、Dictionary<TKey, TValue>内に指定したキーが存在するかどうかを判定するためのメソッドです。キーが見つかればtrue、見つからなければfalseを返します。

構文

public bool ContainsKey (TKey key);

パラメータ「key」には、検索対象となるキーを指定します。

使用例1：キーが存在する場合

using System;
using System.Collections.Generic;

public class Demo {
   public static void Main(){
      Dictionary<string, string> dict =
      new Dictionary<string, string>();
      dict.Add("One", "John");
      dict.Add("Two", "Tom");
      dict.Add("Three", "Jacob");
      dict.Add("Four", "Kevin");
      dict.Add("Five", "Nathan");

      Console.WriteLine("要素数 = " + dict.Count);
      Console.WriteLine("\nキーと値のペア...");
      foreach(KeyValuePair<string, string> res in dict){
         Console.WriteLine("Key = {0}, Value = {1}", res.Key, res.Value);
      }

      if (dict.ContainsKey("Three"))
         Console.WriteLine("キーが見つかりました！");
      else
         Console.WriteLine("キーは辞書内に存在しません！");

      dict.Clear();
      Console.WriteLine("クリア後のキーと値のペア...");
      foreach(KeyValuePair<string, string> res in dict){
         Console.WriteLine("Key = {0}, Value = {1}", res.Key, res.Value);
      }
      Console.WriteLine("現在の要素数 = " + dict.Count);
   }
}

出力結果

要素数 = 5
キーと値のペア...
Key = One, Value = John
Key = Two, Value = Tom
Key = Three, Value = Jacob
Key = Four, Value = Kevin
Key = Five, Value = Nathan
キーが見つかりました！
クリア後のキーと値のペア...
現在の要素数 = 0

この例では、キー「Three」が辞書に登録されているため、「キーが見つかりました！」と表示されます。その後、Clear()メソッドですべての要素を削除すると、要素数が0になっていることを確認できます。

使用例2：キーが存在しない場合

using System;
using System.Collections.Generic;

public class Demo {
   public static void Main(){
      Dictionary<string, string> dict =
      new Dictionary<string, string>();
      dict.Add("One", "John");
      dict.Add("Two", "Tom");
      dict.Add("Three", "Jacob");
      dict.Add("Four", "Kevin");
      dict.Add("Five", "Nathan");

      Console.WriteLine("要素数 = " + dict.Count);
      Console.WriteLine("\nキーと値のペア...");
      foreach(KeyValuePair<string, string> res in dict){
         Console.WriteLine("Key = {0}, Value = {1}", res.Key, res.Value);
      }

      if (dict.ContainsKey("mykey"))
         Console.WriteLine("キーが見つかりました！");
      else
         Console.WriteLine("キーは辞書内に存在しません！");

      dict.Clear();
      Console.WriteLine("クリア後のキーと値のペア...");
      foreach(KeyValuePair<string, string> res in dict){
         Console.WriteLine("Key = {0}, Value = {1}", res.Key, res.Value);
      }
      Console.WriteLine("現在の要素数 = " + dict.Count);
   }
}

出力結果

要素数 = 5
キーと値のペア...
Key = One, Value = John
Key = Two, Value = Tom
Key = Three, Value = Jacob
Key = Four, Value = Kevin
Key = Five, Value = Nathan
キーは辞書内に存在しません！
クリア後のキーと値のペア...
現在の要素数 = 0

この例では、キー「mykey」は辞書に登録されていないため、「キーは辞書内に存在しません！」と表示されます。

まとめ

ContainsKey()メソッドを使用することで、Dictionary内のキーの有無を簡単に確認できます。存在しないキーに直接アクセスすると例外が発生するため、値を取得する前にこのメソッドでチェックしておくと安全です。また、TryGetValue()メソッドを使えば、キーの存在確認と値の取得を一度に行うことも可能です。