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

Effective Java 3/E를 공부하며 작성한 글입니다.
혼자 공부하고 정리한 내용이며, 틀린 부분은 지적해주시면 감사드리겠습니다 😀

싱글톤이란?

싱글톤(singleton)이란, 인스턴스를 오직 하나만 생성할 수 있는 클래스이다.
싱글톤의 전형적인 예로는 함수와 같은 무상태 객체나 설계상 유일해야하는 시스템 컴포넌트를 들 수 있다.

무상태 객체란?

우선 상태가 있는(stateful) 클래스가 무엇인지부터 알아보는 것이 좋을 것 같다!

/**
 * 사용자의 주문을 저장하는 클래스
 * */
public class Order {
    private String nickname;

    private int price;

    public Order(String nickname, int price) {
        this.nickname = nickname;
        this.price = price;
    }
}

/**
 * 사용자의 주문을 처리하는 클래스
 * */
public class OrderService {
    private Order nextOrder;
    private int orderCount;

    public void makeOrder(String nickname, int price) {
        nextOrder = new Order(nickname, price);
        orderCount++;
    }

    public Order getOrder() {
        return nextOrder;
    }

}

// 사용자가 주문을 요청하는 테스트 클래스
public class OrderServiceTest {

    @Test
    void orderTest1() {
        OrderService service = new OrderService();
        service.makeOrder("user1", 10000);
        service.makeOrder("user2", 30000);

        System.out.println(service.getOrder());

    }
}

위와 같이 상태를 저장할 수 있는 것을 상태가 있는 클래스라고 부른다. 하지만 가장 큰 문제는 Order nextOrder라는 객체를 공유하기 때문에 여러 주문이 들어와도 가장 마지막 주문만 확인할 수 있게 된다. 즉, 주문량에 따라 앞서 들어온 주문은 무시될 수 있다는 것이다.

 

반대로 무상태는 상태를 공유하는 필드 변수가 없는 것을 의미한다. 즉, 특정 클라이언트가 의존할 수 있는 필드 변수가 존재할 수 없고, 값을 변경할 수 없어야한다. 위 코드를 싱글톤을 사용한 무상태 객체로 변환한다면 다음과 같다.

public class OrderService {
    // private 생성자를 통해 현재 OrderService를 싱글톤으로 만듦
    public static final OrderService INSTANCE = new OrderService();
    private OrderService(){}

    // 외부에서 만들어진 OrderRepository 객체를 가져옴
    // 해당 필드는 클라이언트 코드에서 의존하지 않으며, 객체를 참조하는 용도로만 사용
    private final OrderRepository repository = OrderRepository.INSTANCE;

    // 아래 두 메소드는 클래스 내부 상태에 의존하지 않는다.
    // 주어진 매개 변수와 외부 OrderRepository 객체만으로 동작
    public void makeOrder(String nickname, int price) {
        repository.save(new Order(nickname, price));
    }

    public List<Order> getOrderList() {
        return repository.findAllOrder();
    }

}

싱글톤을 생성하는 방법

1. public static final 필드 방식

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

    public String getPassedTime(LocalDateTime localDateTime) {
        ...
    }
}

위 코드와 같이 생성자를 private로 감추면, 다른 클래스에서 해당 객체를 생성할 수 없게 된다.
즉, DateTimeUtil.INSTANCE를 통해서만 객체를 생성할 수 있으며, 해당 객체는 static final 필드이기 때문에 딱 한 번만 생성이 된다.

public class UtilTest {
    @Test
    void utilTest1() {
        // 테스트 실패!
        // 메소드가 static이 아니기 때문에 컴파일 에러 발생!
        String time = DateTimeUtil.getPassedTime(LocalDateTime.now().minusHours(2));
        System.out.println(time);
        assertTrue(time.equals("2시간 전"));
    }

    @Test
    void utilTest2() {
        // 테스트 성공!
        // 정상 접근 가능!
        DateTimeUtil util = DateTimeUtil.INSTANCE;
        String time = util.getPassedTime(LocalDateTime.now().minusHours(2));
        System.out.println(time);
        assertTrue(time.equals("2시간 전"));
    }
}

