3. [스프링 핵심 원리 - 기본편] 싱글톤 컨테이너

1. 웹 애플리케이션과 싱글톤

 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다. 이전에 만들었던 스프링을 사용하지 않는 순수한 DI 컨테이너인 AppConfig은 요청을 할 때마다 객체를 새로 생성한다.

@Test
void pureContainer() {
    AppConfig appConfig = new AppConfig();

    final MemberService memberService1 = appConfig.memberService();
    final MemberService memberService2 = appConfig.memberService();

    assertThat(memberService1).isNotSameAs(memberService2);
}

public class AppConfig {
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
    
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }
}

 

 해결 방안은, 해당 객체가 딱 1개만 생성되고 이를 공유하도록 설계하면 된다. 이것이 싱글톤 패턴이다.

 

2. 싱글톤 패턴

  싱글톤 패턴이란, 하나의 JVM 안에서 한 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다. 인스턴스가 2개 이상 생성되지 못하도록 막는 방법은 다음과 같다.

 1) static 영역에 객체를 미리 하나 생성해 놓는다.

 2) 이 객체를 사용하려면 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드는 항상 같은 객체를 반환한다.

 3) 생성자를 private으로 만들어서 추가적인 객체가 생성되는 것을 막는다. 

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    private SingletonService() {
    }

    public static SingletonService getInstance() {
        return instance;
    }
}

 

 싱글톤 패턴을 적용하면, 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다. 하지만 싱글톤 패턴은 다음과 같은 문제점들을 가지고 있다.

 1) 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.

 2) 클라이언트가 구체 클래스에 의존한다. -> DIP 위반

 3) 클라이언트가 구체 클래스에 의존하기 때문에 OCP도 위반할 가능성이 높다.

 4) 테스트하기 어렵다. 

 5) 내부 속성을 변경하거나 초기화하기 어렵다.

 6) private 생성자로 인해 자식 클래스를 만들기 어렵다.

 7) 결론적으로 유연성이 떨어진다.

 8) 때문에 안티 패턴으로 불리기도 한다.

 

3. 싱글톤 컨테이너

 스프링 컨테이너는 싱글톤 컨테이너의 역할을 한다. 스프링의 빈(Bean)들이 모두 싱글톤으로 관리된다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다. 스프링 컨테이너의 이러한 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다. 아래의 테스트 코드를 보면, ApplicationContext에서 빈을 여러번 호출하더라도 동일한 객체가 호출됨을 알 수 있다.

@Test
void springContainer() {
    final ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    final MemberService memberService1 = ac.getBean("memberService", MemberService.class);
    final MemberService memberService2 = ac.getBean("memberService", MemberService.class);

    assertThat(memberService1).isSameAs(memberService2);
}

 

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

 

4. 싱글톤 방식의 주의점

 객체를 하나만 생성해서 공유하는 싱글톤 방식은, 여러 클라이언트가 하나의 객체를 공유하기 때문에, 객체 상태를 유지(stateful)하게 설계하면 안된다. 즉, 무상태(stateless)로 설계해야 한다. 무상태로 설계하는 방법은 다음과 같다.

 1) 특정 클라이언트에 의존적인 필드가 있어선 안된다.

 2) 특정 클라이언트가 값을 변경할 수 있는 필드가 있어선 안된다.

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

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

 

5. @Configuration과 싱글톤

 아래의 코드를 보면, MemberService 빈이 생성될 때 memberRepository() 메서드가 호출되어 new MemoryMemberRepository()가 호출된다. 마찬가지로 OrderService 빈이 생성될 때도 memberRepository() 메서드가 호출되어 new MemoryMemberRepository()가 호출된다. 결과적으로 MemoryMemberRepository 객체가 2개 생성되어 싱글톤이 깨진 것처럼 보인다. 

@Configuration
public class AppConfig {
    @Bean
    public MemberRepository memberRepository() {
        System.out.println("AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }
    
    @Bean
    public DiscountPolicy discountPolicy() {
        System.out.println("AppConfig.discountPolicy");
        return new RateDiscountPolicy();
    }

    @Bean
    public MemberService memberService() {
        System.out.println("AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public OrderService orderService() {
        System.out.println("AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }
}

 

 하지만 막상 아래의 테스트 코드를 돌려 보면, 싱글톤이 보장된다는 것을 알 수 있다. 그리고 콘솔창을 확인하면, memberRepository() 메서드는 한 번만 호출되었다는 것을 확인할 수 있다.

class ConfigurationSingletonTest {
    @Test
    void configurationTest() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        final MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        final OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);
        final MemberRepository memberRepository = ac.getBean("memberRepository", MemberRepository.class);

        assertThat(memberRepository).isSameAs(orderService.getMemberRepository());
        assertThat(memberRepository).isSameAs(memberService.getMemberRepository());
    }
}

 

 

6. @Configuration과 바이트코드 조작의 마법

 AppConfig의 자바 코드를 보면, memberRepository() 메서드는 분명 3번 호출되는 것이 맞다. 하지만 스프링은 싱글톤을 보장해야하기 때문에, 바이트코드를 조작하는 라이브러리를 사용한다. 아래의 테스트 코드를 실행해보자. 만약 AppConfig이 순수한 클래스라면 AppConfig의 클래스명만 나와야 한다. 하지만 결과를 보면 그렇지 않고 xxxCGLIB가 붙은 것을 볼 수 있다. 이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서, AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스의 객체를 빈으로 등록한 것이다.

class ConfigurationSingletonTest {
    @Test
    void configurationDeep() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        final AppConfig bean = ac.getBean(AppConfig.class);

        System.out.println("bean = " + bean.getClass());
    }
}

 

 AppConfig@CGLIB의 예상코드는 아래와 같다. @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면, 존재하는 빈을 반환하고, 없으면 기존 로직을 호출해서 스프링 컨테이너에 등록 후, 반환하는 코드가 동적으로 만들어진 것이다. 이를 통해 스프링은 싱글톤을 보장할 수 있다.

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

 

7. @Configuration을 빼면 어떻게 될까?

 만약 AppConfig의 @Configuration을 빼면 어떻게 될까? AppConfig의 @Configuration을 주석 처리하고 아래 테스트 코드를 다시 실행해보면, Bean 등록은 이전과 동일하게 되지만 싱글톤이 보장이 되지 않는다는 것을 확인할 수 있다.(memberRepository 메서드가 3번 호출되고 있음)

class ConfigurationSingletonTest {
    @Test
    void configurationDeep() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        final AppConfig bean = ac.getBean(AppConfig.class);

        System.out.println("bean = " + bean.getClass());
    }
}

 

 따라서 스프링 설정 정보에 대한 클래스에는 @Configuration를 사용하도록 한다.