스프링 핵심원리 : 기본편 - 싱글톤 컨테이너와 주의점

"인프런의 스프링 핵심원리 - 기본편 강의를 듣고 작성한 글 입니다."

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

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

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성) 으로 관리한다.

지금까지 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

 

* 싱글톤 컨테이너

- 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리한다.

    - 이전에 설명한 컨테이너 생성 과정을 자세히 보자. 컨테이너는 객체를 하나만 생성해서 관리한다.

- 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

- 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서, 객체를 싱글톤으로 유지할 수 있다.

    - 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.

    - DIP, OCP 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

 

다음과 같이 SingletonTest 클래스에 스프링 컨테이너를 사용하는 테스트 코드를 추가해보자.

- SingletonTest.java

public class SingletonTest {

    @Test
    @DisplayName("스프링 없는 순수한 DI 컨테이너")
    void pureContainer(){
        AppConfig appConfig = new AppConfig();

        // 1. 조회 : 호출할 때마다 객체를 생성
        MemberService memberService1 = appConfig.memberService();

        // 1. 조회 : 호출할 때마다 객체를 생성
        MemberService memberService2 = appConfig.memberService();

        // 참조값이 다른 것을 확인
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        assertThat(memberService1).isNotSameAs(memberService2);
    }

    
    // 싱글톤 패턴을 적용시킨 객체 생성 테스트
    @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest(){
        SingletonService singletonService1 = SingletonService.getInstance();
        SingletonService singletonService2 = SingletonService.getInstance();

        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);

        assertThat(singletonService1).isSameAs(singletonService2);
        singletonService1.logic();
    }

    // 스프링 컨테이너를 활용한 싱글톤 패턴 확인
    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer(){

        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        MemberService memberService1 = ac.getBean("memberService", MemberService.class);
        MemberService memberService2 = ac.getBean("memberService", MemberService.class);

        // 참조값이 같은 것을 확인
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        assertThat(memberService1).isSameAs(memberService2);
    }
}

결과 : 테스트 통과

memberService1 = hello.core.member.MemberServiceImpl@6c2ed0cd
memberService2 = hello.core.member.MemberServiceImpl@6c2ed0cd

 

여기서 springContainer 메소드를 실행해보면 순수한 자바코드로 작성한 경우와는 달리 출력 값으로 똑같은 객체 참조값을 반환 받는다는 것을 알 수 있다.

 

싱글톤 컨테이너 적용 후

- 스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다.

* 참고 : 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때마다 새로운 객체를 생성해서 반환하는 기능도 제공한다. 자세한 내용은 빈 스코프에서 알아보자.

 

 

싱글톤 방식의 주의점

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

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

    - 특정 클라이언트에 의존적인 필드가 있으면 안된다.

    - 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.

    - 가급적 읽기만 가능해야 한다.

    - 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

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

 

상태를 유지할 경우 발생하는 문제점 예시

test 폴더 아래 hello.core.singleton 패키지에 StatefulService, StatefulServiceTest 클래스를 만들고, 다음과 같이 코드를 작성해보자.

- StatefulService.java

public class StatefulService {

    private int price; // 상태를 유지하는 필드
    
    public void order(String name, int price){
        System.out.println("name = " + name + " price = " + price);
        this.price = price; // 여기가 문제!
    }

    public int getPrice(){
        return price;
    }
}

- StatefulServiceTest.java

class StatefulServiceTest {

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

        // Thread A : A 사용자가 10000원을 주문
        statefulService1.order("userA", 10000);
        // Thread B : B 사용자가 10000원을 주문
        statefulService2.order("userB", 20000);
        
        // Thread A : 사용자A 가 주문 금액을 조회
        int price = statefulService1.getPrice();
        System.out.println("price = " + price);

        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

    static class TestConfig{

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

결과 :

name = userA price = 10000
name = userB price = 20000
price = 20000

 

StatefulServiceTest 의 실행 결과를 보면 서로 다른 두 명의 고객의 주문을 받았는데, A 의 price 값은 10000 이어야 하지만 B 주문의 영향으로 인해 20000 이 된 것을 확인할 수 있다.

외부의 다른 클라이언트로 인해 특정 필드의 값이 바뀌어 버린 것이다.

단 하나의 객체로 관리하는 싱글톤 패턴을 사용할 때 주의해야 할 점이 바로 이런것이다.

 

- 최대한 단순히 설명하기 위해 실제 쓰레드는 사용하지 않았다.

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

- StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.

- 사용자 A 의 주문금액은 10000원이 되어야 하는데, 20000원 이라는 결과가 나왔다.

- 실무에서 이런 경우를 종종 볼 수 있다고 하는데, 이로인해 정말 해결하기 어려운 큰 문제들이 터진다고 한다.

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

 

* 위의 문제는 다음과 같이 공유되서 쓰이지 않는 지역변수를 활용해 해결이 가능하다.

- StatefulService.java

public class StatefulService {

//    private int price; // 상태를 유지하는 필드
    
    public int order(String name, int price){
        System.out.println("name = " + name + " price = " + price);
//        this.price = price; // 여기가 문제!
        return price; // 입력으로 들어온 price 필드를 리턴으로 넘겨준다.
    }

//    public int getPrice(){
//        return price;
//    }
}

- StatefulServiceTest.java

class StatefulServiceTest {

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

        // price 필드를 지역변수화 한다.
        // Thread A : A 사용자가 10000원을 주문
        int userAPrice = statefulService1.order("userA", 10000);
        // Thread B : B 사용자가 10000원을 주문
        int userBPrice = statefulService2.order("userB", 20000);

        // Thread A : 사용자A 가 주문 금액을 조회
//        int price = statefulService1.getPrice();
        System.out.println("userAPrice = " + userAPrice);
        System.out.println("userBPrice = " + userBPrice);

//        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

    static class TestConfig{

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

결과 :

name = userA price = 10000
name = userB price = 20000
userAPrice = 10000
userBPrice = 20000

 

공유되지 않은 지역변수를 통해 싱글톤 객체를 무상태(stateless) 로 설계한 결과 앞전과 달리 price 필드의 데이터 공유 현상이 발생하지 않았음을 확인할 수 있다.