[Effective Java] Item 3. private 생성자나 enum 타입으로 싱글톤임을 보장하자.

싱글톤이란?

싱글톤이란 인스턴스를 단 1개만 생성할 수 있는 클래스를 말합니다. 

ex) 무상태 객체, 설계 상 유일해야 하는 시스템 컴포넌트 (service, repository)

 

---

싱글톤 장점

• 한 번의 객체 생성으로 재사용이 가능하기 때문에, 메모리 낭비를 줄일 수 있습니다.
• 싱글톤으로 생성된 객체는 전역성을 띄기 때문에 다른 객체와 공유가 용이합니다.

---

싱글톤 단점

• 클라이언트를 테스트하기 어렵습니다.
• private 생성자를 가지고 있기 때문에 상속이 불가능합니다.
• 서버에서 클래스 로더를 어떻게 구성하고 있는지에 따라 또는 여러 개의 JVM에 분산되어 있는 경우 싱글톤 클래스여도 하나 이상의 인스턴스가 만들어질 수 있습니다.
• 전역 상태로 사용할 수 있기 때문에 바람직하지 못합니다.
  • 사실 아무 객체나 자유롭게 접근하고 수정하고 공유할 수 있는 전역 상태를 갖는 것은 객체 지향 프로그램이에서는 권장되지 않습니다.

---

싱글톤 만드는 방식 1 - public static final

public class Elvis {

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

class ElvisTest {

    @Test
    void singleToneTest() {
        Elvis elvis = Elvis.INSTANCE;
        Elvis elvis2 = Elvis.INSTANCE;

        assertEquals(elvis, elvis2);
    }
}

• 첫 번째 방법은, 클래스 내부에 public static 멤버를 하나 작성해 두고 final로 설정하여 싱글톤으로 관리하는 방법입니다.
  • 여기서 private 생성자는 public static final 필드인 Elvis.INSTANCE를 초기화 할 때 딱 한 번 호출됩니다.
  • public이나 protected 생성자가 없으므로 다른 패키지에서 생성할 수 없음을 보장해주며, 초기화 할 때 딱 한 번 호출함으로써 인스턴스가 전체 시스템에서 하나 뿐임이 보장됩니다.

• 이 방식은 해당 클래스가 싱글톤임을 확실히 드러내고, 간결하다는 것이 장점

 

예외 케이스 : 아래 코드와 같이 리플렉션 API ( AccessibleObject.setAccessible)을 사용해 private 생성자를 호출하는 방법

@Test
void reflectionBreakSingleton()
        throws NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException {
    Elvis elvis = Elvis.INSTANCE;
    Constructor<Elvis> constructor = (Constructor<Elvis>) elvis.getClass().getDeclaredConstructor();
    constructor.setAccessible(true);

    Elvis elvis2 = constructor.newInstance();
    assertNotSame(elvis, elvis2);
}

• 이런 공격을 막기 위해, 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던짐으로써 막을 수 있겠습니다.

public class Presley {

    public static final Presley INSTANCE = new Presley();

    private Presley() {
        if (INSTANCE != null) {
            throw new RuntimeException("생성자를 호출할 수 없습니다.");
        }
    }
}

 

---

싱글톤 만드는 방식 2 - 정적 팩토리 메소드를 public static 멤버로 제공하기

public class Greenday {

    private static final Greenday INSTANCE = new Greenday();

    private Greenday() {}

    public static Greenday getInstance() {
        return INSTANCE;
    }
}

class GreendayTest {

    @Test
    void singletonTest() {
        Greenday greenday1 = Greenday.getInstance();
        Greenday greenday2 = Greenday.getInstance();

        assertEquals(greenday1, greenday2);
    }
}

• 두 번째 방법은 첫 번째 방식의 싱글톤 객체를 가져오는 방식을 정적 팩토리 메소드 방식으로 정의한 방식입니다.
• 이 방식의 장점은 싱글톤 방식을 풀고 싶을 때 API를 바꾸지 않고도 변경할 수 있다는 점입니다.
  
