[Java] Object equality in Java

Posted on | Edited on | In |

在Java中，要比較兩個基本型態的變數，要使用==。
要比較兩個物件型態的變數，要使用equals。

因為所有的物件都是繼承Object，加上Object的equals()是使用==判定，所以需要Override Object的equals()函式。

Object的equals()函式：

1
2
3
public boolean equals(Object paramObject) {
	return (this == paramObject);
}

範例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public class Point {
	public final int	x;
	public final int	y;

	public Point(int x, int y) {
		this.x = x;
		this.y = y;
	}

	@Override
	public boolean equals(Object that) {
		if (that instanceof Point) {
			Point point = (Point) that;
			return this.x == point.x && this.y == point.y;
		}

		return false;
	}
    
	@Override
	public int hashCode() {
		return Objects.hash(x,y);
	}    
}
  • 注意：當Override equals時，hashCode最好也要Override。

例如：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public class PointTest {
	private Object	point1;
	private Point	point2;

	@Before
	public void setUp() {
		point1 = new Point(1, 1);
		point2 = new Point(1, 1);
	}

	@Test
	public void testCase() {
		Set<Object> set = new HashSet<Object>();
		set.add(point1);
		assertTrue(set.contains(point2));
	}
}

  1. 計算point2的hashCode
  2. 計算point1的hashCode
  3. 若hashCode一樣代表落在同一個bucket
  4. 再透過equals判別是否相等

hashCode可以透過Objects.hash()協助計算，或是自行設計公式。
例如：String的hashCode)。

有蠻多類似的文章提到為什麼要用31當乘數呢?例如：Why does Java’s hashCode() in String use 31 as a multiplier?

查了相關的討論幾乎都是31式質數並且jvm可以對其做最佳化，個人推測主要原因31可以大幅降低collision的機會，或許演算法或是有相關的論文會有更詳細的說明。

相關資料：

物件相等性（上）

範例的原始碼：https://github.com/pandaforme/ObjectEqual