[Effective Java] 3주차 자바 과제

item3. private 생성자나 열거 타입으로 싱글턴임을 보증하라

 

* 싱글턴이란?

 - 인스턴스를 오직 하나만 생성할 수 있는 클래스

 - 싱글턴은 무상태(stateless)객체나 설계상 유일해야 하는 시스템 컴포넌트를 예로 들 수 있음

 

※ stateless object : 인스턴스 변수가 없는 객체

// stateless 예제
class Stateless {
    void test(); {
        System.out.println("test");
    }
}

 

 

그런데, 클래스를 싱클턴으로 만들면 이를 사용하는 클라이언트를 테스트하기가 어려워질 수 있다.

 > 타입을 인터페이스로 정의한 다음 그 인터페이스를 구현해서 만든 싱글턴이 아니라면 싱글턴 인스턴스를 가짜(mock) 구현으로 대체할 수 없기 때문이다.

 

※ mock : 실제 객체를 만들어 사용하기에 시간, 비용 등이 높거나 객체간의 의존성이 강해서 구현하기 힘들 경우 가짜 객체를 만들어서 사용하는 방법

 

 

싱글턴을 만드는 방식은 보통 두 가지로 나뉜다.

두 방식 모두 생성자는 private으로 감춰두고, 유일한 인스턴스에 접근할 수 있는 수단으로 public static 멤버를 하나 마련해둔다.

 

public static final 필드 방식의 싱글턴

 

// ex1
public class Elvis {
    public static final Elvis INSTANCE = new Elvis();
    private Elvis() { ... }
    
    public void leaveTheBuilding() { ... }
}

public class Main {
    public static void main(String[] args) {
        Elvis elvis = Elvis.INSTANCE;
        elvis.leaveTheBuilding();
    }
}

 

private 생성자는 public static final 필드인 Elvis.INSTANCE를 초기화할 때 딱 한 번만 호출된다.

 

public이나 protected 생성자가 없기 때문에 Elvis Class가 초기화될 때 만들어진 인스턴스가 전체 시스템에서 하나밖에 없다는 것이 보장된다.

 

보통의 방법으로는 클라이언트가 수정할 방법이 없지만, 예외적으로 권한이 있는 클라이언트는 리플렉션 API(item. 65)인 AccessibleObject.setAccessible을 사용해서 private 생성자를 호출할 수 있다.

 >> 이러한 공격을 방어하기 위해 생성자를 수정하여 두 번째 객체가 생성되기 전 예외처리를 하면 된다.

 

// 예외처리
private static int count;
private Elvis() {
    count++;
    if (count > 1) throw new IllegalStateExceotion();
}

 

 

정적 팩터리 방식의 싱글턴

 

// ex2
public class Elvis{
    private static final Elvis INSTANCE = new Elvis();
    private Elvis() { ... }
    public static Elvis getInstance() { return INSTANCE; }
    
    public void leaveTheBuilding() { ... }
}

public class Main {
    public static void main(String[] args) {
        Elvis a = Elvis.getInstance();
        Elvis b = Elvis.getInstance();
    }
}

 

Elvis.getInstance는 항상 같은 객체의 참조를 반환하므로 제2의 Elvis 인스턴스는 만들어지지 않는다.

 > 리플렉션을 통한 예외는 이전과 동일

 

앞전의 public 필드 방식의 장점은 해당 클래스가 싱글턴인 것이 API에 명백히 드러나고 간결하다는 것이 있다.

 

 

한편, 이번 예제인 정적 팩터리 방식의 장점은 API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다.

 >> 유일한 인스턴스를 반환하던 팩터리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수 있다.

 

두 번째 장점은 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다(item. 30)

 

세 번째 장점은 정적 팩터리의 메서드 참조를 공급자(supplier)로 사용할 수 있다.(item 43, 44)

  * Elvis::getInstance -> Supplier<Elvis>

 

 