  • 아래 코드처럼 내부에서 INSTANCE가 아닌 새 인스턴스를 생성해주면 되겠습니다.

public class Greenday {

    private static final Greenday INSTANCE = new Greenday();

    private Greenday() {}

    public static Greenday getInstance() {
        return new Greenday();
    }
}

class GreendayTest {

    @Test
    void singletonTest() {
        Greenday greenday1 = Greenday.getInstance();
        Greenday greenday2 = Greenday.getInstance();

        assertNotEquals(greenday1, greenday2);
    }
}

 

• 두 번째 장점은 원한다면 정적 팩토리를 싱글톤 팩토리로 만들 수 있다는 점입니다. (Item 30 참고)
• 정적 팩토리의 메소드 참조를 공급자로 사용할 수 있습니다. (Item 43, Itme 44 참고)
  • Greenday::getInstance를 Supplier<Greenday>로 사용해서 아래처럼 사용할 수 있음

Supplier<Greenday> greendaySupplier = Greenday::getInstance;
Greenday greenday = greendaySupplier.get();

 

---

위 두가지 방식의 문제점 

https://data-flair.training/blogs/serialization-and-deserialization-in-java/

 

위 두 가지 방식의 문제점은 각 클래스를 직렬화(객체를 저장, 전송할 수 있는 특정 포맷으로 변환하는 과정)한 후 역직렬화(특정 포맷 상태의 데이터를 다시 객체로 변환)할 때 새로운 인스턴스를 반환한다는 점입니다.

• 역직렬화는 기본 생성자를 호출하지 않고 인스턴스의 값을 복사해서 새로운 인스턴스를 반환합니다.

이를 방지하기 위해 readResolve 메소드를 하나 만들어 싱글톤 인스턴스를 반환하고, 모든 필드에 transient 키워드를 넣어주는 방식이 있습니다.

 

transient 키워드 : 필드의 상태값을 전송하지 않는다는 키워드

public class Greenday {

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

    public static Greenday getInstance() {
        return INSTANCE;
    }
   
    private Greenday readResolve() {
        // '진짜' Greenday를 리턴하고, 가짜 Greenday는 가비지 컬렉터에 맡긴다.
        return INSTANCE;
    }
}

• readResolve 메소드는 역직렬화 과정에서 반드시 호출됩니다.
• 이렇게 설정하면 역직렬화 과정에서 싱글톤으로 만들어둔 진짜 인스턴스를 반환하도록 설정되어, 값을 복사한 새로운 인스턴스는 가비지 컬렉터로 넘어가게 됩니다. 
• 방어적으로 transient 키워드를 넣어 직렬화 과정에서 필드의 상태값 전송을 막아 역직렬화 과정에서 복사할 값 자체를 아예 보내지 않도록 설정할 수도 있겠습니다.

---

싱글톤 만드는 방식 3 - enum 타입 

public enum ColdBrew {
    
    INSTANCE;
}

• 세 번째 방법은 enum타입으로 싱글톤을 적용하는 방법으로 ,public 필드 방식과 비슷하지만, 훨씬 간결하게 사용할 수 있는 방식으로, 복잡한 직렬화 상황이나 리플렉션 공격에서도 제 2의 인스턴스가 생기는 일을 완벽히 막아줍니다.
  • 열거형 타입으로 싱글톤을 적용하는 것이 조금 어색할 순 있지만, 대부분 상황에서는 원소가 하나뿐인 열거 탕비이 싱글톤을 만드는 가장 좋은 방법입니다.
• 만드려는 싱글톤이 enum외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없습니다. (인터페이스는 구현하도록 선언할 수는 있음)
  • public enum ColdBrew extends ~ (X), public enum ColdBrew implements ~ (O)

---

<참고자료>

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

 

[Java] 직렬화(Serialization)와 역직렬화(Deserialization)란? transient 변수란?

 

 

[아이템 3] transient가 역직렬화시 새로운 인스턴스 생성을 방지하는 이유 · Issue #4 · Java-Bom/ReadingR