[이펙티브자바] 아이템3. private생성자나 열거타입으로 싱글턴 보증

싱글턴

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

클라이언트를 테스트 하기 어려워질 수 있다. 

싱글턴을 만드는 방법은 두 가지가 있는데 두 가지 모두 생성자는 private으로 감춰두고 static멤버를 이용해서 인스턴스에 접근할 수 있다.

 

첫 번째 싱글턴 생성방법

---

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

    public void leaTheBuild() {}
}

private 생성자는 Elvis.INSTANCE를 초기화할 때 한 번만 호출된다. 

그런데 리플렉션 API AccessibleOjbect.setAccessible을 사용해 생성자를 호출 할 수 있다.

// 기존에 static 필드를 가져올때
Elvis singleton = Elvis.INSTANCE;
System.out.println("singleton1 : " + singleton);
Elvis singleton2 = Elvis.INSTANCE;
System.out.println("singleton2 : " + singleton2);

// 리플렉션으로 생성자를 호출할 때 
Constructor<Elvis> constructor = Elvis.class.getDeclaredConstructor();

constructor.setAccessible(true);
Elvis elvis = constructor.newInstance();
System.out.println("newInstance1 :" + elvis);
elvis = constructor.newInstance();
System.out.println("newInstance2: " + elvis);

singleton1 : com.heypli.test.effective2강.Elvis@7a5d012c
singleton2 : com.heypli.test.effective2강.Elvis@7a5d012c
newInstance1 :com.heypli.test.effective2강.Elvis@3fb6a447
newInstance2: com.heypli.test.effective2강.Elvis@79b4d0f

singleton은 계속 생성해도 같은 주소값을 가져오지만 리플렉션으로 생성자를 호출하면 새로운 인스턴스가 리턴된다. 

이런 공격을 방어하기 위해 생성자를 수정해서 두 번째 객체가 생성되기 전에 예외를 던지게 할 수 있다. 

 

두 번째 싱글턴 생성방법 (정적 팩터리 메서드)

---

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

    public static Elvis getInstance() {
        return INSTANCE;
    }

    public void leaTheBuild() {}
}

getInstance() 정적메서드만 public으로 하고 나머지는 private으로 만든다.

public static field가 final이니 다른 객체를 참조할 수 없다.

(리플렉션 예와는 똑같이 적용된다.)

 

두 번째 방법의 장점은 API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다는 점이다.

정적 팩터리 메서드를 new Elvise();를 리턴하게 수정하면 호출하는 스레드별로 다른 인스턴스를 리턴하게 된다.

클라이언트는 코드를 수정할 필요가 없다. 

또다른 장점은 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다는 점이다.(아이템30)

Supplier<Elvis> elvisSupplier = Elvis::getInstance;
elvisSupplier.get();

세 번째 장점은 정적 팩터리의 메서드 참조를 공급자로 사용할 수 있다는 점이다.

(위와 같은 형태)

 

이런 장점이 필요하지 않다면 public필드 방식이 좋다. 

 

Serializable

---

위 둘 중 하나의 방식으로 만든 싱글턴 클래스를 직렬화할 때 Serializable을 구현하면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다. 

새로운 인스턴스가 생성되는 것을 막으려면 transient선언하고, readResolve메서드를 추가 해야 한다. 

public class Elvis  implements Serializable {

    private static final transient Elvis INSTANCE = new Elvis();
    private Elvis(){ }

    public static Elvis getInstance() {
        return INSTANCE;
    }

    public void leaTheBuild() {}

    private Object readResolve() {
        return INSTANCE;
    }
}

 

세 번째 원소가 하나인 열거 타입을 선언하는 것

---

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

public필드와 비슷하지만 간결하고 추가 노력없이 직렬화가 가능하다.

리플렉션공격이나 복잡한 직렬화 상황도 막을 수 있다.

 

대부분 상황에서는 원소가 하나뿐인 열거타입이 싱글턴을 만드는 가장 좋은 방법이다.

단, 싱글턴이 Enum외의 클래스를 상속해야한다면 쓸 수 없다. (인터페이스 구현은 가능)