private 생성자나 열거 타입으로 싱글턴임을 보증하라 - Effective Java[3]
싱글톤(Singleton) 이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다.
무상태 객체나 설계상 유일해야 하는 시스템 컴포턴트가 싱글턴의 전형적인 예다.
하지만 싱글톤클래스는 이를 사용하는 클라이언트를 테스트하기 어렵다는 단점이 있다.
싱글톤을 만드는 세세한 방법들은 아래의 블로깅에 아주 정리가 잘 되어있다.
https://yjkim2015.github.io/designpattern/Singleton/
이번 블로깅에서는 큰 틀에서의 싱글톤을 만드는 방식에 대해 살펴볼 것이다.
Step 1 : public static 멤버가 final 필드인 방식
이 방식의 장점은 해당 클래스가 싱글턴임이 API에 명백히 드러난다는 것
[public static 필드가 final이니 절대로 다른 객체를 참조 할 수 없음]과 간결함이다.
1 2 3 4 5 6 7 8 | public class Car { public static final Car INSTANCE = new Car(); private Car() { ... } } | cs |
위 코드에서 private 생성자는 public static final 필드인 CAR.INSTANCE를 초기화 할 때 딱 한번만 호출된다.
public이나 protected 생성자가 없으므로 Car 클래스가 초기화 될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임이 보장된다.
예외는 단 한가지, 권한이 있는 클라이언트는 리플렉션 API인 AcccesibleObject.setAccessible을 사용해 private 생성자를 호출 할 수 있다. 아래의 코드가 그 예시이다.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | public class Reflection { public static void main(String[] args) { try { Constructor<Singleton> declaredConstructor = null; declaredConstructor = Singleton.class.getDeclaredConstructor(); declaredConstructor.setAccessible(true); Singleton singleton = declaredConstructor.newInstance(); System.out.println(singleton==Singleton.INSTANCE); //fasle 같은 객체가아님 싱글톤이 깨진다. } catch (NoSuchMethodException e) { e.printStackTrace(); } catch (IllegalAccessException e) { e.printStackTrace(); } catch (InstantiationException e) { e.printStackTrace(); } catch (InvocationTargetException e) { e.printStackTrace(); } } } | cs |
Step 2 : 정적 팩토리 메서드를 public static 멤버로 제공
이 방식의 장점은 아래와 같다. 이러한 장점들이 굳이 필요하지 않다면 위의 public 필드 방식이 좋다.
-
API를 바꾸지 않고도 싱글톤이 아니게 변경 할 수 있다는 점이다. 유일한 인스턴스를 반환하던 정적 팩토리 메소드가 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수 있다.
- 정적 팩토리 메소드를 제네릭 싱글톤 팩토리로 만들수 있다
- 정적 팩토리 메소드 참조를 공급자(Supplier)로 사용할 수 있다
1 2 3 4 5 6 7 8 9 | public class Car { private static final Car INSTANCE = new Car(); private Car() {} public static Car getInstance() { return INSTANCE; } } | cs |
Car.getInstance는 항상 같은 객체의 참조를 반환하므로 제2의 Car 인스턴스란 결코 만들어지지 않는다.(하지만 위의 코드에서 봤듯이 리플렉션을 통한 예외는 똑같이 적용된다.)
또한 위 두가지 방법 중 하나의 방식으로 만든 싱글톤 클래스를 직렬화할 때 또 다시 싱글톤이 깨질 수 있는 위기에 당면하게 된다.
예시를 보자.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | package Item03; import java.io.Serializable; public class Singleton implements Serializable { private static final Singleton INSTANCE = new Singleton(); private Singleton() {}; public static Singleton getInstance() { return INSTANCE; } } | cs |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | package Item03; import java.io.*; public class SerializedSingleton { public static void main(String[] args) { try { Singleton serializedInstance = Singleton.getInstance(); ObjectOutput out = null; out = new ObjectOutputStream(new FileOutputStream("output.txt")); out.writeObject(serializedInstance); out.close(); // 역직렬화 ObjectInput in = new ObjectInputStream(new FileInputStream("output.txt")); Singleton deSerializedInstance = (Singleton) in.readObject(); in.close(); System.out.println(serializedInstance.hashCode()); System.out.println(deSerializedInstance.hashCode()); } catch (IOException e) { e.printStackTrace(); } catch (ClassNotFoundException e) { e.printStackTrace(); } } } | cs |
단순하게 Singleton 클래스에 Serializable을 구현 하고, 직/역 직렬화 한 결과값의 해쉬코드는 다르게 나온다. 이게 무슨말이냐함은 싱글톤이 깨지고 인스턴스가 추가 생성 된 것이다.
이에 대한 해결책은 모든 인스턴스 필드에 transient를 선언하거나 아래처럼 readResolve 메소드를 제공해야한다.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | package Item03; import java.io.Serializable; public class Singleton implements Serializable { private static final Singleton INSTANCE = new Singleton(); private Singleton() {}; public static Singleton getInstance() { return INSTANCE; } // 추가 private Object readResolve() { return getInstance(); } } | cs |
transient는 Serialize하는 과정에 제외하고 싶은 경우 선언하는 키워드입니다
Step 3 : 열거 타입 방식의 싱글턴 - 바람직한 방법
1 2 3 4 5 | public enum Car { INSTANCE; } | cs |
이 방식은 public 필드 방식과 비슷하지만, 더 간결하고 추가 노력 없이 직렬화가 가능하다.
또한, 리플렉션 공격이나 복잡한 직렬화 상황에도 제2의 인스턴스가 생기는 일을 완벽히 막아준다.
대부분 상황에서는 원소가 하나뿐인 열거타입이 싱글톤을 만드는 가장 좋은 방법이다.
하지만, 만들려는 싱글톤이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다.
참조 - 이펙티브 자바 3/E - 조슈아 블로크
Comments