[Spring core basic] 25 - 싱글톤 패턴 주의점

참고

Spring core basic 시리즈는 김영한 님의 "스프링 핵심 원리 - 기본편" 강의를 정리한 글입니다. 글에 첨부된 사진은 해당 강의의 강의 자료에서 캡쳐한 것입니다. 제 Github에만 올려뒀다가, 정보 공유와 강의 홍보(?)를 위해 블로그에도 업로드합니다. 마크다운을 잘 쓰지 못해서 가독성이 조금 떨어지는 점 양해 바랍니다.

 

스프링 핵심 원리 - 기본편 - 인프런 | 강의

싱글톤 패턴 주의점

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유한다. 따라서 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.

무상태(stateless)로 설계해야 한다!

• 특정 클라이언트에 의존적인 필드가 있으면 안된다.
• 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다!
• 가급적 읽기만 가능해야 한다 (값의 수정은 지양해야 한다)
• 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다!

Stateful 서비스로 설계할 경우 발생하는 문제점

코드로 살펴보자. 최대한 단순히 설명하기 위해, 실제 쓰레드는 사용하지 않았다.

StatefulServiceTest.java

//package, import 생략

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        ApplicationContext ac =
        new AnnotationConfigApplicationContext(TestConfig.class);

        //스프링 컨테이너에 의해 같은 객체를 공유하게 된다.
        StatefulService statefulService1 =
        ac.getBean("statefulService", StatefulService.class);
        StatefulService statefulService2 =
        ac.getBean("statefulService", StatefulService.class);

        //Thread A에서 userA가 10000원 주문
        statefulService1.order("userA", 10000);
        //Thread B에서 userB가 20000원 주문
        //userA의 작업이 전부 끝나기 전에 userB의 작업이 끼어들었다.
        statefulService2.order("userA", 20000);

        //Thread A에서 userA가 주문 금액 조회. 10000원이 나와야 하는데 과연?
        int price1 = statefulService1.getPrice();
        //Thread B에서 userB가 주문 금액 조회
        int price2 = statefulService2.getPrice();

        //스프링 컨테이너에 의해 같은 객체를 공유하기 때문에 둘 다 20000이 출력된다.
        System.out.println("price1 = " + price1);
        System.out.println("price2 = " + price2);

        //이게 통과하면 오히려 문제가 있는 것. 이 서비스는 망했다.
        //실제 thread를 적용해서 테스트하려고 하면 테스트도 어렵다.
        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

    static class TestConfig {
        @Bean
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }
}

ThreadA가 사용자 A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.

• StatefulService의 price 필드는 공유되는 필드인데, 특정 클라이언트가 공유되는 필드의 값을 변경한다(order() 메소드에 price 값을 바꾸는 코드가 있음).
• 사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.
• 실무에서 이런 상황이 종종 발생하는데, 이로 인해 정말 해결하기 어려운 큰 문제들이 터진다 (몇 년 주기로 꼭 만나신다고 함).

공유되는 필드는 반드시 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자.

StatefulServiceTest를 다음과 같이 변경해보자.

StatefulService.java

//package, import 생략

public class StatefulService {

    public int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        return price;
    }

    public int getPrice() {
        return price;
    }
}

공유되는 필드가 존재하지 않기 때문에 statelss 해졌다.