※ 직렬화와의 관계(12장에서 다시)

 

싱글턴 클래스를 직렬화하려면 단순히 Serializable을 선언하는 것으로는 부족하다.

모든 인스턴스 필드를 일시적이라고 선언하고 readResolve 메서드를 제공해야 한다.(item. 89)

 

이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다.

 

바로 위의 예제에서는 가짜 Elvis가 만들어진다는 뜻이다.

 >> 방지를 위해서는 Elvis 클래스에 readResolve 메서드를 추가해야 한다.

 

// 싱글턴임을 보장해주는 readResolve 메서드
private Object readResolve() {
    // 진짜 Elvis를 반환하고, 가짜 Elvis는 가비지 컬렉터(GC)에 맡긴다.
    return INSTANCE;
}

 

 

열거 타입 방식의 싱글턴 - 바람직한 방법

 

public enum Elvis {
    INSTANCE;
    
    public void leaveTheBuilding() { ... }
}

 

맨 처음 방식의 public 필드와 비슷하지만, 더 간결하고 추가 노력 없이 직렬화할 수 있다.

 

그리고 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 막아준다.

 

※ 조금 부자연스러워 보일 수 있으나, 대부분 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법

 

 

단, 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다.

 

 

 

 

 

item11. equals를 재정의하려거든 hashCode도 재정의하라

 

equals를 재정의한 클래스 모두에서 hashCode도 재정의 해야함

 > 만약, 그렇지 않으면 hashCode 일반 규약을 어기게 되어 해당 클래스의 인스턴스를 HashMap이나 HashSet같은 컬렉션의 원소로 사용할 때 문제가 발생

 

※ HashMap과 HashSet

 1) HashMap : Map 인터페이스를 구현한 것으로 key-value 형식의 데이터를 저장하며 중복 key값을 허용하지 않음

 2) HashSet : Set 인터페이스를 구현한 것으로 들어오는 객체 중, 중복된 객체를 허용하지 않음

 

 

[ Object 명세에서 발췌한 규약 ]

 

■ equals 비교에 사용되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동안 그 객체의 hashCode 메서드는 몇 번을 호출해도 일관되게 항상 같은 값을 반환해야 한다. 단, 애플리케이션을 다시 실행한다면 이 값이 달라져도 상관없다.

 

■ equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.

 

■ equals(Object)가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시테이블의 성능이 좋아진다.

 

 

hashCode 재정의를 잘못할 때 크게 문제가 되는 조항은 두 번째이다.

즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 한다.

 

equals는 물리적으로 다른 두 객체를 논리적으로 같다고 판단할 수 있다.

하지만 Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여, 두 번째 규약과 달리 서로 다른 값을 반환한다.

 

// PhoneNumver 클래스의 인스턴스를 HashMap의 원소로 사용
public static void main(String[] args) {
    Map<PhoneNumber, String> m = new HashMap<>();
    m.put(new PhoneNumber(707, 867, 509), "제니");
    System.out.println(m.get(new PhoneNumber(707, 867, 509)));
}

 

이 코드의 결과로 "제니"가 나오는 것을 예상하겠지만, 실제로는 null을 반환한다.

 

예제에서는 2개의 PhoneNumber 인스턴스가 사용되었는데,

하나는 HashMap에 "제니"를 넣을 때 사용하였고, 논리적 동치인 두 번째는 이를 꺼내기 위해 사용되었다.

 

item10에서 나온 PhoneNumber 클래스는 hashCode를 재정의하지 않았기 때문에 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 어기게 되었다.

 > m.get은 엉뚱한 해시 버킷에 가서 객체를 찾으려고 한 것

 

이러한 문제는 PhoneNumber에 적절한 hashCode 메서드를 작성해주면 해결되지만, 아래와 같이 사용해서는 안된다.

 

// 적절하지 못한 예시
@Override
public int hashCode() {
    return 42;
}

 

