Javaについて徹底解説!

Javaを陰から支えるhashCode、その仕組みと実装方法を基礎から紹介

大石 英人

開発エンジニア/Java20年/Java GOLD/リーダー/ボールド歴2年

Object.hashCodeは、呼び出されたインスタンスの特徴を表す「ハッシュ値」を返すメソッドです。

このハッシュ値はHashMapHashSetなどのJava標準APIにあるクラスの多くで使われます。そして、hashCodeObject.equalsと実に深い関係があるものなのです。

ですから、hashCodeequalsがしっかり実装されていないと、それらのクラスが動いてほしいように動いてくれません。hashCodeequalsは一心同体ともいえるメソッドなのです。

この記事では、そんな大事なメソッドhashCodeについて、考え方と実例を交えながら、初心者向けにお伝えします。

※この記事のサンプルは、Java 11の環境で動作確認しています


1.hashCodeはインスタンスの特徴を表す数字を得るもの

皆さんは、MD5SHA-2のようなハッシュ関数と言うものをご存じでしょうか。簡単に言えば、何かのモノから一つの数字を作り出すアルゴリズムのことです。同じモノならいつでもどこでも同じ数字になりますし、違うモノ同士は同じ数字になるべくならないように仕様が設計されています。

        【参考】

        https://ja.wikipedia.org/wiki/ハッシュ関数

        →ハッシュ関数とは何か、が説明されています。

Javaでもインスタンスのハッシュ関数と呼べるものがあります。それがintを戻すObject.hashCodeです。インスタンスのhashCodeを呼び出すと、インスタンス自身の特徴が反映されたintの数字、すなわちハッシュ値が戻ってきます。

hashCodeはequalsと同じく、すべてのクラスのスーパークラスであるObjectのメソッドなので、すべてのクラスで使えます。これをJavaの内部では色々と活用しているのです。


2.hashCodeは主にハッシュテーブルで活用する

hashCodeで得られる数字は、「ハッシュテーブル」というデータ構造で主に使われます。ハッシュテーブルの中でデータを効率的に分類しつつ、データを高速に検索するためのキー情報として、hashCodeで得られる数字を使うのです。ハッシュテーブル以外では、例えばデータのキャッシュなどでも活用されます。

        【参考】

        https://ja.wikipedia.org/wiki/ハッシュテーブル

        →ハッシュテーブルとは何か、が説明されています。

ハッシュテーブルは、JavaではHashMapHashSetの内部で使われています。ですから、HashMapのキー、HashSetの値に使うクラスでhashCodeが適切に作られていなければ、これらのハッシュテーブルを使うクラスが予想どおりに動いてくれないのです。


3.hashCodeはしっかりとオーバーライドする

hashCodeがきちんと作られているかいないかで、大きく違いが出てきます。

hashCodeは抽象メソッドではないので、Objectでのデフォルト実装は一応ありますが、それぞれのクラスのことを考えてくれたハッシュ値を戻してはくれないのです。

3-1.hashCodeをオーバーライドしないと駄目な例

例えば、hashCodeをオーバーライドしないと以下のような動きの違いが出てきます。

もちろん後者が意図どおりの動きなのですが、hashCodeをオーバーライドしているかいないかだけで、処理結果が全然違ってきてしまうのです。


4.equalsとhashCodeを結びつける3つのルール

equalsとhashCodeはお互いに深く関係しています。両方とも「同じ」か調べるものですが、用途が違います。でも、きちんと連携していなければなりません。

以下の3つのルールの中で、重要なのは12です。hashCodeはこれを守るように作らなければなりません。equalsの動きをを変えたなら、hashCodeも必ずセットで変えましょう、ということでもあります。

  1. equalsでの判断で使うフィールドが変わらないなら、hashCodeの値も変わらない
  2. equalsの結果がtrueなら、違うインスタンスでもhashCodeの値は同じになる
  3. equalsの結果がfalseなら、hashCodeの値は違わなくてもいい

hashCodeの値は自分自身を特徴づける数字でしかなく、インスタンス同士の簡易的な分類・識別が主目的です。

intは全体で43億とおり「しか」表現できない32bitの数字なので、違うクラスのインスタンスが同じintを戻すこともありえます。これを考慮に入れる必要があります。

なお、equalsについては以下の記事も参照してください。

関連記事

5.hashCodeの具体的な計算方法

