Java - Equals, Hashcode 메소드

Equals와Hashcode, toString 등.. 기존의 정의되어있는 메소드를 오버라이딩을 하여 사용하는 경우가 많다.
Equals와 toString은 어떤 용도로 사용하는지 알고있었지만, Hashcode의 경우 IntelliJ IDE의 자동완성 기능에서 종종 보았지만, 의미와 용도를 잘 모르고 지나치는 경우가 많았다. (부끄럽지만 알아볼 생각도 안했다) 

Equals와 Hashcode 메소드에 대해 알아보자 !

아래의 코드와 같이 member1객체와 member2객체를 선언하고 객체를 비교하였을 때, 결과는 어떻게 될까? 답은 당연히 false일 것이다. 그 이유는 둘은 동일 객체가 아니기 때문이다.

public class Test {

    public static void main(String[] args) {

        final Member member1 = new Member("1");
        final Member member2 = new Member("1");

        System.out.println(member1 == member2); //false
        System.out.println(member1.equals(member2)); //false
    }

    public static class Member {

        private String id;

        public Member(final String id) {
            this.id = id;
        }
    }
}

 

동일 객체란 서로 같은 참조를 바라보는 것을 말한다. 예를 들어 아래와 같을 수 있다.

public class Test {

    public static void main(String[] args) {

        final Member member1 = new Member("1");
        final Member member2 = member1;

        System.out.println(member1 == member2); //true
        System.out.println(member1.equals(member2)); //true
    }

    public static class Member {

        private String id;

        public Member(final String id) {
            this.id = id;
        }
    }
}

 

 

위의 예제의 경우 동일 객체이기 때문에, 둘 다 true 값이 나온다.  유저의 id가 같은데 왜 다른 유저가 되는지에 대해 의문을 품을 수 있다. 보통 자바에서 이것을 동등 객체라고 한다. 동등 객체를 비교하기 위해서는 equals 함수를 사용해야 한다. 하지만 이전 예제에서 equals 함수의 결과값도 false가 나왔다. 이는 equals 함수를 재정의 하지 않았기 때문이다. 

객체 비교(equals( ))

다음은 Object의 equals() 메소드이다. 

public boolean equals(Object obj) {...}

Object 클래스의 equals()는 아래와 같은 기능으로써 이 메소드는 비교 연산자인 ==과 동일한 결과를 리턴한다. 오로지 참조값이 같은지(= 동일 객체인지) 확인하는 기능이다.

public boolean equalse(Object obj) {
    return this == obj;
}

자바에서는 두 객체를 동등 비교할 때 equals() 메소드를 흔히 사용한다. equals() 메소드는 두 객체를 비교해서 논리적으로 동등하면 true를 리턴하고 그렇지 않으면 false를 리턴한다. 논리적으로 동등하다는것은 둘의 참조값과 관계없이 객체 내부의 값이 같다는 것을 의미한다. 이 equals 함수를 재정의한 대표적인 예가 String 클래스이다. String 클래스의 equals 함수는 번지수 비교가 아닌, 문자열을 비교한다. 아래는 String Class의 equals 메소드의 코드이다.

//String class
public boolean equals(Object anObject) {
    if (this == anObject) {
        return true;
    }
    if (anObject instanceof String) {
        String anotherString = (String)anObject;
        int n = value.length;
        if (n == anotherString.value.length) {
            char v1[] = value;
            char v2[] = anotherString.value;
            int i = 0;
            while (n-- != 0) {
                if (v1[i] != v2[i])
                    return false;
                i++;
            }
            return true;
        }
    }
    return false;
}

위 소스를 보면 Object로 객체를 받아 하나하나 문자열을 비교하는 것을 볼 수 있다. char은 참조값이 아닌 기본값이기 때무에 == 로 비교가 가능하다. 

팁: String을 이용해 문자열 리터럴방식으로 문자열을 정의하면 동일 객체를 생성하게 되어있다.

예를 들어 Member라는 클래스가 있는데 여기에 Id값이 같은경우에 동등객체로 취급한다면 equals() 메소드를 재정의해서 id필드값이 같음을 비교하면 된다. 아래의 코드를 참조하자.

public class Member {
    public String id;
    public Member(String id) {
        this.id = id;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof Member) {
            Member member = (Member) obj;
            if (obj.equals(id)) {
                return true;
            }
        }
        return false;
    }
}

위와 같이 equals 메소드를 재정의하게 되면 Member 객체를 통해 객체를 비교할 때 id가 같다면 두 객체는 동등할 것이다.

