싱글톤 컨테이너 (Singleton Container)

웹 애플리케이션과 싱글톤

- 대부분의 스프링 애플리케이션은 웹 애플리케이션이다.

- 웹 애플리케이션은 보통 여러 고객이 동시에 요청

 

- 스프링 없는 순수한 DI 컨테이너로 테스트해보면 memberService에 대한 객체가 각각 다르다는 것을 확인할 수 있다.

- 요청할 때마다 AppConfig는 객체를 생성하고 메모리 낭비가 심해지는 문제를 야기한다.

 

싱글톤 패턴

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

- 객체 인스턴스 2개 이상 생성하지 못하게 한다

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

- 위를 통해 singletonService 객체를 호출해보면 같은 인스턴스를 반환하는 것을 알 수 있다.

 

싱글톤 패턴 문제점

- 코드가 많이 들어간다.

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

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

- 테스트하기 어렵다, private 생성자로 자식 클래스 생성이 어렵다.

 

싱글톤 컨테이너

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

- 스프링 컨테이너가 싱글톤 컨테이너 역할을 한다.

- 스프링의 이런 기능이 싱글톤 패턴의 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

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

- 스프링 컨테이너를 사용한 싱글톤 코드

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

 

싱글톤 방식의 주의점

- 여러 클라이언트가 하나의 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안 된다.

- 무상태(stateless)로 설계해야 한다.-> 안 그러면 실무에서 심각한 장애나 문제가 발생할 수 있다.

• 특정 클라이언트에 의존적인 필드가 있으면 안된다.
• 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
• 가급적 읽기만 가능해야 한다. (static, final)
• 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터 등을 사용해야 한다.

@Test
void statefulServiceSingleton() {
      ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
      
      StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
      
      StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);
      //ThreadA: A사용자 10000원 주문
      statefulService1.order("userA", 10000);
      //ThreadB: B사용자 20000원 주문
      statefulService2.order("userB", 20000);
      
      //ThreadA: 사용자A 주문 금액 조회
      int price = statefulService1.getPrice();
      
      //ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
      System.out.println("price = " + price);
      Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}

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

- 위 테스트 코드를 보면 userA는 10000원의 주문 금액을 userB는 20000원의 주문 금액이 있다.

- Stateful하게 관리된 상태에서 userA의 주문 금액을 조회하면 20000원이 출력된다.

 

@Configuration과 싱글톤

@Configuration
public class AppConfig {

      @Bean
      public MemberService memberService() {
          return new MemberServiceImpl(memberRepository());
      }
      
      @Bean
      public OrderService orderService() {
          return new OrderServiceImpl(memberRepository(), discountPolicy());
      }
      
      @Bean
      public MemberRepository memberRepository() {
          return new MemoryMemberRepository();
      }

      @Bean
      public DiscountPolicy discountPolicy() {
          //return new FixDiscountPolicy();
          return new RateDiscountPolicy();
      }
}

- memberService 빈 --> memberRepository() --> MemoryMemberRepository()

- orderService 빈 --> memberRepository() --> MemoryMemberRepository()

2개의 MemoryMemberRepository 생성, 싱글톤 패턴을 안 지키는 것처럼 보인다

 

- 테스트 코드 생성해서 검증해보면 같은 인스턴스를 공유하여 사용하고 있다!

- 다시 위에 Appconfig.java에 각 @Bean에 호출 코드(soutm)를 적어본다.

memberRepository 예상 호출은 3번(memberService, orderService, @Bean memberRepository())

 

-> 그러나 1번만 호출한다.

 

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

- memberRepository가 1번만 호출되는 이유의 비밀은 @Configuration

- @Configuration 없으면 3번 호출

@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$$bd479d70
}

bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70

 

- 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 클래스에 빈을 포함시킨 것

 

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

- 아마 CGLIB 예상 코드는 위의 로직과 같은 느낌일 것이다.

- @Bean가 붙은 메소드가 존재하면 빈 반환, 아니면 새롭게 컨테이너에 등록

 

 

출처: 스프링 핵심 기본 원리편