[Spring Boot] 싱글톤 컨테이너

1. 웹 애플리케이션과 싱글톤
2. 싱글톤 패턴
3. 싱글톤 컨테이너
4. 싱글톤 방식의 주의점
5. @Configuration과 싱글톤
6. @Configuration과 바이트코드 조작의 마법

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

웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

    public MemberService memberService() { return new MemberServiceImpl(memberRepository()); }

클라이언트A가 memberService를 요청하면 memberService를 호출해 MemberServiceImpl 객체를 반환한다.
클라이언트B가 memberService를 요청하면 memberService를 호출해 MemberServiceImpl 객체를 반환한다.
클라이언트C가 memberService를 요청하면 memberService를 호출해 MemberServiceImpl 객체를 반환한다.

고객이 3번을 요청하면, 객체가 3번이 생성되는걸까?

스프링 없는 순수한 DI 컨테이너 테스트를 진행해보자.

	@Test
    @DisplayName("스프링 없는 순수한 DI 컨테이너")
    void pureContainer() {
        AppConfig appConfig = new AppConfig();
        //1. 조회: 호출할 때 마다 객체를 생성
        MemberService memberService1 = appConfig.memberService();

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

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

출력된 결과를 보면 서로 다른 참조값을 가지고 있다.
한마디로, 우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다 객체를 새로 생성하는 것이다.

이 경우, 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸되어 메모리 낭비가 심하다.
해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하는 것이다.
이것이 싱글톤 패턴이다.

2. 싱글톤 패턴

클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.

싱글톤 패턴은 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막는다.

싱글톤 패턴을 구현하는 방법에는 여러가지가 있다. 그 중 객체를 미리 생성해주는 방법을 살펴보겠다.

1. static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다.
   이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아서 혹시라도 외부에서
   new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

public class SingletonService {

    //1. static 영역에 객체를 딱 1개만 생성해둔다.
    private static final SingletonService instance = new SingletonService();
    
    //2. public으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 허용한다.
    public static SingletonService getInstance() {
        return instance;
    }

    //3. 생성자를 private으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {
    }
    
}

테스트 결과 private access로 컴파일 오류가 발생했다.
이번에는 getInstance()를 통해 인스턴스를 조회해보자.

위에서 스프링 없는 순수한 DI 컨테이너는 서로 다른 참조값을 가지고 있었다.
하지만, 싱글톤 패턴을 적용한 결과 참조값이 같게 출력됐다.
싱글톤 패턴은 이미 생성된 인스턴스를 가져다 쓰는 것이다. 그러므로 같은 객체의 인스턴스가 반환된다.

싱글톤 패턴을 적용하면 고객의 요청이 올 때 마다 객체를 생성하지 않고, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.

물론, 싱글톤 패턴은 수많은 문제점 또한 가지고 있다.

▶ 싱글톤 패턴 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다. → DIP를 위반한다.
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
• 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어진다.
• 안티패턴으로 불리기도 한다.

3. 싱글톤 컨테이너

스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 객체를 하나만 생성해서 관리한다.
스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.

이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

• 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
• DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다.

스프링 컨테이너를 사용해서 싱글톤 패턴을 적용해보자.

    @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);

출력된 결과를 보면, 참조값이 같다.
위에서 스프링 없는 순수한 DI 컨테이너에서는 서로 다른 참조값이 출력됐었다.

지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.
스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다.

4. 싱글톤 방식의 주의점

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

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

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

상태를 유지한다는 것이 무슨 뜻일까?
간단한 예제를 살펴보자.

    private int price; // 상태를 유지하는 필드

    public void order(String name, int price) {
        System.out.println("name = " + name + "price = " + price);
        this.price = price; //여기가 문제!
    }

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

        //ThreadA: A사용자 10000원 주문
        statefulService1.order("UserA", 10000);

        //ThreadB: B사용자 20000원 주문
        statefulService2.order("UserB", 20000);

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

사용자A가 10000원을 주문하고, 그 다음 바로 사용자B가 20000원을 주문했다.
사용자A가 주문 금액을 조회했을 때, 우리는 10000원을 기대했지만 결과는 20000원이 출력됐다.

싱글톤 패턴은 같은 객체 인스턴스를 공유하기 때문에 사용자A가 주문 금액을 조회하기 전에 사용자B가 20000원으로 가격을 바꿔버려 20000원이 출력된 것이다.

이러한 문제를 해결하기 위해 무상태(stateless)로 설계해야 한다.

    public int order(String name, int price) {
        System.out.println("name = " + name + "price = " + price);
//        this.price = price; //여기가 문제!
        return price;
    }

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

        //ThreadA: A사용자 10000원 주문
        int userAprice = statefulService1.order("UserA", 10000);

        //ThreadB: B사용자 20000원 주문
        int userBprice = statefulService2.order("UserB", 20000);

        //ThreadA: 사용자A 주문 금액 조회
//        int price = statefulService1.getPrice();
        System.out.println("price = " + userAprice);

UserA의 주문 금액이 10000원으로 정확하게 출력됐다.

5. @Configuration과 싱글톤

다음 AppConfig 코드를 보자.

@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

• @Bean memberService -> new MemoryMemberRepository()
  memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다.
  이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.

• @Bean orderService -> new MemoryMemberRepository()
  orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다.
  이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
  
  

결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것 처럼 보인다.
확인해보면, MemoryMemberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository호출해서 다른 인스턴스가 생성되어야 하는데 어떻게 된걸까?

AppConfig에 호출 로그를 남겨 확인해보자.

출력 결과 메서드는 1번 씩만 호출되었다.

스프링이 싱글톤을 보장해준 것이다.
모든 비밀은 @Configuration 을 적용한 AppConfig 에 있다.

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

스프링 컨테이너는 싱글톤 레지스트리다. 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.
이를위해 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

위에서의 자바 코드를 보면 분명 3번 호출되어야 하는 것이 맞다.
하지만, 확인한 결과 1번 씩만 호출되었다.

바로 @Configuration을 적용했기 때문이다.

간단한 테스트를 해보자.

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

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

   }

AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록된다.
그래서 AppConfig 도 스프링 빈이 된다.

AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보았다.

결과가 이상하다. 순수한 클래스라면 다음과 같이 출력되어야 한다.

$$뒤에 붙은 '~~CGLIB'는 무엇일까?

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

임의의 다른 클래스가 바로 싱글톤이 되도록 보장해준다.
(실제로 CGLIB의 내부 기술은 매우 복잡하다.)

@Configuration 이 없으면, @Bean을 사용해도 싱글톤을 보장해주지 못한다.

그렇기 때문에 스프링 설정 정보는 항상 @Configuration 을 사용해야 한다.

Ref.
스프링 핵심원리(김영한)