[Spring] 싱글톤 컨테이너 - 스프링 컨테이너가 필요한 이유

웹 애플리케이션과 싱글톤

웹 애플이케이션은 보통 여러 고객이 동시에 요청을 한다.
우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다
객체를 새로 생성한다.

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

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;

public class SingletonTest {
	@Test
	@DisplayName("스프링 없는 순수한 DI 컨테이너") void pureContainer() {
	AppConfig appConfig = new AppConfig();
    
    void pureContainer() {
		//1. 조회: 호출할 때 마다 객체를 생성
		MemberService memberService1 = appConfig.memberService();
	
    	//2. 조회: 호출할 때 마다 객체를 생성
		MemberService memberService2 = appConfig.memberService();
	
    	//참조값이 다른 것을 확인
		System.out.println("memberService1 = " + memberService1);
    	System.out.println("memberService2 = " + memberService2);
    
    	//memberService1 != memberService2
    	assertThat(memberService1).isNotSameAs(memberService2);
    }
}

고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다!
즉, 메모리 낭비가 심하다.
해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다.

즉, 싱글톤 패턴이 필요하다.

싱글톤 패턴

클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.

private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

싱글톤 예제

package hello.core.singleton;

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으로 new 키워드를 막아두었다.
호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용") public void singletonServiceTest() {
//private으로 생성자를 막아두었다. 컴파일 오류가 발생한다. 
//new SingletonService();

//1. 조회: 호출할 때 마다 같은 객체를 반환
SingletonService singletonService1 = SingletonService.getInstance(); 

//2. 조회: 호출할 때 마다 같은 객체를 반환
SingletonService singletonService2 = SingletonService.getInstance();

//참조값이 같은 것을 확인
System.out.println("singletonService1 = " + singletonService1); 
System.out.println("singletonService2 = " + singletonService2);

// singletonService1 == singletonService2, 같은 인스턴스 반환
assertThat(singletonService1).isSameAs(singletonService2);
singletonService1.logic();
}

싱글톤 패턴 문제점

싱글톤 패턴을 적용하면 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라,
이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.

하지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있다.

싱글톤 패턴 문제점

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

결론적으로 유연성이 떨어진다.
안티패턴으로 불리기도 한다.

싱글톤 컨테이너

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

스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
이전 글에서 설명한 컨테이너(AppConfig) 생성 과정을 자세히 보자.

컨테이너(AppConfig)는 객체를 하나만 생성해서 관리한다.

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

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

이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서
객체를 싱글톤으로 유지할 수 있다.

싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
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)로 설계해야 한다.
• 특정 클라이언트에 의존적인 필드가 있으면 안된다.
• 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다!
• 가급적 읽기만 가능해야 한다.
• 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

@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() 를 호출한다.

결과적으로 각각 다른 2개의 MemoryMemberRepository 인스턴스 가 생성되면서
싱글톤이 깨지는 것 처럼 보인다.

그러나 실제로 테스트 해보면 1개의 인스턴스만 생성된다.

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

스프링 컨테이너는 싱글톤 레지스트리다.
따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.
그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다.
저 자바 코드를 보면 분명 3번 호출되어야 하는 것이 맞다.

그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.
모든 비밀은 @Configuration 을 적용한 AppConfig 에 있다.

@Configuration 을 붙인 설정 파일을 실행해서
등록된 스프링 빈을 출력해보면 클래스 정보가 원본 값이랑 다르게
xxxCGLIB 가 붙으면서 상당히 복잡해진 클래스명이 나온다.

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

원본 클래스라면 다음과 같이 출력되어야 한다.

bean = class hello.core.AppConfig

내부 동작

스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서
AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고,
그 다른 클래스를 스프링 빈으로 등록했기 때문이다.

만약 @Configuration 을 적용하지 않고 @Bean 만 적용하면
AppConfig 가 CGLIB 라이브러리 없이 순수한 AppConfig 클래스로
스프링 빈에 등록된다.

bean = class hello.core.AppConfig