[이펙티브 자바] Item3. private 생성자나 열거 타입으로 싱글톤임을 보증하라. (private 생성자 + public static final 필드 )

 

아이템3. private 생성자나 열거 타입으로 싱글톤임을 보증하라. 

 

 

싱글톤 singleton 이란? 

: 인스턴스를 오직 하나만 생성할 수 있는 클래스를 의미한다. 

싱글톤의 예로는 설계상 유일해야 하는 시스템 컴포넌트를 들 수 있다.

게임에서 언어팩 같은 것이 있다. (보통 언어를 '영어'로 했다 하면 어떤 설정에서는 한국어이고, 어떤 설정에서는 일본어이고 하면 안되니까 하나의 언어로 유지한다.) 

 

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

싱글톤 클래스 중에서도 인터페이스를 정의한 다음 이 인터페이스를 구현해서 만든 클래스가 아니라면 싱글톤 인스턴스를 가짜 mock 구현으로 대체할 수 없기 때문이다... 

 

 

싱글톤 singleton 만드는 방법 1 

: private 생성자 + public static final 필드 

먼저 생성자는 private로 숨기고, 유일한 인스턴스에 접근할 수 있는 수단을 public static final 방식으로 제공하는 것이다. 

 

public class Elvis 
{
	// 싱글톤 오브젝트
	public static final Elvis INSTANCE = new Elvis();
    
    private Elvis(){}
    
    public void leaveTheBuilding()
	{
		System.out.println("Whoa baby, I'm outta here!");
	}
	
	public void sing()
	{
		System.out.println("I'll have a blue ~ Christmas without you~");
	}
	
}

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

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

 

 

근데  다른 인스턴스가 만들어질 수 있는  두가지의 예외가 존재한다. 

권한이 있는 클라이언트는 리플렉션 API인 AccessibleObject.setAccessible 을 사용해 private 생성자를 호출할 수 있다.

public static void main(String[] args)
{
   Elvis elvis = Elvis.INSTANCE;
   elvis.leaveTheBuilding();
   
   // 생성자로 여러 인스턴스 만들기
   // 리플렉션을 사용하면 다른 인스턴스를 만들 수 있게 된다..!!!
   try
   {
      Constructor<Elvis> defaultConstructor = Elvis.class.getDeclaredConstructor();
      defaultConstructor.setAccessible(true); // true 로 안하면 Elvis는 생성자가 private여서 호출할 수 없게됨
      Elvis elvis1 = defaultConstructor.newInstance();
      Elvis elvis2 = defaultConstructor.newInstance();
      System.out.println("(elvis1 == elvis2) = " + (elvis1 == elvis2));
   }
   catch (NoSuchMethodException | InvocationTargetException | InstantiationException | IllegalAccessException e)
   {
      throw new RuntimeException(e);
   }
   
   
}

이렇게 리플렉션에서 setAccessible을 true로 설정하면 privae 생성자를 호출할 수 있다. 

이런 공격을 막기 위해서는 생성자를 수정해서 두번째 객체가 생성되려 할 때 예외를 던지게 하면 된다. 

 

 

public class Elvis implements Serializable
{
   // 싱글톤 오브젝트
   public static final Elvis INSTANCE = new Elvis();
   private static boolean created;
   
   private Elvis()
   {
      if (created) {
         // 리플렉션 공격을 방어하려면 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던지게 하면 된다.
         throw new UnsupportedOperationException("can't be created by constructor");
      }
      created = true;
   }
   
   public void leaveTheBuilding()
   {
      System.out.println("Whoa baby, I'm outta here!");
   }
   
   public void sing()
   {
      System.out.println("I'll have a blue ~ Christmas without you~");
   }
   
   // 싱글톤임을 보장해주는 readResolve 메서드
   // 역직렬화를 할 때 readResolve라는 메서드를 사용하는데 여기를 싱글톤으로 생성한 INSTANCE를 반환해주면
   // 역직렬화 할 때 새로운 인스턴스를 생성하지 않는다.
   private Object readResolve()
   {
      return INSTANCE;
   }
   

   
}

created flag를 두어서 이미 생성되었다면 true를 반환해서 true이면 UnsupportedOperationException을 발생시키도록 했다. 

 

그리고 싱글턴 클래스를 직렬화하려면 Serializable만 구현하는게 끝이 아니라 readResolve 메서드를 제공해야 한다. 

왜냐하면 역직렬화할 때 readResolve라는 메서드를 참조해서 새로운 인스턴스가 생성되기 때문에 이를 방지하기 위해서 위에 코드처럼 readResolve반환 값을 해당 인스턴스로 반환해줬다. 

 

public static void main(String[] args)
{
   // 역직렬화로 여러 인스턴스 만들기
   // 저장하는 코드
   try (ObjectOutput output = new ObjectOutputStream(new FileOutputStream("elvis.obj")))
   {
      output.writeObject(Elvis.INSTANCE);
   }
   catch (IOException e)
   {
      e.printStackTrace();
   }
   
   // 읽어오는 코드 (저장을 했다가 읽어올 때 새로운 인스턴스가 생성된다.)
   try (ObjectInput in = new ObjectInputStream(new FileInputStream("elvis.obj")))
   {
      Object elvis3 = in.readObject();
      System.out.println("(elvis3 == Elvis.INSTANCE) = " + (elvis3 == Elvis.INSTANCE)); // false
   }
   catch (IOException | ClassNotFoundException e) {
      e.printStackTrace();
   }
}

readResolve() 메서드를 구현해주고 나면 (elvis3 == Elvis.INSTANCE) = true가 나온다. 

 

 

 

📢 private 생성자 + public static final 필드 방법 장단점 

 

장점

: 간결하고 싱글톤임을 API에 들어낼 수있다. 

 

단점

: 싱글톤을 사용하는 클라이언트 테스트하기 어려워진다. 

  리플렉션으로 private 생성자를 호출할 수 있다. 

  역직렬화 할 때 새로운 인스턴스가 생길 수 있다.