Spring - 싱글톤 컨테이너

 

싱글톤 컨테이너

 웹 어플리케이션은 싱글톤을 사용한다. 그 이유는 웹 어플리케이션을 이용하는 사람은 1명이 아닌 여러 사람이 동시 다발적으로 이용한다. 때문에 싱글톤을 사용하지 않으면 n명의 고객이 웹 요청시 n개의 인스턴스를 만들어 메모리 낭비가 심해지기 때문이다.  

 

싱글톤 사용 x - 3명의 고객이 요청했을시 똑같은 인스턴스 객체를 3개 생성하는 모습

싱글톤 사용 o - 3명의 고객이 요청했을시 해당 인스턴스를 공유하영 사용하는 모습

 

 

 이제 순수 DI 컨테이너부터 만들어가며 왜 싱글톤 컨테이너가 필요한지 알아보자.

---

 

순수 DI 컨테이너

 

 앞에 블로깅한 코드에서 스프링 컨테이너를 사용하지 않으면 어떻게 될까? 테스트를 해보자.

 

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

        Assertions.assertThat(memberService1).isNotEqualTo(memberService2);
    }

실행 화면

 

 실행 화면을 memberService() 호출을 할 때마다 MemberServiceImpl 인스턴스가 새로 만들어진 것을 볼 수 있다. 이렇게 스프링 컨테이너를 사용하지 않고 순수 DI 컨테이너를 이용하게 되면 고객이 요청할 때마다 인스턴스가 생성되어 메모리 낭비가 심해진다. 따라서 이를 해결하기 위해선 해당 인스턴스가 딱 1개만 생성되고, 공유하도록 설계하는 싱글톤 패턴을 사용하면 해당 문제가 해결할 수 있다.

 

---

 

싱글톤 패턴

• 해당 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴
• static 영역에 인스턴스를 미리 하나 생성하여 공유
• 공유하는 static 인스턴스를 getInstance() 메서드를 이용하여 사용
• 1개의 인스턴스만 존재해야 하므로 생성자를 private로 막아서 외부에서 클래스 인스턴스를 생성하지
  못하도록 막는다.

 

 간단한 싱글톤 패턴을 적용한 클래스를 만들어 2번 호출하는 테스트를 만들어보자.

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

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

    }
    public void logic(){
        System.out.println("싱글톤 객체 로직 호출");
   }

}

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

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

        Assertions.assertThat(singletonService1).isEqualTo(singletonService2);

    }

실행 화면

 실행 화면을 보면 같은 인스턴스를 반환하는 것을 볼 수 있다. static 영역에 해당 인스턴스를 만들어 놓고 필요할 때마다 getInstance() 메서드를 통해 해당 인스턴스를 가져오기 때문에 싱글톤 패턴에 만족하게 되었다.

 

 싱글톤 패턴의 문제점

 

• 싱글톤 패턴을 구현하는 코드를 작성해야 되므로 코드의 길이가 길어진다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다 -> DIP를 위반
  위에 간단한 싱글톤 패턴 클래스를 보면 new SingletonService()로 구현객체에 의존하는 것을 볼 수 있다.
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 있다.
• 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화하기 어렵다.
• 유연성이 떨어진다.

---

 

싱글톤 컨테이너

 

• 위 싱글톤 패턴의 문제점을 해결하면서 인스턴스를 싱글톤으로 관리
• 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다.
• 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

 스프링 컨테이너를 사용한 간단한 테스트 코드를 보자.

 

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

        Assertions.assertThat(memberService1).isEqualTo(memberService2);
    }

실행 화면

 위 코드를 보면 Appconfig 클래스를 스프링 컨테이너에 등록을 해준 것을 볼 수 있다. 스프링 컨테이너는 해당 클래스를 싱글톤으로 컨테이너에 등록해주기 때문에 getBean 메서드를 통해 해당 빈을 여러번 꺼내와도 이미 만들어진 인스턴스를 꺼내와서 같은 인스턴스를 반환하는 것을 볼 수 있다.

 

 싱글톤 방식의 주의점

 

• 싱글톤 방식은 여러 클라이언트가 하나의 인스턴스를 공유하기 때문에 무상태로 설계해야 한다.
  - 특정 클라이언트에 의존적인 필드가 있으면 안 된다.
  - 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다.
  - 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, 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;
    }
}

 

 위와 같은 코드는 문제가 있다. 싱글톤 패턴이 적용된 클래스이므로 price 필드는 공유하게 된다. 클라이언트A가 order("userA", 10000)으로 주문하고 클라이언트B가 바로 order("userB", 20000) 으로 주문했다고 가정해보자. 어떤 문제가 발생하는가? 바로 상태를 유지하는 price 필드 때문에 문제가 발생한다. 클라이언트A가 getPrice() 메서드를 호출하게 되면 기대했던 10000원이 아닌 클라이언트B 때문에 20000원이 나오게 된다.

 

 나는 10000원짜리 상품을 주문했는데 결제에서 20000원이 되는 일이 발생하는 문제가 실제 실무에서 벌어진다면 어마어마한 문제가 된다. 때문에 싱글톤을 사용할 때는 공유 필드를 조심해야 한다. 항상 무상태로 설계하자

---

 

@Configuration과 바이트코드 조작

 

 이전 블로깅에서 작성했던 AppConfig의 코드를 보자.

 

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

 코드를 보면 memberService Bean을 만드는 코드에서 memberRepository()를 호출하고 roderService Bean을 만드는 코드도 memberRepository()를 호출하여 2번의 new MemoryMemberRepository()를 호출하게 된다. 그러면 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것이 아닌가 생각이 들것이다. 하지만 이러한 문제는 스프링 컨테이너가 해결해주고 있다.

 

 

바이트코드 조작을 이용한 해결

 

 위와 같은 문제를 스프링 컨테이너는 @Configuration을 적용하여 해결한다.

 

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

        AppConfig bean = ac.getBean(AppConfig.class);
        AppConfig instanceAppConfig = new AppConfig();

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

 

 이상하지 않은가? 스프링 빈으로 등록된 AppConfig를 조회하여 해당 클래스 정보를 출력하면

class hello.core.AppConfig가 아닌 뒤에 다른 값이 붙으면서 복잡하게 출력된 것을 볼 수 있다.

 

 위 결과로 우리는 스프링 컨테이너가 @Configuration을 적용한 내가 만든 클래스를 스프링 빈에 등록하는 것이 아닌 CGLIB라는 바이트코드 조작 라이브러리를 사용하여 AppConfig 클래스를 상속받는 임의의 다른 클래스를 생성하고, 생성한 클래스를 스프링 빈으로 등록했다는 것을 알 수 있다. 이와 같은 바이트코드 조작으로 스프링 컨테이너에 등록된 Bean들을 싱글톤으로 관리할 수 있게 된다.

 

 

 따라서 만약 @Configuration을 적용해 주지 않으면 @Bean을 통해 스프링 빈으로 등록은 되지만 싱글톤이 보장되지 않는다.