[Spring] 스프링의 Singleton Container

저번 포스팅에서 Spring Container에 대해서 설명하였습니다.

이번 시간에는 Spring 컨테이너가 기본적으로 Singleton Container로 구성되어 있는데, 왜 singleton으로 구성되어 있는지와, singleton 방식의 주의점 등을 알아보겠습니다.

웹 애플리케이션과 Singleton

스프링은 기본적으로 기업용 온라인 서비스 기술을 지원하기 위해 탄생하였습니다. 그리고 대부분의 스프링 Application은 Web Application입니다. 물론 웹이 아닌 앱 개발도 얼마든지 개발할 수 있습니다.

보통 여기서 문제점이 발생하는데, 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 진행하는 문제점이 발생합니다.

스프링이 없는 순수 AppConfig

과거 포스팅에서 Spring이 없이 작성했던 AppConfig는 순수 DI 컨테이너로써, 요청을 받을 때마다 객체를 새로 생성합니다. 이런 경우 고객 트래픽이 많으면 많을수록 어마무시한 객체가 생성되고 소멸됨으로써, 메모리 낭비가 심해집니다.

따라서 이것의 해결 방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 됩니다.

@Test
@DisplayName("스프링 없는 순수한 DI 컨테이너")
void pureContainer() {
    AppConfig appConfig = new AppConfig();
    // 1. 조회 : 호출할 때 마다 객체를 생성
    MemberService memberService1 = appConfig.memberService();

    // 2. 조회 : 호출할 때 마다 객체를 생성
    MemberService memberService2 = appConfig.memberService();

    // 참조값이 다른 걸 확인
    // 이렇게 되면 조회시마다 계속 객체가 생성된다.
    System.out.println("memberService1 = " + memberService1);
    System.out.println("memberService2 = " + memberService2);

Test 실행 결과 다르다.

따라서 이것의 해결 방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 됩니다.

이것은 싱글톤 패턴을 적용하면 가능합니다.

싱글톤 패턴

• 클래스의 인스턴스가 딱 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("싱글톤 객체 로직 호출");
	}
}

싱글톤 패턴을 통해서 고객의 요청이 올 때 마다 객체를 생성하는 것이 아닌, 이미 만들어진 객체를 공유해서 메모리 상 효율적으로 사용할 수 있습니다. 하지만 그런 싱글톤 패턴에도 문제점이 존재합니다.

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
  • Private를 써서 생성자를 막아버리고.. getter를 또 작성해야되고.. 굉장히 귀찮습니다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다. DIP를 위반한다.
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
• 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어진다.
• 안티패턴으로 불리기도 한다.

Spring의 싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤으로 관리해줍니다.

스프링 빈도 마찬가지로 바로 싱글톤으로 관리되는 빈입니다.

• 스프링 컨테이너는 싱글턴 패턴으로 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리합니다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 합니다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 합니다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있게 해줍니다.
  • 싱글톤 패턴을 위한 코드가 들어가지 않아도 됩니다.
  • DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있게 됩니다.
• 스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있습니다.

Spring Container

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

싱글톤 방식의 주의점

싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(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;
    }
}

class StatefulServiceTest {

    @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("userD", 20000);

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

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

아래 test를 확인해 봤을때, 사용자 A가 주문 조회를 했을 때 10000원이 나와야 하지만, 20000원이라는 결과가 나왔습니다. StatufulService의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경할 수 있습니다.

A가 먼저 주문을 하였지만, B가 주문을 하면서 price가 바뀌고, 그것을 A가 확인합니다.

따라서 사용자 A는 10000원을 주문했지만, 20000원으로 금액이 조회되는 것입니다.

@Configuration과 싱글톤

AppConfig를 다시 보면, 특이한 점이 존재합니다.

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

• memberService 빈을 만드는 코드를 보면 memberRepository()를 호출한다.
  • 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.
• orderService 빈을 만드는 코드도 동일하게 memberRepository()를 호출한다.
  • 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.

결과적으로 각각 다른 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것 처럼 보이지만, 실제로는 그렇지 않습니다.

@Configuration이 적용된 AppConfig

스프링 컨테이너는 싱글톤 레지스트리입니다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 합니다.

스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용합니다.

사실 @Configuration을 적용한 AppConfig를 살펴보면

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

        // bean = class hello.core.AppConfig$$SpringCGLIB$$0
        System.out.println("bean = " + bean.getClass());
    }

결과 : bean = class hello.core.AppConfig$$SpringCGLIB$$0

AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록됩니다. 따라서 AppConfig도 스프링 빈이 됩니다. AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보면 특이한 용어들이 추가되어 있습니다.

클래스 명에 CGLIB가 붙으면서 상당히 복잡해진 것을 알 수 있는데, 스프링이 CGLIB라는 바이트 코드 조작 라이브러리를 사용하여 AppConfig 클래스를 상속받은 임의의 다른 클래스르 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것입니다.

이러한 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해줍니다.

내부 기술이 어떻게 되어있는지는 모르겠지만.. 아마 이런식으로 추정해 볼 수 있을 것 같습니다.

,

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

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

만약 @Configuration을 적용하지 않고, @Bean만 적용하면 어떻게 될까요??

bean = class hello.core.AppConfig

call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
call AppConfig.memberRepository

출력 결과를 통해 총 3번의 MemberRepository가 호출된 것을 알 수 있습니다. 1번은 @Bean에 의해서 등록되었고, 2번은 메서드 호출하면서 발생한 코드입니다.

또한 각각의 인스턴스가 같지 않음도 확인할 수 있습니다.

memberService -> memberRepository =
hello.core.member.MemoryMemberRepository@6239aba6
orderService -> memberRepository =
hello.core.member.MemoryMemberRepository@3e6104fc
memberRepository = hello.core.member.MemoryMemberRepository@12359a82

 

정리하자면, @Configuration을 통해서 싱글톤을 보장하는 것을 알 수 있습니다.