Singleton Container

스프링의 싱글톤 컨테이너에 대해 정리하였습니다.

 

 

---

< 웹 애플리케이션과 싱글톤 >

애플리케이션은 다양한 종류가 있습니다. 온라인 처리, 서버에서 백그라운드로 실행되는 데몬 프로세스, 특정 작업을 일괄적으로 처리하는 배치 애플리케이션 등 여러 형태가 존재합니다. 이 가운데, 스프링 프레임워크는 주로 기업용 온라인 서비스 개발을 지원하기 위해 만들어졌습니다. 물론, 스프링을 활용하면 웹뿐만 아니라 다른 종류의 애플리케이션도 개발할 수 있습니다.

웹 애플리케이션의 경우 일반적으로 여러 사용자가 동시에 요청을 처리하는 상황이 발생하는데, 고객의 요청이 들어올 때마다 뭔가를 계속 만들어내는 경우가 문제가 될 수 있습니다.

 

: 스프링이 없는 환경에서 순수 DI 컨테이너를 이용해 객체를 생성할 경우, 고객의 요청마다 새로운 객체가 생성됩니다.
만약 초당 100건의 요청이 들어온다면, 초당 100개의 객체가 생성되고 제거됩니다. 이는 메모리를 비효율적으로 사용하게 만듭니다.

 

-> 이를 해결하기 위해 인스턴스를 하나만 생성해 이를 전역적으로 공유하는 싱글톤 패턴이 탄생하였습니다.

 

---

< 싱글톤 패턴 >

싱글톤 패턴은 클래스의 인스턴스를 하나만 생성해 이를 전역적으로 공유하는 디자인 패턴입니다.

 

public class SingletonService {
    private static final SingletonService instance = new SingletonService();
    
    public static SingletonService getInstance() {
    	return instance;
    }
    
    private SingletonService() {
    
    }
    
    public void logic() {
    	System.out.println("싱글톤 객체의 로직 호출");
    }
}

• private, static, final 키워드를 이용해 클래스의 유일한 인스턴스를 만듭니다.
• getInstance() 메소드를 이용해 외부에서는 직접적으로 인스턴스를 생성하지 않고, 이 메소드를 통해서만 접근하도록 합니다.
• 생성자를 private으로 선언함으로써 외부 클래스나 다른 코드에서 new 연산자를 사용하여 직접 인스턴스를 생성하는 것을 막습니다.

 

< 참고 >
 이외에도 싱글톤 패턴을 구현하는 방법은 다양합니다.

 

 

---

싱글톤 패턴의 문제점

1. 싱글톤 패턴 구현을 위한 코드가 복잡할 수 있습니다.
2. 클라이언트가 구체클래스에 의존하여 DIP 원칙을 위반합니다.
3. 변경 없이 확장이 어려워 OCP 원칙을 위반합니다.
4. 테스트가 어렵습니다.
5. 내부 속성을 변경하거나 초기화하기 어렵습니다.
6. private 생성자를 사용하기 때문에, 자식클래스를 만들기 어려워 유연성이 떨어집니다.

→ 이러한 이유로 싱글톤 패턴은 안티패턴으로 불리기도 합니다.

 

 

---

< 싱글톤 컨테이너 >

싱글톤 컨테이너는 싱글톤 패턴의 문제점을 해결하면서 객체의 인스턴스를 단일 하나로 관리합니다.

스프링에서 스프링 컨테이너가 싱글톤 컨테이너의 역할을 하며, 스프링 빈이 곧 싱글톤으로 관리되는 객체입니다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 합니다.

 

→ 스프링 컨테이너 덕분에 싱글톤 패턴의 모든 단점을 해결하고 객체를 싱글톤으로 유지할 수 있으며, 복잡한 코드 작성 없이도 DIP, OCP, 테스트, Private 생성자 제약에서 자유롭게 싱글톤을 구현할 수 있습니다.

 

: 스프링 컨테이너를 사용하면 매번 새로운 객체를 생성하지 않고, 이미 생성된 객체를 효율적으로 공유하여 재사용할 수 있습니다.

 

 

< 참고 >
스프링 컨테이너는 기본적으로 싱글톤 패턴을 지원하지만, 싱글톤 방식만 지원하는 것은 아닙니다.

 

 

---

< 싱글톤 방식의 주의점 >

싱글톤 패턴을 사용하든 스프링의 싱글톤 컨테이너를 사용하든, 객체는 여러 클라이언트가 공유하므로 반드시 상태를 가지지 않는(stateless) 방식으로 설계되어야 합니다.

 

