[Effective Java] item 03. private 생성자나 열거 타입으로 싱글턴임을 보증하라

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

1. 싱글턴(Singleton)이란?

싱글턴(singleton)이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다.

 

싱글턴의 전형적인 예로는 설계 상 유일해야 하는 시스템 컴포넌트나 무상태(stateless) 객체(Spring bean component)가 있다.
싱글턴 객체에도 단점이 있는데, 바로 싱글턴 객체를 이용하는 클라이언트를 테스트하기 어렵다라는 것이다.

 

만일 해당 타입을 `interface`로 정의한 다음 그 `interface `구현해서 만든 싱글턴인 경우,
싱글턴 인스턴스를 `mock(가짜 객체)`으로 구현하여 대체할 수 있지만, 그렇지 않은 경우에는 테스트 하는데에 어려움을 겪을 수 있다.

 

---

2. 싱글턴을 만드는 세 가지 방법

싱글턴을 만드는 두 가지 방법 모두, 생성자는 private로 감춰주고, public static멤버를 통해 접근하는 방식을 사용한다.

 

1️⃣ `public static` 멤버가 `final` 필드인 방식

public class Bean {
    public static final Bean INSTANCE = new Bean();

    private Bean() { }

    ...
}

public이나 protected 생성자가 없고 private 생성자만 존재하며, private 생성자는 public static final 필드인 Bean.INSTANCE를 초기화할 때 딱 한 번만 호출된다.

따라서 Bean 클래스가 초기화되며 만들어진 인스턴스가 단 하나뿐임을 보장할 수 있다.

이러한 방식의 장점은 밑과 같다.

1. 해당 클래스가 싱글턴(singleton)임이 API에 명백히 드러난다는 것
   public static 필드가 final이므로 절대로 다른 객체를 참조할 수 없다.
2. 별도의 메서드를 따로 작성하지 않아도 되기 때문에 간결하다

⚠️ 하지만 예외도 하나 존재하는데, 권한이 있는 클라이언트가 Reflection API인 AccssibleObject.setAccessible()을 사용해 private 생성자를 호출할 수 있다.
이러한 예외를 처리하려면, 생성자를 수정하여 두 번째 객체가 생성되려할 때 예외를 던지게 하면 된다.

 

 

2️⃣ 정적 팩터리 메서드를 public static 멤버로 제공하는 방식

public class Bean {
    private static final Bean INSTANCE = new Bean();

    private Bean() { }

    public static Bean getInstance() {
        return INSTANCE;
    }
    ...
}

우리는 Item 1에서 정적 팩터리 메서드에 대해 알아보았다.

'정적 팩터리 메서드를 찾기 힘들다'라는 단점을 보완하기 위해 주로 사용하는 명명 방식을 사용한다.

그 중, `getInstance()`는 인스턴스를 반환할 때 사용하는 명명법인데, 해당 메서드는 항상 같은 객체의 참조를 반환하기 때문에
인스턴스가 단 하나 뿐임을 보장할 수 있다.

단, 첫번째 방법과 같이 Reflection을 사용하여 private 생성자를 호출할 수 있는 것은 마찬가지이므로, 추가적인 예외 처리가 필요하다.

이러한 방식의 장점은 다음과 같다.

 

1. 만일, 해당 클래스를 더이상 싱글턴으로 유지하고 싶지 않다면, `API를 바꾸지 않고도 변경`할 수 있다.

public class Bean { 
	private Bean instance; 
	private Bean() { } 
    
	// 정적 팩터리 메서드만 적용 
	public static Bean from() { return new Bean(); } 
}

 

2. 정적 팩터리를 `제너릭 싱글턴 팩터리(Generic Singleton factory); item 30`로 변경할 수 있다는 것이다.

public class Bean { 
    private static final Bean INSTANCE = new Bean(); 
    
    private Bean() { } 
    
    public static Bean getInstance() { return (Bean) INSTANCE; } 
    public void say(T t) { System.out.println(t); } 
}

 

 

3. 정적 팩터리의 메서드 참조를 `Supplier`로 사용할 수 있다는 점이다.

public class Bean { 
    private static final Bean INSTANCE = new Bean(); 
    private Bean() { } 
    public static Bean getInstance() { return INSTANCE; } 
}

public static void main(String[] args) { 
	Supplier supplier = Bean::getInstance; 
    Bean bean = supplier.get(); 
    // 이후에는 bean의 메서드 호출 
}

 

만일 위의 장점을 활용하지 않아도 된다면, 첫번째 방법(public 필드 방식)이 더 좋다.

 

 

3️⃣ 열거 타입(Enum)을 사용하는 방법

public enum Bean {
    INSTANCE;

    //밑에 메서드 추가 구현
}

1번 방식(public static final 필드)과 비슷하지만, 더 간결하고 추가적인 구현없이 직렬화(Serialize)도 할 수 있다.
심지어 아주 복잡한 직렬화 상황이나, Reflection 공격에도 제 2의 인스턴스가 생기는 일을 완벽하게 막아준다.

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

하지만 이 방법에도 한 가지 단점이 있다.
싱글턴이 Enum 외에 Concrete class를 상속(extends)을 할 수 없기 때문에, 만일 특정 클래스를 상속해야 한다면 이 방법은사용할 수 없다.

 

---

3. 싱글턴 클래스를 직렬화(Serialize)하는 방법

1번 방법(public static final 필드)나 2번 방법(정적 팩터리 적용)으로 만든 싱글턴 클래스를 직렬화하기 위해서는
Serialize interface를 구현한다고 선언하는 것만으로는 부족하다.

모든 인스턴스 필드를 일시적(transient)라고 선언하고, readResolve 메서드를 제공해야 한다.
만일 제공하지 않은 경우에는 직렬화한 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다.

public class Bean implements Serializable{
    private static final Bean INSTANCE = new Bean();

    private Bean() { }

    public static Bean getInstance() {
        return INSTANCE;
    }

    private Object readResolve() {
        return INSTANCE;
    }
}