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

1. 싱글턴 패턴이란

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

 

무상태(stateless) 객체

설계상 유일해야 하는 시스템 컴포넌트

Database Connection Pool

...

 

위에서 든 예시 외에도 다양한 곳에서 활용된다.

1) 싱글턴 패턴을 사용하는 이유

- 고정된 메모리 영역을 얻으면서, 한번의 new로 인스턴스를 사용하기 때문에 메모리 낭비를 방지할 수 있다.

- 싱글턴 클래스의 인스턴스는 전역 객체이기 때문에, 다른 클래스들이 데이터를 공유하기 쉽다.

- 인스턴스가 절대적으로 1개만 존재하는 걸 보장하고 싶을 때 사용한다.

2) 싱글턴 패턴의 단점

클래스를 싱글턴으로 만들면, 이를 사용하는 클라이언트를 테스트하기가 어려워질 수 있다. 왜냐하면! 타입을 인터페이스로 만든 다음, 해당 인터페이스를 구현해서 만든 싱글턴 클래스가 아니라면, 싱글턴 인스턴스를 가짜(mock) 구현으로 대체할 수 없기 때문이다.

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

    public static final Validator getInstance() {
        return INSTANCE;
    }

    private int bound;

    private Validator() {
        this.bound = 10;
    }

    public void validate(int target) {
        if (target > bound) {
            throw new IllegalArgumentException();
        }
    }
}

class Service {

    private final Validator validator = Validator.getInstance();

    public void validate(int target) {
        validator.validate(target); // validator 가 제대로 작동하는지 테스트를 하려는데 bound 값을 바꿔서 테스트하고 싶다면?
    }
}

만약 내부 필드값을 바꿔가며 싱글턴 클래스를 테스트하고 싶어도, 적절한 메서드가 없기 때문에 할 수 없다.

public interface Validator {
    void validate(int target);
}

class RealValidator implements Validator {
    private static final Validator INSTANCE = new RealValidator();

    private int bound = 10;

    private RealValidator() {
    }

    @Override
    public void validate(int target) {
        if (target > bound) {
            throw new IllegalArgumentException();
        }
    }

}

class MockValidator implements Validator {
    private static final Validator INSTANCE = new MockValidator();

    private int bound;

    private MockValidator() {
    }

    // 테스트를 위한 코드, 이러한 코드는 production 코드에 노출되어선 안되기 때문에 mock 클래스에만 존재한다.
    public void changeMockBound(int mockBound) {
        this.bound = mockBound;
    }

    @Override
    public void validate(int target) {
        if (target > bound) {
            throw new IllegalArgumentException();
        }
    }
}

따라서 타입을 인터페이스로 먼저 정의한 뒤, 해당 인터페이스를 구현하는 방식으로 싱글턴 패턴을 적용할 수 있다.

이때는 별도의 가짜(mock) 클래스를 만들어서, 해당 클래스를 통해 싱글턴 클래스에 대한 테스트를 해볼 수 있다. 물론 가짜(mock) 클래스이기 때문에 내부 필드를 변경하는 메서드를 생성하여 적절히 사용할 수 있다.

2. 싱글턴을 만드는 방식  1

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

    public void leaveTheBuilding() {...}
}

생성자를 private으로 감추고, public static final 필드가 초기화될 때만 딱 한번만 호출한다.

이때 public이나 protected 생성자가 없기 때문에 해당 필드가 참조하는 인스턴스가 전체 시스템에서 오직 하나뿐임이 보장된다.

1) 예외

다만 예외가 있다! 권한이 있는 클라이언트가 리플레션 API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출하면 싱글턴이 깨지게 된다. 따라서 이러한 공격을 방어하기 위해서는, 생성자를 수정하여 두 번째 객체가 생성될 때 예외를 던지게 만들면 된다.

2) 장점

- 간결하다.

- 해당 클래스가 싱글턴임이 API에 명백하게 드러난다.

3. 싱글턴을 만드는 방식 2

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

    public void leaveTheBuilding() {...}
}

정적 팩터리 메서드를 public static 멤버로 제공한다. Elvis.getInstance()는 항상 같은 객체를 참조함이 보장된다.

(방식 1과 마찬가지로 리플렉션을 통한 예외는 똑같이 적용된다)

1) 장점

- API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다.

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

필요하다면 코드를 수정해서 스레드 당 새 인스턴스를 만들게 할 수도 있다.

---

- 원한다면 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다.

public class GenericSingletonFactory {
    private static final UnaryOperator<Object> IDENTITY_FN = (t) -> t;

    @SuppressWarnings("unchecked")
    public static <T> UnaryOperator<T> identityFunction() {
        return (UnaryOperator<T>) IDENTITY_FN;
    }

    public static void main(String[] args) {

        UnaryOperator<String> sameString = identityFunction();
        UnaryOperator<Number> sameNumer = identityFunction();

        System.out.println("sameString = " + sameString);
        System.out.println("sameNumer = " + sameNumer);

        String[] strings = {"삼베", "대마", "나일론"};
        Number[] numbers = {1, 2.0, 3L};
        for (String string : strings) {
            System.out.println(sameString.apply(string));
        }
        for (Number number : numbers) {
            System.out.println(sameNumer.apply(number));
        }
    }
}

제네릭 싱글턴 팩터리: 제네릭은 런타임에 타입 정보가 소거되므로 하나의 객체를 어떤 타입으로든 매개변수화할 수 있다. 하지만 이렇게 하려면 요청한 타입 매개변수에 맞게 매번 그 객체의 타입을 바꿔주는 정적 팩터리를 만들어야 한다. 이 패턴이 제네릭 싱글턴 패턴이다.

---

- 정적 팩터리의 메서드 참조를 공급자(supplier)로 사용할 수 있다.

 

참조 링크: https://m.blog.naver.com/zzang9ha/222087025042

4. 싱글턴을 만드는 방식 3

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

 

원소가 하나인 Enum 타입을 선언하여 싱글턴 클래스를 만들 수 있다.

1) 장점

- 간결하다.

- 추가 노력 없이 직렬화할 수 있다.

- 복잡한 직렬화 상황이나, 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 완벽히 막아준다.

 

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

단, 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법을 사용할 수 없다.

5. 싱글턴 클래스의 직렬화

위에서 설명한 방식을 통해 만든 싱글턴 클래스를 직렬화하려면, 단순히 Serializable을 구현하다고 선언하는 것만으로는 부족하다.

모든 인스턴스 필드를 transient라고 선언하고, readResolve 메서드를 제공해야 한다. 그렇지 않으면 해당 인스턴스가 역직렬화할 때마다 새로운 인스턴스가 만들어진다.

private Object readResolve() {
	return INSTANCE;
}

참조 링크 1: https://www.oracle.com/technical-resources/articles/java/serializationapi.html

참조 링크 2: https://devlog-wjdrbs96.tistory.com/268