즉, 특정 클라이언트에 의존적이거나 클라이언트에 의해 값이 변경 가능한 필드를 가지지 않아야 하며, 가능하면 읽기 전용으로 설계해야 합니다. 스프링 빈의 필드에 공유값을 설정하면 큰 장애가 발생할 수 있습니다.

 

Ex) 문제 상황 예시

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 this.price;
    }
}

@Test
void statefulServiceSingleton(){
    ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
    StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
    StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);

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

    //Thread A: 사용자 A 주문 금액 조회
    int price = statefulService1.getPrice();
    System.out.println("price = " + price); // 20000원으로 나온다.

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

 

 

---

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

• memberService 빈을 만드는 코드는 memberRepository()를 호출합니다.
  → 이 메소드는 new MemoryMemberRepository()를 호출합니다.
• orderService 빈을 만드는 코드는 memberRepository()를 호출합니다.
  → 이 메소드는 new MemoryMemberRepository()를 호출합니다.

이는 결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보입니다. 정말 그런지 확인해보겠습니다.

 

---

검증 1 : MemberRepository 조회

MemberServiceImple.java:

public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository;

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

OrderServiceImpl.java:

public class OrderServiceImpl implements OrderService{
    private final MemberRepository memberRepository;

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

ConfigurationSingletonTest.java:

public class ConfigurationSingletonTest {
    @Test
    void configurationTest() {
        ApplicationContext 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("memberService -> memberRepository = " + memberRepository1);
        System.out.println("orderService -> memberRepository2 = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);

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

결과 :

 

→ 확인해보니 memberRepository는 모두 같은 인스턴스가 공유되어 사용됩니다. 혹시 newMemoryMemberRepository 호출이 2번 되지 않는 것인지 로그를 통해 확인해보겠습니다.

 

 

---

검증 2 : AppConfig에 로그 생성

AppConfig.java:

@Configuration
public class AppConfig {

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

    @Bean
    public MemberRepository memberRepository(){
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }

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

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

→ 우리의 예상대로라면 아래와 같이 memberRepository()가 3번 호출되어야 합니다.

• 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean이 붙어있는 memberRepository() 호출
• memberService() 로직에서 memberRepository() 호출
• orderService() 로직에서 memberRepository() 호출

 

결과 :

→ 그러나 출력 결과 1번만 호출되고 있습니다.

 

이와 같이 스프링이 싱글톤 패턴을 보장할 수 있는 이유는 AppConfig 클래스의 바이트코드를 조작하기 때문입니다.

 

 

---

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

스프링은 CGLIB라는 바이트코드 조작 라이브러리를 사용하여 싱글톤 패턴을 보장해줍니다.

 

앞서 본 것처럼, memberRepository는 3번 호출되어야 하는데 1번만 호출되었습니다. 모든 비밀은 @Configuration을 적용한 AppConfig에 있습니다.

 

 

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

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

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

: 순수한 클래스라면 class hello.core.AppConfig로 출력되어야 하는데 EnhancerBySpringCGLIB라는 것이 추가적으로 붙은 것을 확인할 수 있습니다.

이 이유는 CGLIB를 이용해 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스의 객체가 스프링 빈으로 등록되었기 때문입니다.

 

: AppConfig대신 AppConfig@CGLIB가 빈으로 등록됩니다.

: @Bean 어노테이션이 붙은 메서드는 스프링 컨테이너에 해당 빈이 등록되어 있는지 확인하고, 없을 경우 새로 생성하여 싱글톤 패턴을 보장하는 구조로 동적으로 처리됩니다.

 

< 참고 >
AnnotationConfigApplicationContext에 전달된 파라미터는 스프링 빈으로 등록됩니다. 따라서 `AppConfig` 역시 스프링 빈으로 등록됩니다.

 

 

---

@Configuration을 적용하는 이유가 뭘까?

이를 확인하기 위해 @Configuration annotation을 빼고 생성 및 테스트 해보겠습니다.

 

AppConfig.java:

// @Configuration
public class AppConfig {

}

 

결과 :

검증 1

검증 2

: 위 결과를 통해 `MemberRepository` 메서드가 총 3번 호출되었음을 알 수 있습니다. 첫 번째 호출은 `@Bean`에 의해 스프링 컨테이너에 등록하기 위한 것이고, 나머지 두 번의 호출은 각각 `memberRepository()` 메서드를 직접 호출하면서 발생한 것입니다.

 

→ @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지는 않습니다. 따라서 스프링 설정 정보는 항상 @Configuration을 사용하여야 합니다.