이러한 Utility 클래스는 여러 곳에서 사용하기 위해 만든 클래스이므로, 싱글톤으로 사용하기 유용하다. 하지만, 메소드 쓰임에 따라 item1에서 공부한 정적 팩터리 방식으로 만드는 것이 더 유리할 수도 있다!

2. 정적 팩터리 방식

item1에서 봤던 것과 같이 이번에는 정적 팩터리 방식으로 인스턴스를 가져오는 것이다.

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

    public static DateTimeUtil getInstance() { return INSTANCE; }

    ...

    public String getPassedTime(LocalDateTime localDateTime) {
        ...
    }
}

취약점 : Reflection

1번, 2번 방식 모두 Reflection에서 제공하는 API를 통해 private 생성자를 가져올 수 있는 방법이 존재한다.

Reflection은 Class 객체를 통해 클래스의 정보를 가져오고, 객체를 생성하거나 메소드를 호출하는 등의 작업을 할 수 있도록 지원하는 기능이다.

public class OrderServiceTest {

    @Test
    void utilReflectionTest() {
        try {
            // DateTimeUtil 클래스의 생성자를 가져온다.
            // getDeclaredConstructor() -> 모든 접근 제어자를 무시하고, 클래스의 생성자를 가져온다.
            Constructor<DateTimeUtil> constructor = DateTimeUtil.class.getDeclaredConstructor();

            // 가져온 생성자를 접근 가능하도록 설정
            constructor.setAccessible(true);

            // 설정된 생성자를 사용해 DateTimeUtil 클래스의 새로운 인스턴스를 생성
            DateTimeUtil util = constructor.newInstance();

            // 인스턴스 내부 메소드 호출
            util.showCurrentTime();

        } catch (InvocationTargetException | NoSuchMethodException | InstantiationException | IllegalAccessException e) {
            // 다양한 Exception이 발생할 수 있음!
            throw new RuntimeException(e);
        }
    }

}

혹여나 이러한 방식의 공격을 방어하려면 아래와 같이 또 다른 객체가 생성될 때, 예외를 던져주면 된다.

public class DateTimeUtil {
    public static final DateTimeUtil INSTANCE = new DateTimeUtil();
    private static boolean instanceCreated = false;

    private DateTimeUtil() {
        if (instanceCreated) {
            throw new IllegalStateException("이미 객체가 생성되어 있습니다.");
        }
    }

    static {
        instanceCreated = true;
    }
}

여기서 사용한 static 블록은 클래스가 로딩될 때(처음으로 해당 클래스가 사용될 때) 자동으로 실행되는 블록이다.

// DateTimeUtil 클래스 로드
Constructor<DateTimeUtil> constructor = DateTimeUtil.class.getDeclaredConstructor();

// 이미 위에서 클래스가 로딩되어 instanceCreated가 true인 상태
// 때문에 IllegalStateException 발생!
DateTimeUtil util = constructor.newInstance();

장점1. 스레드별 다른 인스턴스 생성 가능

1번에서 봤던 방식과 크게 달라 보이는 점은 없지만, 싱글톤이 아니게 변경할 수 있다는 장점이 있다. 예를 들어, 유일한 인스턴스만을 반환하던 팩터리 메소드가, 호출하는 스레드별로 다른 인스턴스를 넘겨주게 만들 수 있다.

public class DateTimeUtil {
    // 스레드별 독립적으로 관리할 TreadLocal 선언
    // threadLocalInstance를 초기화하기 위해 스레드별로 인스턴스를 생성하는 withInitial() 사용
    // 이를 통해 스레드별 새로운 객체 생성
    private static final ThreadLocal<DateTimeUtil> threadLocalInstance = ThreadLocal.withInitial(() -> new DateTimeUtil());

    // 스레드별로 할당된 DateTimeUtil 인스턴스 반환
    public static DateTimeUtil getInstance() {
        // 현재 스레드에 할당된 DateTimeUtil 인스턴스 반환
        // 각 스레드별로 자신만의 인스턴스를 사용할 수 있음
        return threadLocalInstance.get();
    }

