[Spring] 싱글톤 컨테이너

이 글은 김영한님의 스프링 핵심원리 기본편 강의를 보고 공부용도로 정리한 내용입니다.^&^

 

스프링은 객체를 싱글톤으로 관리한다

스프링 컨테이너는 기본적으로 객체 인스턴스를 싱글톤(1개만 생성)으로 관리합니다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글론 레지스트리라 합니다.

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

 

스프링 빈으로 등록할 객체들을 @Bean 어노테이션을 이용하여 다음과 같이 명시할 수 있습니다.

 

AppConfig.java

@Configuration
public class AppConfig {
    @Bean
    public MemberService memberService(){
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }
    @Bean
    public MemberRepository memberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }
    @Bean
    public OrderService orderService(){
        System.out.println("call AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());

    }
    @Bean
    public DiscountPolicy discountPolicy() {

        return new RateDiscountPolicy();
    }
}

 

 

스프링에서 객체를 싱글톤으로 관리하는지 알아보는 테스트 코드입니다.

MemberService 형의 memberService1과 memberService2를 만들고 서로가 같은 객체인지 isSameAs 메소드를 이용하여 테스트 해봅니다.

   @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        //1. 조회: 호출할 때 마다 같은 객체를 반환
        MemberService memberService1 = ac.getBean("memberService", MemberService.class);
        //2. 조회: 호출할 때 마다 같은 객체를 반환
        MemberService memberService2 = ac.getBean("memberService", MemberService.class);

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

결과

19:39:47.386 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'appConfig'
19:39:47.394 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memberService'
call AppConfig.memberService
19:39:47.518 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memberRepository'
call AppConfig.memberRepository //->한 번만 호출됐다!!
19:39:47.530 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'orderService'
call AppConfig.orderService
19:39:47.532 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'discountPolicy'
memberService1 = hello.core.member.MemberServiceImpl@3b00856b
memberService2 = hello.core.member.MemberServiceImpl@3b00856b

memberService1과 memberService2가 서로 같다는 것을 알 수 있습니다.

컨테이너에서 getBean 메서드를 통해 객체를 가져올 때 매번 객체를 생성하는 것이 아니고 공유하고 있습니다.

 

 

결과에서 이상한 점

AppConfig.java를 보면 memberService 빈을 만드는 코드는 memberRepository()를 호출합니다.

orderService 빈을 만드는 코드도 동일하게 memberRepository()를 호출합니다.

 

각각 다른 2개의 MemberRepository가 생성될텐데 스프링 컨테이너는 이 문제를 어떻게 해결할까요??

스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성하는데 memberRepository()는 다음과 같이 총 3번 호출되어야 하는거 아닐까요?

1. 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean이 붙어있는 memberRepository() 호출
2. memberService() 로직에서 memberRepository() 호출

3. orderService() 로직에서 memberRepository() 호출

 

그런데 출력 결과를 보면 1번만 호출됐습니다.

 

 

 

비밀은 @Configuration 어노테이션

 

다음 테스트 코드를 봅시다잉

@Test
    void configurationDeep() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        //AppConfig도 스프링 빈으로 등록된다.
        AppConfig bean = ac.getBean(AppConfig.class);


        System.out.println("bean = " + bean.getClass());
        //출력 : bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$c684a9d7
        }

 

사실 AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록됩니다.

그래서 AppConfig 도 스프링 빈이 되고 이를 출력해보면 예상과 다르게 클래스 명에 xxxCGLIB 가 붙어있습니다.

스프링이 CGLIB라는 바이트 코드 조작 라이브러리를 사용하여 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것입니다.

AppConfig@CGLIB가 싱글톤이 보장되도록 하는 녀석입니다. 다음과 같은 예상코드로 AppConfig@CGLIB는 작성되어있을 것입니다.

@Bean
    public MemberRepository memberRepository() {
	if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) { 
    	return 스프링 컨테이너에서 찾아서 반환;
	} 
    else { 
    //스프링 컨테이너에 없으면
		기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록 return 반환
	}
 }

@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성 해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어져서 싱글톤이 보장될 수 있습니다.

 

 

 

@Configuration을 적용하지 않고 @Bean만 적용한다면?

AppConfig.java에서 @Configuration을 주석처리 후 configurationDeep() 메소드를 다시 테스트해보면,

//@Configuration
public class AppConfig {
    @Bean
    public MemberService memberService(){
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }
    ...(생략)

 

결과

21:27:01.282 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'appConfig'
21:27:01.305 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memberService'
call AppConfig.memberService
call AppConfig.memberRepository  //memberRepository호출 1번
21:27:01.327 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memberRepository'
call AppConfig.memberRepository  //memberRepository호출 2번
21:27:01.329 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'orderService'
call AppConfig.orderService
call AppConfig.memberRepository  //memberRepository호출 3번
21:27:01.336 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'discountPolicy'
bean = class hello.core.AppConfig

MemberRepository가 총 3번 호출됩니다.

1. 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean이 붙어있는 memberRepository() 호출
2. memberService() 로직에서 memberRepository() 호출

3. orderService() 로직에서 memberRepository() 호출

 

결과의 마지막 라인을 보시면 bean = class hello.core.AppConfig 

출력 결과도 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있습니다.

 

 

 

@Configuration 어노테이션이 없이 생성된 MemberRepository가 서로 같은지 다른지 테스트하는 코드입니다. 

 @Test
    void configurationTest() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);
        MemberRepository memberRepository = ac.getBean("memberRepository", MemberRepository.class);

     
        System.out.println("memberService -> memberRepository = " + memberService.getMemberRepository());
        System.out.println("orderService -> memberRepository = " + orderService.getMemberRepository());
        System.out.println("memberRepository = " + memberRepository);

       

        assertThat(memberService.getMemberRepository()).isNotSameAs(memberRepository);
        assertThat(orderService.getMemberRepository()).isNotSameAs(memberRepository);

    }

결과

memberService -> memberRepository = hello.core.member.MemoryMemberRepository@56928307
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@3899782c
memberRepository = hello.core.member.MemoryMemberRepository@1603cd68

각각 다른 MemberRepository 인스턴스를 갖고 있는것을 확인할 수 있습니다.

 

 

정리

@Bean만 사용해도 스프링 빈으로 등록이 되지만 싱글톤을 보장하진 않는다.

@Configuration 사용시 CGLIB 기술을 사용하여 싱글톤을 보장해준다.

 

 

 

 

싱글톤 방식의 주의점

 

객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 같은 인스턴스를 공유하므로 싱글톤 객체는 상태를 무상태(stateless)로 설계해야 합니다.

실제 실무에서 무상태가 지켜지지 않아 빈번하게 발생하는 에러라고 합니다.

 

무상태(stateless)

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