싱글톤 컨테이너

웹 애플리케이션과 싱글톤

• 스프링은 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
• 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 물론 웹이 아닌 애플리케이션 개발도 얼마든지 개발할 수 있다.
• 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

직접 만들었던 DI 컨테이너는 요청을 할 때마다 새로운 인스턴스를 만들어 반환한다.

public class SingletonTest {

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

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

    System.out.println("memberService1 = " + memberService1);
    System.out.println("memberService2 = " + memberService2);
    
    //결과
    //memberService1 = hello.core.member.MemberServiceImpl@b2c9a9c
    //memberService2 = hello.core.member.MemberServiceImpl@4c178a76

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

스프링 없는 순수한 DI컨테이너로 테스트하면, 두 인스턴스의 참조값이 다르다는 것을 알 수 있다.

memberService에서는 또 저장소 인스턴스를 만드니 총 4개가 생성되는 것이다. 그럼 요청이 올 때마다 JVM메모리에 계속 객체가 쌓여 메모리 낭비가 심하다.

객체가 딱 하나만 생성되고 공유되도록 설계하면 된다. => 싱글톤 패턴

 

싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
• 그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
  private 생성자를 사용해서 외부에서 임의로 new키워드를 사용하지 못하도록 막아야 한다.

package hello.core.singleton;
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() {
     }
     
     public void logic() {
     System.out.println("싱글톤 객체 로직 호출");
     }
}

1. static 영역에 객체 인스턴스를 미리 하나 생성해서 올려둔다.

2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스가 반환된다.

3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아서 혹시라도 외부에서 new키워드로 객체 인스턴스를 만드는 것을 막는다.

public class SingletonTest {

  @Test
  @DisplayName("싱글턴 패턴을 적용한 객체 사용")
  void singletonServiceTest() {
    SingletonService singletonService1 = SingletonService.getInstance();
    SingletonService singletonService2 = SingletonService.getInstance();

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

    // same과 equal은 다르다.
    // same는 == 비교, equal은 equals() 비교와 같다.
    assertThat(singletonService1).isSameAs(singletonService2);
  }
}

싱글톤 패턴을 사용하는 테스트 코드로 호출할 때마다 같은 객체를 반환하는 것을 확인할 수 있다.

* 싱글턴 패턴의 구현 방법은 여러 가지가 있다. 여기서는 객체를 미리 생성해두는 가장 단순하고 안전한 방법을 선택했다.

 

싱글톤 패턴의 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
  예) private static 변수 선언, getInstance(), 생성자 등
• 의존관계상 클라이언트가 구체 클래스에 의존한다. -> DIP, OCP 위반
  예) 구체클래스.getInstance()방식으로 가져와야 하기 때문에
• 유연하게 테스트하기 어렵다
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어지며 안티패턴으로 불리기도 한다.

 

싱글톤 컨테이너

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

스프링 빈은 싱글톤으로 관리되는 빈이다.

• 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
  위의 그림처럼 컨테이너는 객체를 하나만 생성하여 관리한다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다.
  이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하며 객체를 싱글톤으로 유지할 수 있다.

public class SingletonTest {

  @Test
  @DisplayName("스프링 컨테이너와 싱글턴")
  void springContainer() {
    AnnotationConfigApplicationContext 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);
    