基本的には、equalsで同じかの判断に使うフィールドのhashCodeを寄せ集めたものを、hashCodeが戻す数字とします。こうすると、なかなかいい感じにインスタンスごとにハッシュ値が異なるからです。

hashCodeの計算方法には「これ一択!!」と言うものはありません。でも、Javaの標準APIにはハッシュコードを計算するユーティリティメソッドがあるので、それを使うとプログラム中で統一したやり方で計算できます。

基本的には、equalsでの判定に使うフィールド全てに対して個別にハッシュ値を計算し、全てを計算結果に混ぜ込んで最終的な値を作ります。

5-1.Javaの標準APIを使う方法

5-1-1.基本的な実装方法

equalsで使うフィールド全てに対して、以下のような感じで計算します。計算式と31はおまじないのようなものだと、今のところはとりあえず考えておいてください。

5-1-2.プリミティブ型のハッシュ値の計算方法

プリミティブ型のラッパークラス(IntegerDoubleなど)にあるhashCodeを使うといいでしょう。

引数があるhashCodeは、引数のプリミティブ型の値に対するhashCodeを返すstaticメソッドです。引数のないhashCodeは、プリミティブ型のインスタンス自身のhashCodeを返すインスタンスメソッドです。

5-1-3.参照型のハッシュ値の計算方法

参照型の場合は、そのインスタンスが持つhashCodeが戻すハッシュ値を使うのが原則です。ただし、そのクラスがequalsと連動したhashCodeを実装しているかは確認しましょう。そうでないと、おかしな計算結果になってしまいます。

実際の計算には、java.util.ObjectsstaticメソッドhashCodeを使うといいでしょう。nullの場合も処理してくれますので、自分でif文を書かなくてもいいため楽ができます。

5-1-4.配列のハッシュ値の計算方法

java.util.ArraysのhashCodeは、配列の要素ごとにhashCodeを実行して、全体の結果を戻してくれます。配列の型ごとにオーバーライドされたメソッドがあります。

ちなみに、Objects.hashを呼び出すと、Java 11の実装ではこのメソッドが実行されます。

java.util.ArraysのdeepHashCodeは、配列の要素の型を自動判定して、再帰的にhashCodeを計算してくれます。例えば、二次元以上の多次元配列を扱いたい場合でも大丈夫です。

5-1-5.hashCodeの実装例

では試しに、前述の方法でhashCodeを実装してみます。

5-2.【参考】Effective JavaでのhashCode計算方法

有名なJavaの本「Effective Java」で紹介されているhashCode計算の方法は以下のものです(これは第二版のもの)

1.int resultを、0でない定数(例:17)で初期化する。
2.クラス内のフィールドf(equalsで使うものすべて)で以下の計算をする。
    (a) fのハッシュ値「int c」を計算する。
       i. booleanなら「(f ? 0 : 1)」の結果
       ii. byte/char/short/intなら「(int)f」の結果
       iii. longなら「(int)(f ^ (f >>> 32))」の結果
       iv. floatなら「Float.floatToIntBits(f)」の結果
       v. double なら「Double.doubelToLongBits(f)」のlongで、2 (a) iiiをした結果
       vi. 配列ではない参照型変数なら「f.hashCode()」の結果(※きちんと実装されていそうなら)。fがnullなら0。
       vii. 配列なら、各要素を別々のフィールドとしてi~vを行った結果
    (b) cを「result = 31 * result + c」として結果に混ぜ込む

ちなみに、「31」という謎の数字がいきなり出ていますし、その数字を使ってなぜか掛け算をしています。前述したJava標準APIでの計算方法に出てきた数字31や計算式も、これが元ネタだったりします。

これらの数字や計算方法には、なかなか深遠な理由があるのです。興味があれば、ハッシュコードの計算方法について調べてみてもいいでしょう。

なお、Java標準APIでの実装も、概ねこれと同じです。ただし、細かいところは違っています。


6.【発展】hashCodeのあれこれ

6-1.hashCodeはオーバーライドするもの

Object.hashCodeは、サブクラスで適切にオーバーライド(override)しなければなりません。違う引数を持ったメソッドを作ってオーバーロード(overload)しても、期待したとおりの動きにはなりませんので、気を付けましょう。

6-2.hashCodeを自動生成して楽をする

