`contains`メソッドのよくあるミスと解決法・対処法

Javaプログラミングにおいて、containsメソッドはコレクション内に指定した要素が含まれているかどうかを判定するのに便利なメソッドです。しかし、このメソッドを適切に使用しないと、予期せぬ結果やバグが発生する可能性があります。本記事では、containsメソッドのよくあるミスとその解決法・対処法について詳しく解説します。

間違った使用法：参照値の比較

containsメソッドは、デフォルトでオブジェクトの参照値を比較します。そのため、同じ内容の異なるオブジェクトを使用している場合、意図した結果が得られないことがあります。

ArrayList<String> list = new ArrayList<>();
list.add(new String("apple"));
System.out.println(list.contains(new String("apple"))); // falseが返される

このコードでは、"apple"という内容の新しいStringオブジェクトを作成し、containsメソッドに渡しています。しかし、containsメソッドは参照値を比較するため、異なるオブジェクトであるためfalseが返されます。

問題の解決法：オブジェクトの内容を比較する

オブジェクトの内容を比較するためには、equalsメソッドを適切にオーバーライドするか、containsメソッドを使用する方法があります。

ArrayList<String> list = new ArrayList<>();
list.add(new String("apple"));
System.out.println(list.contains(new String("apple").intern())); // trueが返される

このように、internメソッドを使用して同じ内容のオブジェクトを取得することで、正しい結果を得ることができます。

間違った使用法：オブジェクトの等価性の理解不足

containsメソッドを使用する際に、オブジェクトの等価性を理解していないことがあります。Javaでは、デフォルトではオブジェクトのequalsメソッドがオブジェクトの参照の等価性を比較します。そのため、異なるオブジェクトであっても、同じ内容を持つ場合にはequalsメソッドがtrueを返すことがあります。

ArrayList<String> list = new ArrayList<>();
list.add("apple");
System.out.println(list.contains(new String("apple"))); // falseが返される

このコードでは、ArrayListにはStringオブジェクトが追加されていますが、containsメソッドはfalseを返します。これは、listに追加されたStringオブジェクトと"apple"リテラルが異なるオブジェクトであるためです。

問題の解決法：オブジェクトの内容を比較する

オブジェクトの内容を比較するためには、equalsメソッドを適切にオーバーライドするか、containsメソッドを使用する方法があります。

ArrayList<String> list = new ArrayList<>();
list.add("apple");
System.out.println(list.contains("apple")); // trueが返される

このようにすることで、containsメソッドが正しく動作し、要素が含まれているかどうかを正しく判定します。

サンプルコードの実行結果

修正されたサンプルコードを実行した結果は以下の通りです：

true

この結果からわかるように、修正されたコードではcontainsメソッドが

正しく動作し、要素が含まれているかどうかを正しく判定しています。

まとめ

本記事では、containsメソッドのよくあるミスとその解決法・対処法について詳しく説明しました。これらの解決法を活用することで、Javaプログラムの品質を向上させ、バグやエラーを防ぐことができます。是非、これらのベストプラクティスを活用して、Javaプログラムの開発に役立ててください。