    // 몇 번째로 생성된 인스턴스인지 나타내는 변수 
    // AtomicInteger -> 멀티 스레드 환경에서도 값의 일관성을 보장함
    /*
      1, 2번 스레드에서 int에 동시에 접근할 경우에 대한 예시
     1번 스레드 : -----(1)--------------(1)-----
     2번 스레드 : -----------(2)---(2)----------
     - 1번 스레드가 변수를 읽고 1을 증가시키기 전에 2번 스레드가 변수를 읽고 1을 증가시킨다면,
     - 1번 스레드가 1을 증가시키기 전에 2번 스레드가 증가시킨 결과를 반영하지 못해 무결성이 깨짐 
    */
    private static final AtomicInteger counter = new AtomicInteger(1);

    private final int instanceNumber;

    private DateTimeUtil() {
        // 멀티 스레드 환경에서 객체가 생성될 때마다 값을 증가시킴
        instanceNumber = counter.getAndIncrement();
    }

    public void showCurrentTime() {
        // 인스턴스 번호와 현재 시간 출력
        System.out.println("Instance " + instanceNumber + ": " + System.currentTimeMillis());
    }
}

앞서 봤던 코드와 동일하게 getInstance()라는 메소드를 통해 DateTimeUtil 객체를 가져오지만, 객체를 가져오는 방식은 완전히 변경되었다. 앞서 진행했던 테스트에서 showCurrentTime()을 추가해 실행하면 아래와 같은 결과가 나온다.

Instance 1: 1691418372053
Instance 2: 1691418372058

분명 1개의 스레드만 사용하고 있을텐데 2가 나오는 이유는 Reflection 테스트 때문이다. 우리는 단일 스레드 환경에서 다른 객체가 생성되는 것을 방지하기 위해 방어 코드를 작성했지만, 이와 같이 ThreadLocal을 사용하면 새로운 객체가 만들어져도 다른 스레드에서 작업하기 때문에 문제가 발생할 수 없다.

장점2. 공급자로 사용 가능

공급자란, 정적 팩터리 메소드를 Supplier 인터페이스에 대한 참조로 바꿔서 객체를 생성하는 것

public class DateTimeUtil {
    ...
    public static Supplier<DateTimeUtil> getDateTimeUtilSupplier() {
        return DateTimeUtil::getInstance;
    }

    public static String getCurrentTime(LocalDateTime localDateTime) {
        return localDateTime.toString();
    }
}

public class UtilTest {
    @Test
    void utilSupplierTest1() {
        Supplier<DateTimeUtil> dateTimeUtilSupplier = DateTimeUtil.getDateTimeUtilSupplier();

        DateTimeUtil dateTimeUtil1 = dateTimeUtilSupplier.get();
        DateTimeUtil dateTimeUtil2 = dateTimeUtilSupplier.get();

        assertTrue(dateTimeUtil1 == dateTimeUtil2);
    }

    @Test
    void utilSupplierTest2() {
        Supplier<String> dateTimeUtilSupplier = 
                () -> DateTimeUtil.getCurrentTime(LocalDateTime.now());

        String time1 = dateTimeUtilSupplier.get();
        System.out.println("time1 = " + time1);
        String time2 = dateTimeUtilSupplier.get();
        System.out.println("time2 = " + time2);

        assertTrue(time1.equals(time2));
    }
}

클래스 직렬화

직렬화란, 객체를 바이트 스트림으로 변환하는 과정이다.
역직렬화란, 직렬화된 바이트 스트림을 다시 객체로 변환하는 과정이다.

Serializable을 구현한 DateTimeUtil을 예시로 확인해보자.

public class DateTimeUtil implements Serializable {
    private static final DateTimeUtil INSTANCE = new DateTimeUtil();

    private DateTimeUtil() {}

    public static DateTimeUtil getInstance() {
        return INSTANCE;
    }

    public String getPassedTime(LocalDateTime localDateTime) {
        ...
    }

}