이 코드는 동치인 모든 객체에서 똑같은 해시코드를 반환한다.

 

하지만, 모든 객체에게 똑같은 값을 돌려주기 때문에 모든 객체가 해시테이블의 버킷 하나에 담겨 있어서 마치 연결 리스트처럼 동작한다.

 

그 결과 수행 시간도 느려져서 사용할 수가 없다.

 

좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시코드를 반환한다.

이것이 세 번째 규약이 요구하는 속성이다.

 

---

 

※ 다음은 좋은 hashCode를 작성하는 간단한 요령이다.

 

1. int 변수 result를 선언한 후 값 c로 초기화한다. 이때 c는 해당 객체의 첫 번째 핵심 필드를 단계 2.a 방식으로 계산한 해시코드다.

  * 여기서 핵심 필드란 equals 비교에 사용되는 필드를 말한다.

 

2. 해당 객체의 나머지 핵심 필드 f 각각에 대해 다음 작업을 수행한다.

  a. 해당 필드의 해시코드 c를 계산한다.

     i. 기본 타입 필드라면, Type.hashCode(f)를 수행한다. 여기서 Type은 해당 기본 타입의 박싱 클래스이다.

     ii. 참조 타입 필드면서 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다. 계산이 더 복잡해질 것 같으면, 이 필드의 표준형(ca-nonical representation)을 만들어 그 표준형의 hashCode를 호출한다. 필드의 값이 null이면 0을 사용한다(다른 상수도 괜찮지만 전통적으로 0을 사용한다).

     iii. 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다. 이상의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음, 단계 2.b 방식으로 갱신한다. 배열에 핵심 원소가 하나도 없다면 단순히 상수(0을 추천한다)를 사용한다. 모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다.

  

  b. 단계 2.a에서 계산한 해시코드 c로 result를 갱신한다. 코드로는 다음과 같다.

result = 31 * result + c;

 

3. result를 반환한다.

 

 

hashCode를 다 구현했다면 이 메서드가 동치인 인스턴스에 대해 똑같은 해시 코드를 반환할지 검증

 > 동치인 인스턴스가 서로 다른 해시코드를 반환한다면 원인을 찾아 해결

 

○ 다른 클래스로부터 파생된 필드는 해시코드 계산에서 제외해도 된다.

 

○ equals 비교에 사용되지 않은 필드는 반드시 제외

  > 그렇지 않으면 두 번째 규약을 어기게 됨

 

○ 단계 2.b의 곱셉 31*result는 필드를 곱하는 순서에 따라 result 값이 달라지게 한다. 그 결과 클래스에 비슷한 필드가 여러 개 일 때 해시 효과를 높여준다.

  > 만약 String의 hashCode를 곱셈 없이 구현한다면 모든 아나그램(구성하는 철자가 같고 그 순서만 다른 문자열)의 해시코드가 같아진다.

  > 곱할 숫자를 31로 정한 이유는 31이 홀수이면서 소수이기 때문(이 숫자가 짝수이고 오버플로가 발생한다면 정보를 잃게 됨), 소수를 곱하느느 이유는 전통적으로 그리 해왔기 때문...

 

 

이러한 팁을 이용하여 hashCode를 작성

 

// 전형적인 hashCode 메서드
public final class PhoneNumber {
    private final short areaCode, prefix, lineNum;
    
    @Override public int hashCode() {
        int result = Short.hashCode(areaCode);
        result = 31 * result + Short.hashCode(prefix);
        result = 31 * result + Short.hashCode(lineNum);
        return result;
    }
}

 

위 메서드는 PhoneNumber 인스턴스의 핵심 필드 3개만을 사용

 

이 코드는 PhoneNumber에 딱 맞게 구현하여, 자바 플랫폼 라이브러리의 클래스들이 제공하는 hashCode와 비교해도 부족함이 없다.

그만큼 단순하고 빠르고 충돌이 일어날 가능성이 적다는 것이다.

 

 

