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

💬 이팩티브자바 아이템 3을 읽고 정리한 글입니다.

---

 

✔️ 싱글턴 인스턴스

인스턴스를 오직 하나만 생성할 수 있는 클래스. 메모리 낭비를 줄일 수 있고, 데이터를 공유할 수 있다.

다만, 결합도가 증가하며 클라이언트의 테스트가 어려워질 수 있다는 점이 존재한다.

-> 인스턴스를 구현해서 만든 싱글턴이 아니라면, 싱글턴 인스턴스를 mock 객체로 대체하기가 힘들기 때문이다.

 

 

💬 생성하는 방법

1. 생성자를 모두 private로 만들고, 인스턴스의 유일한 접근자를 public static으로 생성하기

public class Crew {
    public static final Crew INSTANCE = new Crew();
    private Crew() {
		...
    }
    public void hello() {...}
}

이렇게 되면, Crew 클래스가 생성될 때 static final 필드로 인해서 private 생성자가 딱 1번만 호출된다.

= 전체 시스템에서 해당 인스턴스는 딱 1개임을 보증해줄 수 있다.

 

 

2. 정적 팩터리 메서드 사용하기

public class Crew {
    private static final Crew INSTANCE = new Crew();
    private Crew() {
		...
    }
    public static Crew getInstance() {
        return INSTANCE;
    }
    public void hello() {...}
}

이전에 생성한 필드를 private로 변경하고, 정적 팩터리 메서드를 통해서 해당 필드를 접근하는 것을 볼 수 있다.

또한, 해당 정적 팩터리 메서드는 항상 같은 객체의 참조값을 반환하게 된다.

 

두 가지 방법의 장단점을 비교해보자.

1번 → 클래스가 싱글턴임을 API에 명백하게 드러낸다. 간결하다.

2번 → API의 변경없이 싱글턴이 아니도록 만들 수 있다. (팩터리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘겨준다든지…?), 제네릭 싱글턴 팩터리로 만들거나, 정적 펙터리 메서드 참조를 공급자로 사용이 가능하다. (ex. Supplier)

 

💡 제네릭 싱글턴 팩터리는 추후 소개되겠지만, 간략하게 설명하면 요청으로 들어온 타입 매개변수에 맞게, 그 객체의 타입을 바꾸어주는 정적 팩터리를 생성해주는 것을 의미한다.

// ImmutableCollections.java
static <E> Set<E> emptySet() {
        return (Set<E>) SetN.EMPTY_SET;
}

그냥 제네릭 + 정적 팩터리 메서드라고 생각하면 편하다 :D

 

 

💬 직렬화 관점

싱글턴 클래스를 직렬화하는 것은 주의를 해야 한다.

기본적으로 싱글턴 클래스는 하나의 인스턴스만 가지고 있다. 하지만, 해당 인스턴스를 직렬화한 뒤, 다시 역직렬화를 통해 복원하게 된다면 해당 클래스의 새로운 인스턴스를 생성하는 것과 마찬가지가 된다.

이렇게 되면, 싱글턴 클래스는 '하나의 인스턴스만 생성한다'라는 개념과 일치하지 않게 된다.

 

그래서, 싱글턴 클래스의 직렬화를 위해서는 다음과 같은 방법을 사용할 수 있다.

만약, 인스턴스 필드가 존재한다면 모든 인스턴스 필드를 transient로 설정하여 직렬화에서 제외시키는 것이다.

public class Singleton implements Serializable {
    private static final long serialVersionUID = 1L;
    private transient String name;

    private static final Singleton instance = new Singleton("Test");

    private Singleton(final String name) {
        this.name = name;
    }

    public static Singleton getInstance() {
        return instance;
    }

    @Override
    public String toString() {
        return "Singleton{" +
                "name='" + name + '\'' +
                '}';
    }
}

transient 키워드를 사용하면 해당 필드값 자체는 유지되지만, 내부적으로 null 값이 대입된다.

즉, 생성한 instance에 대해 역직렬화 시 결과값이 null이 되는 것이다.

 

만약, transient를 붙이지 않은 상태로 직렬화를 했다고 가정해보자.

public class Main {
    public static void main(String[] args) {
        Singleton singleton = Singleton.getInstance();

        // 직렬화를 진행한다.
        try (FileOutputStream fileOut = new FileOutputStream("singleton.ser");
             ObjectOutputStream out = new ObjectOutputStream(fileOut)) {
            out.writeObject(singleton);
        } catch (IOException i) {
            i.printStackTrace();
        }

        // 역직렬화를 진행한다.
        Singleton deserializedSingleton;
        try (FileInputStream fileIn = new FileInputStream("singleton.ser");
             ObjectInputStream in = new ObjectInputStream(fileIn)) {
            deserializedSingleton = (Singleton) in.readObject();
        } catch (IOException | ClassNotFoundException i) {
            i.printStackTrace();
            return;
        }

        // 출력
        System.out.println(deserializedSingleton.toString());
    }
}