hashCodeの計算で使うフィールドが増えてくると、それらのフィールドを計算途中にきちんと入れて、動作確認をするだけでも一苦労です。ですが、IDEやライブラリを上手に使うと、きちんとしたhashCodeを簡単に自動生成できたりするのです!! ここで学んで、ぜひどんどん活用しましょう。

6-2-1.IDEの機能を使う

Eclipse、IntelliJ IDEANetBeansなどのJava向けIDEでは、hashCodeを自動生成してくれる機能があります。ここではEclipseでの例を示します。

例えば、以下のようなクラスがあったとします。このクラスにEclipseequalsを自動生成してみましょう。

このクラスをパッケージエクスプローラなどから、「右クリック」「ソース」hashCode()およびequals()の生成」を選びます。すると「hashCode()およびequals()の生成」ウィザードが表示されるので、equalshashCodeの対象としたいフィールドを選び、OKボタンを押します。

すると、以下のようにequalshashCodeが自動生成されました。少々ごちゃごちゃしたソースコードですが、きちんと動きます。それに、実装しづらいhashCodeequalsと同期を取って生成してくれるのは、大変助かりますね。

【参考】

        IntelliJ IDEAの自動生成ウィザード

        https://www.jetbrains.com/help/idea/generate-equals-and-hashcode-wizard.html

        →[英語]IntelliJ IDEAの該当部分のマニュアルです。

 

        NetBeansでの自動生成手順

        https://blogs.oracle.com/java/ten-time-savers-in-netbeans-v2

        →[英語]Number 2: Auto-generate getters and setters, constructors and more!」のところに手順があります。

 

        https://stackoverflow.com/questions/38242576/can-netbeans-auto-generate-correct-hashcode-and-equals-methods-for-a-mapping

        →[英語]equalsを自動する操作の簡単な手順が紹介されています。

 

6-2-2.ライブラリを使う(Lombokなど)

hashCodeはIDEに自動生成させる以外にも、外部ライブラリを使って自動生成する方法もあります。代表的なのは、Lombokというライブラリを使うことです。

Lombokの詳細や使えるようにする手順は省きますが、以下のようにクラスへアノテーション「@EqualsAndHashCode」を付けるだけで、クラスにあるフィールドを使ったequalshashCodeを自動的に作ってくれます!!(※) ものすごく楽ちんですね。

※Javaのソースコード上にはequalshashCodeは作成されず、コンパイルした結果のクラスファイル(.class)の中だけに、オーバーライドされたメソッドの実装が自動的に含まれます。

【参考】

        Project Lombok

        https://projectlombok.org/

        →[英語]プロジェクトのWEBページです

 

        @EqualsAndHashCode

        https://projectlombok.org/features/EqualsAndHashCode

        →[英語]公式WEBページ内の、@EqualsAndHashCodeの説明ページです。


7.さいごに

この記事では、Object.hashCodeを説明してきました。hashCodeを使うと、インスタンスを表すハッシュ値が得られます。

あなたが作ったクラスでhashCodeequalsと併せてオーバーライドしていないと、HashMapHashSetが上手く動きません。equalsをオーバーライドした時は、忘れずにhashCodeもオーバーライドしましょうね。

equalsとhashCodeを正しく作れば、Javaの標準APIにある色々なクラスを、正しく便利に使えるようになります。少し難しい考え方が求められるところもありますが、しっかりとポイントを押さえて活用できるようになりましょう。

私たちは、全てのエンジニアに市場価値を高め自身の望む理想のキャリアを歩んでいただきたいと考えています。もし、今あなたが転職を検討しているのであればこちらの記事をご一読ください。理想のキャリアを実現するためのヒントが見つかるはずです。

『技術力』と『人間力』を高め市場価値の高いエンジニアを目指しませんか?

私たちは「技術力」だけでなく「人間力」の向上をもって遙かに高い水準の成果を出し、関わる全ての人々に感動を与え続ける集団でありたいと考えています。

高い水準で仕事を進めていただくためにも、弊社では次のような環境を用意しています。

  • 定年までIT業界で働くためのスキル(技術力、人間力)が身につく支援
  • 「給与が上がらない」を解消する6ヶ月に1度の明確な人事評価制度
  • 平均残業時間17時間!毎週の稼動確認を徹底しているから実現できる働きやすい環境

現在、株式会社ボールドでは「キャリア採用」のエントリーを受付中です。

まずは以下のボタンより弊社の紹介をご覧いただき、あなたの望むキャリアビジョンをエントリーフォームより詳しくお聞かせください。