hashCodeメソッドの中で行われている処理がイマイチ理解できない

Question

###何をしているか理解したいです。
参考書を読み進めていると、コードの中で何の処理をしているのかイマイチ理解できない箇所が出てきました。

参考書の内容は、以下のコードを実装し、オブジェクトが同じ場合は　hashCodeメソッドも同じ値を返すように修正する、というものです。

@Override
	public int hashCode() {
		final int prime = 31; //なぜ３１なのか？
		int result = 1;　　//resultに１を設定
		result = prime * result + employeeNo; // resultに３１と１を掛けてemployeeNoを足している？？
		result = prime * result + ((employeeName == null) ? 0 : employeeName.hashCode()); //?? 何をしているのかよくわからない。
		return result;　// 結果を返している・・・
	}

全体のソースコード

public class Employee {
	
	private int employeeNo;
	private String employeeName;
	
	public Employee(int employeeNo, String employeeName) {
		this.employeeNo = employeeNo;
		this.employeeName = employeeName;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		
		if (getClass() != obj.getClass()) {
			return false;
		}
	
	Employee other = (Employee)obj;
	if (this.employeeNo != other.employeeNo) {
		return false;
	}
	if (employeeName == null) {
		if (this.employeeName != null) {
			return false;
		}
		
	}
	else if (!employeeName.equals(other.employeeName)) {
		return false;
	}
	
	return true;
	
	}
	
	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + employeeNo;
		result = prime * result + ((employeeName == null) ? 0 : employeeName.hashCode());
		return result;
	}
	

}

import java.util.HashSet;
import java.util.Set;

public class Eaction {
	
	public static void main(String...arge) {
	
	Employee employee1 = new Employee(1 , "Mr.Yamada");
	Employee employee2 = new Employee(1 , "Mr.Yamada");
	
	Set<Employee> employees = new HashSet<>();
	employees.add(employee1);
	employees.add(employee2);
	
	System.out.println(employees.size());
	}
}

補足情報（FW/ツールのバージョンなど）

eclipse使用

Answer 1

hashCodeの実装方法が気になったので、回答します。

1. JDK1.7以降ならjava.util.Objects#hashがhashCodeを実装する時に使用できます。

2. ハッシュキーのインプレース変更をさけるためにhashCodeの計算に使用したフィールドはfinalで宣言してくださいな。

---

2018/03/12　追記

equalsメソッドのthis.employeeNameの判定はother.employeeNameを見るべきところを見ていないのでequalsメソッドに不具合があります。

    if (employeeName == null) {
        if (this.employeeName != null) {
            return false;
        }

    }

equalsメソッドをjava.util.Objects#deepEqualsを使った実装に変更しました。

ご参考まで。

import java.util.Objects;

public class Employee {

	private final int employeeNo;
	private final String employeeName;

	public Employee(int employeeNo, String employeeName) {
		this.employeeNo = employeeNo;
		this.employeeName = employeeName;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		// 言語仕様にてinstanceof演算子は値が nullの時はfalseを返す。
		if (!(obj instanceof Employee)) {
			return false;
		}
		Employee other = (Employee) obj;
		if (!Objects.deepEquals(this.employeeNo, other.employeeNo)) {
			return false;
		}
		return Objects.deepEquals(this.employeeName, other.employeeName);
	}

	@Override
	public int hashCode() {
		return Objects.hash(employeeNo, employeeName);
	}
}

Comments

[former_neet_cat]

追記ありがとうございます。
今後の参考にするために、参考書に書きました。
本当に助かります！

Answer 2

31の理由か心当たりがあるのは

31(2^5-1)自身が素数かつ 2^n-1 の要素のため他の数値で割れない数値だからかと思われる。

まあほかの数値の場合もあるが・・・

Comments

[former_neet_cat]

なるほど、教えていただきありがとうございます！
気になって、自身が素数かつ2^n-1 の要素などのキーワードで調べていくと以下のサイトで、同じようなことを言っているのを発見できました。
あらてめて、教えていただき感謝します。
http://www.atmarkit.co.jp/bbs/phpBB/viewtopic.php?topic=9750&forum=12