transient를 붙이지 않았을 때는 다음과 같이 null이 아닌 실제 값이 들어간다.

반면에, transient를 붙이면 위와 같이 null이 들어간다.

 

다만, transient 키워드는 인스턴스 변수에 사용하는 것이 일반적이다. 

위 코드에서 instance의 경우 static 키워드를 사용하였기 때문에 인스턴스와 무관하게 클래스 자체에 속하게 된다.

즉, 클래스 자체가 직렬화되면서 역직렬화 과정에서 getInstance가 아닌 저장된 인스턴스가 복원되며, 기존의 싱글턴 인스턴스와 다른 객체가 생성되게 된다. 그렇기 때문에, 추가적으로 readResolve()를 재정의 해야 한다.

 

boolean result = singleton == deserializedSingleton;
System.out.println("singleton == deserializedSingleton : " + result);

실제로 위의 코드를 돌려보면, false가 나온다.

public class Singleton implements Serializable {
    private static final long serialVersionUID = 1L;

    private static final Singleton instance = new Singleton();

    private Singleton() {}

    public static Singleton getInstance() {
        return instance;
    }

    protected Object readResolve() {
        return instance;
    }
}

반면에 readResolve() 메서드를 사용하게 되면, 역직렬화 과정에서 만들어진 인스턴스 대신에 기존에 생성된 인스턴스를 반환하도록

만들어서 해당 인스턴스를 사용하도록 만들 수 있다.

결과를 보면, 이렇게 true가 반환되는 것을 볼 수 있다!

 

 

💬 왜 readResolve()를 재정의하면 되는 걸까?

궁금해서 메서드 내부를 조금 까봤다.

try (FileInputStream fileIn = new FileInputStream("singleton.ser");
     ObjectInputStream in = new ObjectInputStream(fileIn)) {
     deserializedSingleton = (Singleton) in.readObject(); // Here!
	...

위 코드에서 readObject()의 내부 구현을 살펴보자.

이렇게 bypass 하는 메서드가 정의되어 있는데, 또 따라가보자.

이 메서드에서 중간에 있는 readObject0 메서드를 타고 들어가보자!

그럼 여기서 object case에 대해 readOrdinaryObject()라는 메서드를 호출하는데!

 

들어가 보면 다음과 같이 readResolve() 메서드가 있는지 확인을 하고, 존재하는 경우에 invoke를 통해서 호출해주는 것을 볼 수 있다.실제로 invokeReadResolve() 메서드를 보면 아래와 같다. (이래서 메서드의 네이밍이 중요하다는 것을 다시 깨닫는다 👍)

요런 식으로 내부에서 invoke를 통해 우리가 작성한 코드를 호출해주는 것 같다! ㅎㅎ

 

 

추가적으로 책에서는 싱글턴의 생성 방법으로 enum을 소개한다.

enum의 경우 JVM이 하나의 인스턴스로 관리하기 때문이다.

public enum Crew {
    INSTANCE;

    public void hello() {...}
}

또한, enum의 경우 기본적으로 Serializable하다. enum의 경우 직렬화를 하게 되면 ObjectOutputStream에서 name()의 return 값을 사용하며, 역직렬화 시에는 valueOf를 통해 enum의 constant 값을 가져온다고 한다.

하지만, readResolve 같은 메서드를 통해 별도로 커스텀은 불가능하며, serialVersionUID의 경우 0L로 고정이 되어있다.

 

코드로 확인해보자!

case가 친절하게 enum에 대해서 나누어져있다 ㅎㅎ (역직렬화 시 사용하는 readObject() 메서드를 아까처럼 까본 것이다.)

여기서 Enum.valueOf를 통해서 result를 담아주는 것을 볼 수 있다!

 

직렬화 과정도 살펴보자.

writeObject의 메서드 중에서 writeObject0를 들어가보자!

그럼 Enum 타입에 대해서 writeEnum이라는 메서드를 호출하게 되며,

내부적으로 en.name()을 통해서 writeString을 하는 것을 볼 수 있다!

 

책에서 대부분의 이게 가장 좋은 방법이라고 하는데, 만약 만들려는 객체가 상속을 해야 된다면 사용이 불가능하다. (enum 자체는 추가 상속이 안 되니까)

 

---

책 내용은 간결한데 직렬화 부분을 공부하다 보니 생각보다 정리하는 데 더 걸렸다 💦

그래도 코드 까보는 건 항상 재밌다 ㅎㅎ 이팩티브 남은 것도 얼른 정리해야지...