아래 코드는 프로젝트 최상위 경로에 dateTimeUtil.ser이라는 파일명으로 직렬화를 진행한뒤, 직렬화된 파일을 다시 역직렬화해 객체로 반환하는 코드이다.

public class UtilTest {
    @Test
    void serializeTest() {
        // 직렬화할 파일 경로
        String filePath = "dateTimeUtil.ser";

        // 객체 생성
        DateTimeUtil original = DateTimeUtil.getInstance();

        // 객체를 파일에 직렬화
        serializeToFile(original, filePath);

        // 파일로부터 객체 역직렬화
        DateTimeUtil deserialized = deserializeFromFile(filePath);

        // 역직렬화된 객체 사용
        String passedTime = deserialized.getPassedTime(LocalDateTime.now().minusMinutes(2));
        System.out.println("passedTime = " + passedTime);

        // 테스트 실패!
        assertTrue(original == deserialized);
    }

    // 객체를 파일에 직렬화하는 메소드
    private static void serializeToFile(Object object, String filePath) {
        try (ObjectOutputStream outputStream = new ObjectOutputStream(new FileOutputStream(filePath))) {
            outputStream.writeObject(object);
            System.out.println("Object serialized to " + filePath);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 파일로부터 객체 역직렬화하는 메소드
    private static DateTimeUtil deserializeFromFile(String filePath) {
        try (ObjectInputStream inputStream = new ObjectInputStream(new FileInputStream(filePath))) {
            DateTimeUtil deserialized = (DateTimeUtil) inputStream.readObject();
            System.out.println("Object deserialized from " + filePath);
            return deserialized;
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
            return null;
        }
    }
}

original 객체가 직렬화를 통해 dateTimeUtil.ser이라는 파일이 되었고, 해당 파일을 역직렬화를 통해 deserialized 객체가 되었다.

이 두 객체는 동일한 객체여야하지만, 서로 다른 객체라며 테스트를 실패한다.

테스트를 실패하는 이유는 기본적으로 직렬화된 인스턴스를 역직렬화할 때, 새로운 인스턴스가 계속해서 만들어진다. 역직렬화 시 객체가 새로 생성되는 것을 막고, 항상 동일한 인스턴스를 반환하여 싱글톤 패턴을 지키기 위해 readResolve() 메소드를 사용한다.

public class DateTimeUtil implements Serializable {

    private static final DateTimeUtil INSTANCE = new DateTimeUtil();

    public static DateTimeUtil getInstance() {
        return INSTANCE;
    }

    private Object readResolve() {
        return getInstance();
    }

}

자바 직렬화 프로세스

직렬화(Serialization)

• 객체를 바이트 스트림으로 저장하기 위해 writeObject() 메소드를 사용해 직렬화함

역직렬화(Deserialization)

• 저장된 바이트 스트림을 readObject() 메소드를 통해 읽어오고, 객체로 복원해 역직렬화함

객체 커스터마이즈(readResolve)

• 복원될 객체 내부에 readResolve() 메소드가 있다면 역직렬화 시에 복원되는 객체를 커스터마이즈 할 수 있음

3. 열거 타입 방식의 싱글턴 방식

열거 타입이란?

enum은 클래스와 같이 멤버 변수, 메소드 등을 정의할 수 있다.
가장 다른 점은 접근 제어자나 static, final 키워드가 없어도 상수를 사용할 수 있다는 점이다.

public enum DayOfWeek {
    MONDAY,
    TUESDAY,
    WEDNESDAY,
    THURSDAY,
    FRIDAY,
    SATURDAY,
    SUNDAY
}

DayOfWeek today = DayOfWeek.MONDAY;

위 코드를 예시로 MONDAY의 값을 갖는 객체로도 활용할 수 있다.

싱글톤 생성 방식

위에서 설명한대로 열거형 상수를 1개만 선언한다는 것은 해당 객체는 무조건 싱글톤이라는 것과 동일한 말이다.

public enum DateTimeUtil {

    INSTANCE;

    public String getPassedTime(LocalDateTime localDateTime) {
        ...
    }

}

앞서 봤던 방식과 다르게 가장 간단하다.
대부분의 상황에서 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다.