이펙티브 자바 책을 읽으면서 새로 알게 된 부분을 기록한 것입니다.
private 생성자나 열거 타입으로 싱글턴임을 보증하라
싱글턴
- 인스턴스를 오직 하나만 생성할 수 있는 클래스를 뜻한다.
- 싱글턴의 예시) 무상태
stateless 객체나 설계상 유일해야 하는 시스템 컴포넌트가 있다.
- 클래스를 싱글턴으로 만들면 이를 사용하는 클라이언트를 테스트하기가 어려워질 수 있다.
- 타입을 인터페이스로 정의한 다음, 그 인터페이스를 구현해서 만든 싱글턴이 아니라면 싱글턴 클래스를 가짜
mock구현으로 대체할 수 없기 때문이다.
싱글턴을 만드는 방식 두 가지
- 두 방식 모두 생성자는
private으로 감춰두고, 유일한 인스턴스에 접근할 수 있는 수단으로 public static멤버를 하나 마련해둔다.
public static멤버가 final필드인 방식
1
2
3
4
5
6
| public class Elvis {
public static final Elvis INSTANCE = new Elvis();
private Elvise() { ... }
public void leaveTheBuilding() { ... }
}
|
private 생성자는 public static final필드인 Elvis.INSTANCE를 초기화할 때 딱 한번만 호출된다.public이나 protected생성자가 없으므로 Elvis클래스가 초기화될 때 만들어진 인스턴스는 전체에서 하나뿐임이 보장된다.- 클라이언트는 손 쓸 방법이 없다.
- 예외 한 가지) 권한이 있는 클라이언트는 리플렉션 API인
AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있다.
- 이러한 공격에 방어하려면 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던지게 하면 된다.
public 필드 방식의 장점
- 해당 클래스가 싱글턴임이 API에 명백히 드러난다는 것. ->
public static 필드가 final이니 절대로 다른 객체를 참조할 수 없다
- 간결함
정적 팩토리 메소드를 public static멤버로 제공하는 방식
1
2
3
4
5
6
7
| publci class Elvis {
private static final Elvis INSTANCE = new Elvis();
private Elvis() { ... }
public static Elvis getInstance() { return INSTANCE; }
public void leaveTheBuilding() { ... }
}
|
- Elvis.getInstance 는 항상 같은 객체의 참조를 반환하므로 제 2의 Elvis 인스턴스는 절대 만들어지지 않는다.
- 예외 한 가지) 권한이 있는 클라이언트는 리플렉션 API인
AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있다.
정적 팩토리 방식의 장점
- 마음이 바뀌면 API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다는 것 -> 유일한 인스턴스를 반환하던 팩터리 메소드가 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수 있다.
- 정적 팩토리를 제네릭 싱글턴 팩토리로 만들 수 있다는 것
- 정적 팩토리의 메서드 참조를 공급자로 사용할 수 있다는 것 - 예) `Elvis::getInstance를 Supplier로 사용하는 방식.
이런 장점들이 굳이 필요하지 않다면 public field방식이 좋다.
싱글턴으로 직렬화 하기
- 둘 중 하나의 방식으로 싱글턴 클래스를 직렬화하려면 단순히
Serializable을 구현한다고 선언하는 것만으로는 부족하다.
- 모든 인스턴스 필드를 일시적
transient이라고 선언하고 readResolve메소드를 제공해야 한다.
- 이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다.
- 싱글턴임을 보장해주는
readResolve메소드
1
2
3
4
| private Object readResolve() { ...
return INSTANCE;
// 진짜 Elvis를 반환하고 가짜 Elvis는 가비지 컬렉터에 맡긴다.
}
|
원소가 하나인 열거 타입을 선언하는 방식
1
2
3
4
5
| public enum Elvis {
INSTANCE;
public void leaveTheBuilding() { ... }
}
|
public 필드 방식과 비슷하지만 더 간결하고, 추가 노력 없이 직렬화할 수 있다.- 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 완벽히 막아준다.
- 대부분의 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다.
- 단, 만들려는 싱글턴이
Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다.
- 열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다.
