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

교재 : Effective java, 강의 : inflearn 백기선

---

싱글턴 (singleton)

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

 

싱글턴을 만드는 방식 1. 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!");
    }
}

Elvis elvis = Elvis.INSTANCE;
elvis.leaveTheBuilding();

private 생성자는 public statid final 필드인 Elvis.INSTANCE를 초기화할 때 딱 한번만 호출된다. public이나 protected 생성자가 없으므로 Elvis 클래스가 초기화될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임이 보장된다.

 

방식 1의 장점

1. 해당 클래스가 싱글턴임이 API에 명백히 드러난다. (javadoc)

2. 간결하다.

 

싱글턴을 만드는 방식 2. private 생성자 + 정적 팩터리 메서드

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

    private Elvis() {
    }

    public static Elvis getInstance() {
        return INSTANCE;
    }

    public void leaveTheBuilding() {
        System.out.println("Whoa baby, I'm outta here!");
    }
}

Elvis.getInstance는 항상 같은 객체의 참조를 반환하므로 제 2의 Elvis 인스턴스란 결코 만들어지지 않는다.

 

(+) Lazy initialization

1. synchronized 사용

public class Elvis {
    private static Elvis instance;

    private Elvis() {
    }

    public static synchronized Elvis getInstance() { // thread safe
        if (instance == null) {
            instance = new Elvis();
        }
        return instance;
    }

    public void leaveTheBuilding() {
        System.out.println("Whoa baby, I'm outta here!");
    }
}

...

 

방식 2의 장점

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

2. 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다.

public class MetaElvis<T> {
    private static final MetaElvis<Object> INSTANCE = new MetaElvis<>();

    private MetaElvis() { }

    @SuppressWarnings("unchecked")
    public static <E> MetaElvis<E> getInstance() {
        // 제네릭 싱글턴 팩터리가 해주는 일은 단순히 우리가 갖고있는 싱글턴 인스턴스를 원하는 타입으로 변환하는 것.
        return (MetaElvis<E>) INSTANCE;
    }

    public void say(T t) {
        System.out.println(t);
    }

    public void leaveTheBuilding() {
        System.out.println("Whoa baby, I'm outta here!");
    }

    public static void main(String[] args) {
        MetaElvis<String> elvis1 = MetaElvis.getInstance();
        MetaElvis<Integer> elvis2 = MetaElvis.getInstance();
        System.out.println(elvis1);
        System.out.println(elvis2);
//        System.out.println(elvis1 == elvis2); // hashCode가 같지만 type이 달라서 == 비교는 안됨.
        elvis1.say("hello");
        elvis2.say(100);
    }
}

 

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

public interface Singer {
    void sing();
}

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

    private Elvis() { }

    public static Elvis getInstance() {
        return INSTANCE;
    }

    @Override
    public void sing() {
        System.out.println("my way~~~");
    }
}

public class Concert {
    public void start(Supplier<Singer> singerSupplier) {
        Singer singer = singerSupplier.get();
        singer.sing();
    }

    public static void main(String[] args) {
        Concert concert = new Concert();
        concert.start(Elvis::getInstance); // method reference
    }
}

 

싱글턴을 만드는 방식 3. Enum. 원소가 하나인 열거 타입을 선언

public enum Elvis {
    INSTANCE;

    public void leaveTheBuilding() {
        System.out.println("기다려 자기야, 지금 나갈께!");
    }
}

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

조금 부자연스러워 보일 수 있으나 대부분 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다.

단, 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다. (다른 인터페이스를 구현하도록 선언할 수는 있다.)

 

 

싱글턴의 단점

1. 싱글턴을 사용하는 클라이언트 코드를 테스트 하기가 어렵다.

특히 인터페이스 없이 정의한 경우에는 싱글턴 인스턴스를 mock 구현으로 대체할 수 없다.

 

인터페이스 정의 후 Mock 구현으로 대체한 예제 코드

public interface IElvis {
    void leaveTheBuilding();
}

public class Elvis implements IElvis {
    public static final Elvis INSTANCE = new Elvis();

    private Elvis() {
    }
    
    @Override
    public void leaveTheBuilding() {
        System.out.println("Whoa baby, I'm outta here!");
    }
}

public class MockElvis implements IElvis {
    @Override
    public void leaveTheBuilding() {
        System.out.println("It's Mock!");
    }
}

public class Concert {
    private boolean lightsOn;
    private boolean mainStateOpen;
    private IElvis elvis;