[退会済みユーザー]

べき乗表記の揺れで同じ意味かな

[退会済みユーザー]

あｗそうそう
※ Java内 で 2^n とすると XOR 扱いになるから注意が必要

Answer 3

前回の質問でHashSetを扱いました。これはSetの実装クラスの1つです。
Setは前回の回答で少し触れましたが、集合を扱うものです。主にある要素がその集合に入っているかどうかを判定します。
しかし、この「入っているかどうか」の判定が問題です。Listや配列のような扱い方をすると、いちいち先頭から順次同じものかどうかを判定していくことになり、集合が持つ要素が多くなればなるほど、それに比例して探すべき範囲が大きくなるため、時間がかかります。

この判定を一定時間で済ませるための方法が次のようになります。
集合の要素の管理は例えば配列を使うのですが、この時に格納する場所を決める際にhashCodeを使います。
hashCodeはObjectクラスで、equalsで等しいと判定されるオブジェクトからは同じ値が得られるようにと規定されています。この値を、例えばある整数で割った余りなどで配列の中での格納場所を決めれば、等しいオブジェクトが存在しうる場所が限定されます。
もちろん計算の結果同じ値が得られる場合がありますが、その場合は同じ場所に配列のように並べるなどの方法がとられることになりますが、すべてを検索し比較する方法よりも判定が速くなりやすいです。

この特性上、hashCode()は異なるオブジェクトからは異なる値が得られたほうが、異なる場所に格納されやすくなり、検索性能が良くなります(※)。その計算はそうなるように、つまり内容が異なるオブジェクトなら異なる値にしやすくなるような計算だと思ってください。「なぜそうなるのか」については私もわかりませんが、先人たちの知恵ということでしょう。

(※)hashCodeは「等しいオブジェクトからは等しい値」と決められているが、逆は必ずしも成立しなくていてもいい。
つまり、異なるオブジェクトから必ずしも異なる値が得られる必要はない。
まあ、intで表せる値が高々2^32通りなので、それより多くのインスタンスの種類が存在するならどんなにばらけるように計算しても必ず値が重複する組があることになる。

Comments

[退会済みユーザー]

やたらと1ページ毎と思われるペースで質問者さんが質問してるから気になって本をしらべたら「JAVA本格入門は2冊目以降用だった」から別の本も進めるのも視野にいれないとならないきがしてきた

[former_neet_cat]

解りやすい解説ありがとうございます！
いつも教えていただき感謝しています。

・・・もうすでに別の本を・・・げふん、げふん・・・

Answer 4

簡単に言うと、オブジェクトのHash値をとってるような感じになります。

@Override
    public int hashCode() {
        final int prime = 31; // prime つまり素数であればなんでもよい
        int result = 1;　　// どんな数字でも問題ないです。あまり大きすぎるとオーバーフローします。
        /*
         * employeeNoを足すことでオブジェクトでの一意の値を得られる
         */
        result = prime * result + employeeNo; 
        /*
         * employeeNameのHash値を足すことでオブジェクトでの一意の値を得られる
         * (employeeName == null) ? 0 : employeeName.hashCode() は三項演算子です。
         * employeeName が null ならば 0 を null でないならば employeeName の Hash値を足します
         */
        result = prime * result + ((employeeName == null) ? 0 : employeeName.hashCode());
        return result;
    }

２つのObjectを考えます

Employee employee1 = new Employee(1 , "Mr.Yamada");
Employee employee2 = new Employee(1 , "Mr.Yamada");

この場合、employeeNo と employeeName がそれぞれ同じなのでhashCodeは同じ値を返します。

しかし

Employee employee1 = new Employee(1 , "Mr.Yamada");
Employee employee2 = new Employee(2 , "Mr.Yamada");

となった場合、employeeNo が異なるため hashCodeは異なります。

これを比較することで、オブジェクトが同じかどうかを見ているのだと思われます。

Comments

[former_neet_cat]

丁寧で解りやすい解説ありがとうございます！
非常に助かりました。