Java

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

싱글턴의 단점

싱글턴은 인스턴스를 하나만 생성할 수 있는 클래스를 말한다.
그런데 이 싱글턴 클래스를 사용하는 클라이언트를 테스트하기 어렵다.
특히 인터페이스를 구현하는 방식으로 만들어진 싱글턴이 아니면 mock 객체로 테스트 하기 어렵다.

mock객체?

테스트하고 싶은 객체의 핵심 책임만 검증할 수 있도록 만들어진 객체이다.
원래 객체가 수많은 협력을 하고 있는데 반해, mock객체는 단순히 자신의 역할만 가지고 있을 뿐이다.
싱글톤은 자기 자신이 다른 수많은 객체와 협력해야 한다.(하나뿐이므로) 그래서 협력을 제외한 mock객체 테스트가 불가능하다는 의미다.

public static final 방식

1
2
3
4
5
6
public class Yang{
  public static final Yang INSTANCE = new YANG();
  private Yang(){...}
  
  ....
}

private 생성자는 맨 처음 public static final 인스턴스를 생성할 때 한번만 호출된다.

리플렉션 API의 AccessibleObject.setAccessible을 사용해서 private 생성자를 호출하는 경우가 있을 순 있는데,
그런 경우를 대비하면 생성자를 수정해서 예외처리를 하면된다.

  1. 간결하게 싱글턴임을 알 수 있다.(static final이면 절대 다른 객체를 참조할 수 없으니..!)

정적 팩터리 메서드

1
2
3
4
5
6
7
public class Yang{
  public static final Yang INSTANCE = new Yang();
  private Yang(){...}
  public static Yang getInstance(){return INSTANCE;}
  
  ....
}

위와 비슷하지만, 정적 팩터리 메서드를 추가했다.

이로 얻는 장점은

  1. 싱글턴이 아니게 바꿀 수 있다.
    • 정적 팩터리 메서드 내용을 바꾸면 언제든지 싱글턴이 아니게 만들 수 있다.
  2. 정적 팩터리 메서드를 제네릭 싱글턴 팩터리로 만들 수 있다!
  3. 정적 팩터리 메서드 참조를 공급자로 사용할 수 있다!
    • Yang::getInstance 를 Supplier<Yang>으로 사용할 수 있다!

다만 위의 장점이 필요한게 아니면 public field 방식을 써라!

싱글턴 클래스 직렬화의 문제

Public static final 필드나 정적 팩터리 메서드를 사용해서 싱글턴 클래스를 직렬화하려고 Serializable을 구현하면 문제가 생긴다.
직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 생긴다.

이걸 막기 위해서는 모든 인스턴스 필드를 일시적(transient)라고 선언하고 readResolve 메서드를 추가해야 한다.

1
2
3
private Object readResolve() {
    return INSTANCE; //진짜 객체를 반환하고 가짜 객체는 가비지 컬렉터에 맡긴다.
}

열거 타입 활용하기

직렬화 상황이나 리플렉션 공격에서 자유로운 방법은 열거 타입을 활용하는 거다.
그래서 대부분의 상황에서는 열겨 타입으로 싱글턴을 만드는게 가장 좋다.
다만, 상속을 활용해야 되는 경우 사용할 수 없다. (인터페이스 구현은 가능하다.)

1
2
3
4
public enum Yang {
    INSTANCE;
    //기타 메서드...
}
Share