스프링 핵심 원리 - 기본편 [싱글톤 컨테이너]

웹 어플리케이션과 싱글톤

스프링은 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
웹 어플리케이션은 보통 여러 고객이 동시에 요청을 한다.
Singleton이 적용되지 않은 컨테이너는 요청마다 새로운 인스턴스를 생성한다.
예를 들어 고객 트래픽이 초당 100이라고 가정한다면 100개의 객체가 생성되고 소멸한다. (메모리 낭비가 심하다.)
해결 방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. -> 싱글톤 패턴

스프링 없는 순수한 DI 컨테이너 테스트 코드

 

싱글톤 패턴

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

package hello.core.singleton;

public class SingletonService {

    // 1. static 영역에 객체르 딱 1개만 생성해둔다.
    public 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("싱글톤 객체 호출");
    }
    
}

싱글톤 패턴을 사용하는 테스트 코드

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

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

        assertThat(singletonService1).isSameAs(singletonService2);
    }

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

싱글톤 패턴의 문제점

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

 

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다.
지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

싱글톤 컨테이너

• 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하며 객체를 싱글톤으로 유지할 수 있다.
  • 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
  • DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다.

 

스프링 컨테이너를 사용하는 테스트 코드

 

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

스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공한다. 자세한 내용은 뒤에 빈 스코프에서 알아보자.

 

싱글톤 방식의 주의점

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

싱글톤과 상태 유지 문제점 코드

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

• ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.
• StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.
• 진짜 공유필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자.

 

@Configuration과 싱글톤

@Configuration
public class AppConfig {

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

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

memberService(), orderService() 메서드 모두 new MemoryRepository()를 호출하는데 싱글톤이 깨지지 않을까?

https://github.com/devjun63/springcore/commit/1bf41ae5945f624b743deadd2ece80257dab0e6e

싱글톤은 깨지지 않는다.

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

 

Appconfig를 빈으로 등록하여 클래스 정보를 출력하면 다음과 같다.

스프링은 CGLIB라는 바이트조작 라이브러리를 사용해서

AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한다.

 

AppConfig@CGLIB 예상 코드

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

• @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
• 덕분에 싱글톤이 보장된다.

참고 : AppConfig@CGLIB는 AppConfig의 자식 타입이므로, AppConfig 타입으로 조회 할 수 있다.

@Configuration이 없다면 CGLIB 기술없이 순수한 AppConfig로 스프링 빈에 등록된다.

즉 싱글톤을 보장하지 않고 각기 다른 인스턴스를 생성한다.

https://github.com/devjun63/springcore/commit/136af27fc63b447949365864b09be982bb7bff17

정리

• @Bean만 사용해도 스프링 빈으로 등록되나, 싱글톤은 보장하지 않는다.
  • memberRepository()처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.
• 스프링 설정 정보는 항상 @Configuration을 사용하자.