• 동일성 비교는 == 이다. 객체 인스턴스 의 주소 값을 비교한다.
• 동등성 비교는 equals() 메소드를 사용해서 객체 내부의 값을 비교한다.

Java HashCode란?

객체 해시코드란 객체를 식별한 하나의 정수값을 말한다. Object의 hashCode() 메소드는 객체의 메모리 번지를 이용해서 해시코드를 만들어 리턴하기 때문에 객체 마다 다른 값을 가지고있다. 객체의 값을 동등성 비교시 hashCode()를 오버라이딩 할 필요성이 있는데, 컬렉션 프레임워크에서 HashSet, HashMap, HashTable은 다음과 같은 방법으로 두 객체가 동등한지 비교한다.

우선 hashCode() 메소드를 실행해서 리턴된 해시코드 값이 같은지를 본다. 해시 코드값이 같으면 equals() 메소드로 다시 비교한다. 이 두개가 모두 맞아야 동등 객체로 판단한다. 

아래의 예제를 보면 Key 클래스의 equals 메소드를 재정의해서 number 필드값이 같으면 true를 리턴하도록했다. 그러나 hashCode 메소드를 재정의 하지 않았기 때문에 Object hashCode() 메소드가 사용된다.

public class Key {
    public int number;

    public Key(int number) {
        this.number = number;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof Key) {
            Key compareKey = (Key) obj;
            if (this.number == compareKey.number) {
                return true;
            }
        }
        return false;
    }
}

이런 경우 두개의 동등한 객체를 HashMap의 식별키로 Key 객체를 사용하면 저장된 값을 찾아 오지 못한다. 왜냐하면 number 필드 값이 같더라도 hashCode() 메소드에서 리턴하는 해시코드가 다르기 때문에 다른 식별키로 인식하기 때문이다. 아래의 예제를 실행해보자!

public class KeyExample{
  public static void main(String[] args){

    //Key 객체를 식별키로 사용해서 String 값을 저장하는 HashMap 객체생성.
    HashMap<Key, String> hashMap = new HashMap<Key, String>();

    //식별키 "new key(1)"로 "홍길동"을 저장함
    hashMap.put(new Key(1), "홍길동");

    //식별키 "new key(1)"로 "홍길동"을 읽어옴
    String value = hashMap.get(new Key(1));
    System.out.println(value);
  }
}

위에 내용에서 Hash Code를 정의하지 않았기 때문에 값은 null이 조회될 것이다. 만약 의도한 대로 홍길동을 읽으려면 아래와 같이 hashCode를 재정의 해야 한다.

public class Key{
...
  @override
  public int hashCode(Object obj){
    return number;
  }
}

저장할 때의 new Key(1)과 읽을 때의 new Key(1)은 다른 참조값의 다른 객체이지만 HashMap은 hashCode()의 리턴값이 같고, equals() 리턴값이 true가 나오기 때문에 두 객체는 동등 객체로 평가하여 하나의 키처럼 사용하게 된다. (즉 같은 식별키로 인식한다는 뜻이다) 이러한 이유로 객체의 동등성 비교를 위해서는 Object의 equals() 메소드만 재정의하지 말고, hashCode() 메소드도 재정의해서 논리적 동등 객체일경우 동일한 해시코드가 리턴되도록 해야한다.

다시한번 강조하지만 키를 기반으로 찾는 것이지 객체의 참조 값으로 찾는 것은 아니다. 고로 hash code값이 같다고해서 객체의 참조 값이 같은 것은 아니다.

해시코드 생성(hash(), hashCode())

object 중에 해쉬코드를 생성해주는 역할이 있다. 이 Object.hash(Object ...values) 메소드는 매개값으로 주어진 값들을 이용해서 해시 값들을 이용해서 해시 코드를 생성하는 역할을 하는데, 주어진 매개값들로 배열을 생성하고 Arrays.hashCode() 재정의할 때 리턴값을 생성하기 위해 사용하면 좋다. 클래스 하나가 여러가지 필드를 가지고 있을 때 이 필드들로부터 해시코드를 생성하게 되면 동일한 필드값을 가지는 객체는 동일한 해시코드를 가질 수 있다. 좀 더 정밀한 동등 객체를 이용한다면 이 방법을 사용할 수 있다.

IDE 또는 lombok을 이용해 더 쉽게 equals, hashCode를 재정의 할 수 있다.

@Override
public int hashCode() {
  return Objects.hash(field1, field2, filed3);
}

 

참고: https://minwan1.github.io/2018/07/03/2018-07-03-equals,hashcode/

Wan Blog