    //memberService1 = hello.core.member.MemberServiceImpl@65fe9e33
    //memberService2 = hello.core.member.MemberServiceImpl@65fe9e33

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

지저분한 코드 없이도 싱글톤으로 관리되는 것을 확인할 수 있다.

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

*참고로 스프링은 싱글톤만 지원하는게 아니다.

 

싱글톤 방식의 주의점

• 싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 객체 인스턴스를 공유한다. 
  그렇기 때문에 싱글톤 객체는 상태유지(stateful)하게 설계하면 안 된다.
• 무상태(stateless)로 설계해야 한다.
  - 특정 클라이언트에 의존적인 필드가 있으면 안 된다.
  - 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다.
  - 가급적 읽기만 가능해야 한다.
  - 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
• 스프링 빈의 필드에 공유 값을 설정하면 정말로 큰 장애가 발생할 수 있다!!(허걱!)

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;
  }

  @Test
  void statefulServiceSingleton() {
    AnnotationConfigApplicationContext ac =
        new AnnotationConfigApplicationContext(TestConfig.class);

    StatefulService statefulService1 = ac.getBean(StatefulService.class);
    StatefulService statefulService2 = ac.getBean(StatefulService.class);

    statefulService1.order("userA", 10000); // ThreadA: A 사용자 10000원 주문
    
    statefulService2.order("userB", 20000); // ThreadB: B 사용자 20000원 주문

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

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

  static class TestConfig {

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

테스트 코드를 작성해 보자!

ac.getBean()으로 StatefulService를 불러와 각각 정보를 입력했다.

위의 코드에서 "userA"에 해당하는 사용자는 10000원을 주문했는데 값이 20000이 나와버렸다.

같은 인스턴스이기 때문에 값이 바뀐 것이다.

 

이렇게 바꿔보자!

public class StatefulService {

  // price 변수를 삭제한다.

  public int order(String name, int price) {
    System.out.println("name = " + name + ", price = " + price);

    // 리턴한다.
    return price;
  }

  @Test
  void statefulServiceSingleton() {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(
            TestConfig.class);

    StatefulService statefulService1 = ac.getBean(StatefulService.class);
    StatefulService statefulService2 = ac.getBean(StatefulService.class);

    // 반환한 price를 사용한다.
    int price1 = statefulService1.order("userA", 10000);
    int price2 = statefulService2.order("userB", 20000);

    System.out.println("price1 = " + price1);
    System.out.println("price2 = " + price2);
  }
}

반환한 값을 지역변수인 int price1, int price2에 넣어 결과를 확인하면 맞는 결과가 나온다.

이처럼 스프링 빈은 항상 무상태(stateless)로 설계해야 한다.

 

@Configuration과 싱글톤

@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
  public DiscountPolicy discountPolicy() {
    return new RateDiscountPolicy();
  }

}

AppConfig 클래스를 보면

1. memberService빈을 만들 때 memberRepository()를 호출한다.

-> memberRepository()를 호출하면 new MemoryMemberRepository()를 호출한다.

2. orderService 빈을 만들 때 얘도 memberRepository()를 호출하고 마찬가지로 new MemoryMemberRepository()를 호출한다.

 

결과적으로 new MemoryMemberRepository()가 2번 호출되면서 각각 2개가 생기는 것처럼 보인다.(싱글톤이 깨진다)

테스트를 해보자!

public class MemberServiceImpl implements MemberService {

  private final MemberRepository memberRepository;

  // 테스트 용도
  public MemberRepository getMemberRepository() {
    return memberRepository;
  }
}

public class OrderServiceImpl implements OrderService {

  private final MemberRepository memberRepository;

  // 테스트 용도
  public MemberRepository getMemberRepository() {
    return memberRepository;
  }
}

테스트를 위해 MemberRepository를 조회할 수 있는 기능을 추가한다.

public class ConfigurationSingletonTest {

  @Test
  void configurationTest() {
    AnnotationConfigApplicationContext 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);

    MemberRepository memberRepository1 = memberService.getMemberRepository();
    MemberRepository memberRepository2 = orderService.getMemberRepository();

    System.out.println("memberRepository1 = " + memberRepository1);
    System.out.println("memberRepository2 = " + memberRepository2);
    System.out.println("memberRepository = " + memberRepository);

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

}

테스트를 해보면 같은 참조값이 나온다. new로 호출이 두 번 되었지만 하나만 생성되어 공유되고 있었다.

 

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

스프링 컨테이너는 싱글톤 객체를 생성하고 관리하는 싱글턴 레지스트리다.

public class ConfigurationSingletonTest {

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

    // config로 넘긴 클래스도 스프링 빈으로 등록이 된다.
    AppConfig bean = ac.getBean(AppConfig.class);

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

}

스프링 빈 AppConfig의 클래스 정보를 출력하면 위처럼 나온다.

순수한 클래스라면 class hello.core.AppConfig라고 나와야 할 텐데 뒤에 이상한 글자들이 더 붙어있다.

스프링이 CGLIB라는 바이트 코드 조작 라이브러리를 이용해서 AppConfig 클래스를 상속한 임의의 다른 클래스를 만들어 스프링 빈으로 등록한 것이다.

@Configuration이 붙은 설정 정보에서 @Bean이 붙은 메서드마다 스프링 빈이 있는지 확인하고 있으면 반환, 없으면 새로 생성하는 과정을 거쳐 코드가 생성된다. 이 방식으로 싱글톤이 보장되는 것이다.

 

@Configuration을 적용하지 않는다면!?!?!?

@Configuration을 붙이면 바이트 코드 조작 라이브러리인 CGLIB 기술로 싱글톤이 보장된다.

하지만 @Bean만 적용한다면 어떤 일이 일어날까?

순수한 AppConfig로 스프링 빈에 등록된 것을 알 수 있고 호출시마다 각각 다른 인스턴스로 생성된다.

@Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤은 보장되지 않는다. 그렇기 때문에 CGLIB를 통해 있는 것만 반환하고 없으면 새로 생성해 주는 게 아닌 호출할 때마다 new MemoryMemberRepository()로 가져오는 것과 같다.