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

문법식·2022년 2월 7일
0

Effective Java 3/E

목록 보기
3/52

싱글턴(singleton)이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다. 싱글턴을 만드는 방법 3가지를 설명하겠다.

public static final 필드인 방식

public static final Singleton1 instance=new Singleton1();

    private Singleton1(){
        // 리플렉션 공격 방어 코드
        if(instance!=null){
            throw new IllegalStateException("this object should be singleton");
        }
    }
}

private생성자는 public static final필드인 Singleton1.instance를 초기화할 때 한번만 호출한다. public이나 protected 생성자가 없으므로 Singleton1 클래스가 초기화될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임이 보장된다. 예외는 단 한 가지, 권한이 있는 클라이언트는 리플렉션 API인 AccessibleObject.setAccessible을 사용해서 private생성자를 호출할 수 있다. 위의 코드 중 리플렉션 공격 방어 코드 주석의 코드는 두 번째 객체를 생성하려 할 때 예외를 던져 리플렉션 공격을 방어하는 코드를 내가 짜본 것이다. 아래는 리플렉션 공격 코드이다.

public class Main {
    public static void main(String[] args){
        Singleton1 singleton11 = Singleton1.instance;
        Singleton1 singleton12 = Singleton1.instance;

        System.out.println(singleton11);
        System.out.println(singleton12);

        // 리플렉션 공격 코드
        try {
            Constructor<Singleton1> constructor = Singleton1.class.getDeclaredConstructor();
            constructor.setAccessible(true);
            Singleton1 singleton13 = constructor.newInstance();
            System.out.println(singleton13);
        }catch (Exception e){
            e.printStackTrace();
        }
}

리플렉션 API를 사용해서 싱글톤 객체가 아닌 새로운 객체를 생성하려는 코드이다.

이러한 방식으로 싱글톤을 만드는 것의 장점은 다음과 같다.

  • 해당 클래스가 싱글턴임이 API에서 명백히 드러난다는 것이다. public static 필드가 final이니 절대로 다른 객체를 참조할 수 없다.
  • 코드가 간결하다.

public factory 메소드를 public static 멤버로 제공

public class Singleton2 {
    private static final Singleton2 instance=new Singleton2();

    private Singleton2(){

    }

    public static Singleton2 getInstance() {
        return instance;
        // 정적 팩터리 방식의 첫 번째 장점: API(여기서는 getInstance라는 함수명)를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다는 점
//        return new Singleton2();
    }
}

Singleton2.getInstance는 항상 같은 객체의 참조를 반환하므로 제 2의 Singleton2의 인스턴스는 만들어지지 않는다.(리플렉션을 통한 예외는 똑같이 적용된다.) 이러한 방식으로 싱글톤을 만드는 것의 장점은 다음과 같다.

  • API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다는 점이다. 위 코드에서 return instance가 아니라 그 밑에 주석처리한 return new Singleton을 반환시키게 생성자 코드만 수정하면 함수를 호출하는 부분의 수정 없이 싱글톤이 아니게 변경할 수 있다는 것이다.
  • 정적 팩터리를 제너릭 싱글턴 팩터리로 만들 수 있다는 점이다.
  • 정적 팩터리의 메서드 참조를 아래의 코드와 같이 공급자(supplier)로 사용할 수 있다는 점이다.
//정적 팩터리의 메서드 참조(Singleton2.getInstance())를 공급자(supplier)로 사용할 수 있다.
        Supplier<Singleton2> s2supplier=Singleton2::getInstance;

위의 두 방식 중 하나로 만든 싱글턴 클래스를 직렬화하려면 단순히 Serializable을 구현한다고 선언하는 것만으로 부족하다. 모든 인스턴스 필드를 일시적(transient)이라 선언하고 readResolve메서드를 제공해야 한다. 이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다. 백기선님 강의에선 역직렬화 시 호출하는 숨겨진 기본 readResolve함수에서는 return new Object를 해서 새로운 인스턴스가 생성된다고 설명하셨다.


원소가 하나인 열거 타입을 선언

public enum Singleton3 {
    INSTANCE;

    public String getName(){
        return "BeobSik";
    }
}

public필드 방식과 비슷하지만, 더 간결하고, 추가 노력 없이 직렬화할 수 있고, 심지어 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 것을 막아준다. 조금 부자연스러워 보일 수 있으나 대부분 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다. 단, 만들려는 싱글턴이 Enum외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다.(열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다.)

profile
백엔드

0개의 댓글