※ 추가적으로 해시 충돌이 더욱 적은 방법을 써야 한다면 구아바의 com.google.common.hash.Hashing을 참고

 

---

 

Object 클래스는임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메소드인 hash를 제공

 

// Objects 클래스 내부 코드 중 일부
public final class Objects {
    public static boolean equals(Object a, Object b) {
        return(a == b) || (a != null && a.equals(b));
    }
    
    public static int hashCode(Object o) {
        return o != null ? o.hashCode() : 0;
    }
    
    public static int hash(Object... values) {
        return Arrays.hashCode(values);
    }

 

이 메서드를 활용하면 앞서 구현한 코드와 비슷한 수준의 hashCode 함수를 한 줄로 작성이 가능하다.

그러나, 속도는 더 느리긴 하다.

 

입력 인수를 담기 위한 배열이 만들어지고, 입력 중 기본 타입이 있다면 박싱과 언박싱도 거쳐야 하기 때문이다.

 

// 한 줄짜리 hashCode 메서드 - 성능이 아쉽긴 하다.
@Override
public int hashCode() {
    return Objects.hash(lineNum, prefix, areaCode);
}

 

위 코드가 한 줄로 만든 예시이다.

 

---

 

만약 클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 매번 새로 계산하기 보다는 캐싱하는 방식을 고려해야 한다.

 

이 타입의 객체가 주로 해시의 키로 사용될 것 같으면 인스턴스가 만들어질 때 해시코드를 계산해두는 것이 좋다.

 

item83에서 다시 다룰 내용이지만, 해시의 키로 사용되지 않는 경우라면 hashCode가 처음 불릴 때 계산하는 지연 초기화(lazy initialization) 전략도 있다.

필드를 지연 초기화하려면 그 클래스의 스레드를 안전하게 만들도록 신경써야 한다.

 

// 해시코드를 지연 초기화하는 hashCode 메서드
// 스레드 안정성까지 고려해야 한다.
public final class PhoneNumber {
    private final short areaCode, prefix, lineNum;
    private int hashCode;
    
    @Override
    public int hashCode() {
        int result = hashCode; // 자동으로 0으로 초기화
        if (result == 0) {
            result = Short.hashCode(areaCode);
            result = 31 * result + Short.hashCode(prefix);
            result = 31 * result + Short.hashCode(lineNum);
            hashCode = result;
        }
        return result;
    }
}

 

위 코드와 같이 지연 초기화 방식을 이용해서 구현 가능

 > 스레드의 안정성을 신경써야 함

 

추가적으로 성능을 높이기 위해 해시코드를 계산할 때 핵심 필드를 생략해서는 안 된다.

속도가 빨라질 수는 있지만, 해시 품질이 나빠져서 해시 테이블의 성능을 심각하게 떨어뜨리기 때문이다.

 

특히, 어떤 필드는 특정 영역에 몰린 인스턴스들의 해시코드를 넓은 범위로 퍼트려주는 효과가 있을지도 모르는데, 하필 그 필드를 생략한다면 해당 영역의 수 많은 인스턴스가 단 몇 개의 해시코드로 집중되어 성능이 안좋아진다.

 

실제로 자바 2 전의 String은 최대 16개의 문자만으로 해시 코드를 계산하였는데, 문자열이 길면 균일하게 나눠 16자만 뽑아내 사용한 것이었다.

URL처럼 계층적인 이름을 대량으로 사용한다면, 그 문제가 더욱 잘 드러났을 것이다.

 

 

정리

 

■ equals를 재정의할 때는 hashCode도 반드시 재정의해야 한다.

 

■ 재정의한 hashCode는 Object의 API 문서에 기술된 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현해야 한다.

 

■ 편의를 위해 item10에서 나온 AutoValue 프레임워크를 사용하여 자동으로 만들어진 equals와 hashCode사용이 가능하다.