스프링에서 싱글톤 적용 시 주의 할 점! ⚠️

스프링 컨테이너는 기본적으로 싱글톤을 제공합니다.

위의 사진을 보자면 스프링 DI 컨테이너에 memberSerivce의 bean이 등록되어있다고 가정하면 각 각 사용자의 요청마다 객체를 생성하는 것이 아닌 객체 인스턴스를 하나만 생성하여 공유합니다. 메모리 낭비도 없고 효율적으로 재활용할 수 있습니다. 이때 주의해야 할 점이 있습니다.

스프링 컨테이너에 등록된 bean은 무상태(stateless)를 유지 해야합니다. 이 부분이 정말 정말 중요합니다. 말 그대로 객체는 상태를 가지고 있으면 안 됩니다.

---

public class menuService {

    private String menuName;

    public void order(String menuName){
        System.out.println("주문한 메뉴 이름 ="+ menuName );
        this.menuName  = menuName; //이쪽이 문제
    }

    public  String getMenuName(){
        return menuName;
    }
}

 

위와 같은 객체를 생성했다고 가정해봅니다. 그냥 봤을 경우 별 문제가 없어 보입니다. 자세히 들어다 보면 주문 시에  menuName의 필드를 저장한 상태를 가지게 됩니다. 위에서 말했다시피 스프링 컨테이너는 하나의 객체를 생성하여 요청 시 공유해서 재활용합니다. 여러 명이 요청했을 경우 문제가 발생합니다.

유저 1, 유저 2가 순차적으로 메뉴를 주문했다고 가정해봅시다. 유저 1의 요청으로 아메리카노를 주문했습니다.  menuService는 menuName에 아메리카노가 저장된 상태를 가지게 됩니다. 그 상태 그대로  유저2의 요청으로 카페라떼를 주문했습니다. 또 다시  menuService는 menuName에 카페라떼가 저장된 상태를 가지게됩니다. 스프링 컨테이너는 하나의 객체를 재활용한 다는 것을 복기합시다. 이때 유저 1의 getMenuName()으로 메뉴 이름을 반환하면 어떤 값이 반환될까요? 아메리카노가 아닌 카페라떼를 가지고 있는 상태를 반환해줍니다.

 

테스트 코드를 같이 볼까요?

class ServiceTest {

    @Test
    void statefulService(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        MenuService menuService1 = ac.getBean("MenuService", MenuService.class);
        MenuService menuService2 = ac.getBean("MenuService", MenuService.class);

        //A사용자 아메리카노 주문
        menuService1.order("아메리카노");
        //B사용자 카페라떼 주문
        menuService2.order("카페라떼");

        //사용자A 주문 메뉴 조회
        String menuName = menuService1.getMenuName();
        //사용자A는 아메리카노을 기대했지만, 기대와 다르게 카페라떼 출력
        System.out.println("menuName = " + menuName);
    }

    static class TestConfig {
        @Bean
        public MenuService menuService() {
            return new menuService();
        }
    }
}

---

왜 그럴까요? 

menuName이라는 필드가 공유되고 있기 때문입니다. 이러한 것들을 방지해주기 위해서 아래의  주의점을 인지하고 설계하면 됩니다.

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

스프링 빈은 항상 무상태(stateless)로 설계하자.