    public Concert(IElvis elvis) {
        this.elvis = elvis;
    }

    public void perform() {
        mainStateOpen = true;
        lightsOn = true;
        elvis.sing();
    }

    public boolean isLightsOn() {
        return lightsOn;
    }

    public boolean isMainStateOpen() {
        return mainStateOpen;
    }
}

class ConcertTest {
    @Test
    void perform() {
        // Concert concert = new Concert(Elvis.INSTANCE);
        Concert concert = new Concert(new MockElvis());
        // 우리는 Elvis가 아닌, Concert에 대한 테스트를 하고 싶으므로
        concert.perform();

        assertTrue(concert.isLightsOn());
        assertTrue(concert.isMainStateOpen());
    }
}

 

2. 리플렉션을 통한 예외

리플렉션 API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있다.

public static void main(String[] args) {
    try {
        Constructor<Elvis> defaultConstructor = Elvis.class.getDeclaredConstructor();
        // getConstructor() : public한 Constructor에만 접근
        // getDeclaredConstructor : 선언된 기본 생성자에 접근 (접근제한자에 상관X)

        defaultConstructor.setAccessible(true);
        // 이 메서드가 없으면 다음과 같은 에러 발생
        // cannot access a member of class Elvis with modifiers "private"

        Elvis elvis1 = defaultConstructor.newInstance();
        Elvis elvis2 = defaultConstructor.newInstance();
        System.out.println(elvis1);
        System.out.println(elvis2);
        System.out.println(Elvis.INSTANCE);

    } catch (InvocationTargetException | NoSuchMethodException | InstantiationException | IllegalAccessException e) {
        e.printStackTrace();
    }
}

이러한 공격을 방어하려면 생성자를 수정하여 두번 째 객체가 생성되려 할 때 예외를 던지게 하면 된다.

 

public class Elvis {
    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!");
    }
}

 

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

싱글턴 클래스를 직렬화하려면 단순히 Serializable을 구현한다고 선언하는 것만으로는 부족하다.

// 코드 3-1.
public class ElvisSerialization {
    public static void main(String[] args) {
        // 저장하는 코드
        try (ObjectOutput out = new ObjectOutputStream(new FileOutputStream("elvis.obj"))) {
            out.writeObject(Elvis.INSTANCE);
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 읽어오는 코드
        try (ObjectInput in = new ObjectInputStream(new FileInputStream("elvis.obj"))) {
            Elvis elvis3 = (Elvis) in.readObject();
            System.out.println(elvis3 == Elvis.INSTANCE);
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

 

역직렬화는 기본 생성자를 호출하지 않고 값을 복사해서 새로운 인스턴스를 반환하기 때문에 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다.

그래서, 모든 인스턴스 필드를 일시적(transient)이라고 선언하고 readResolve 메서드를 제공하지 않으면 코드 3-1 에서 false가 출력된다.

public class Elvis implements IElvis, 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!");
    }

    private Object readResolve() { // 역직렬화를 할 때 사용되는 메서드
        return INSTANCE;
    }
}

역직렬화에 간섭하는 메서드인 readResolve 메서드를 직접 정의하여, 기존 생성된 싱글톤 인스턴스를 반환하도록 제어한다. 역직렬화 과정에서 만들어진 인스턴스는 가비지 컬렉션 대상이 된다.

 

Enum 사용시 극복되는 단점

1. 리플렉션

Enum의 Constructor을 애초에 가져올 수 없다.

public class EnumElvisReflection {
    public static void main(String[] args) {
        try {
            Constructor<Elvis> declaredConstructor = Elvis.class.getDeclaredConstructor();
            // constructor을 애초에 가져올 수 없다.
            // java.lang.NoSuchMethodException 에러 발생.
            // Enum은 new로 만드는게 불가능하도록 처음부터 만들어진 것
            System.out.println(declaredConstructor);
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }
    }
}

 

2. 직렬화

readResolve 메서드를 정의하지 않아도 true가 출력된다.

public class EnumElvisSerialization {
    public static void main(String[] args) {
        try (ObjectOutput out = new ObjectOutputStream(new FileOutputStream("elvis.obj"))) {
            out.writeObject(Elvis.INSTANCE);
        } catch (IOException e) {
            e.printStackTrace();
        }

        try (ObjectInput in = new ObjectInputStream(new FileInputStream("elvis.obj"))) {
            Elvis elvis = (Elvis) in.readObject();
            System.out.println(elvis == Elvis.INSTANCE);
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}