[Spring] 싱글톤 컨테이너

안녕하세요! 이번 포스팅은 싱글톤 컨테이너에 대해 알아보겠습니다!

 

웹 애플리케이션과 싱글톤

스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했습니다. 대부분의 스프링 애플리캐이션은 웹 애플리케이션인데 웹이 아닌 애플리케이션 개발도 얼마든지 개발할 수 있습니다.

또한, 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 합니다. 가정 상황은 아래의 그림과 같습니다.

 

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

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

우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.

고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸되는데 메모리 낭비가 심하다고 할 수 있습니다.

이것에 대한 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 됩니다. -> 싱글톤 패턴

 

싱글톤 패턴

싱글톤 패턴이란 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴입니다.

그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 합니다.

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

 

그럼 main이 아닌 test 디렉터리에서 테스트 클래스를 생성해보겠습니다.

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("싱글톤 객체 로직 호출");
     }
}

1. static 영역에 객체 instance를 미리 하나 생성해서 올려둡니다.

 

2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있습니다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환합니다.

 

3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 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();
}

private으로 new 키워드를 막았기 때문에 new로 인스턴스로 생성하려 하면 컴파일 오류가 발생합니다.

그리고 콘솔에 singletonService1과 singletonService2의 참조값을 비교해보면 같은 것을 확인할 수 있습니다.

물론, 테스트도 성공하게 됩니다.

 

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

 

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

 

싱글톤 패턴 문제점

1. 싱글톤 패턴을 구현하는 코드 자체가 많이 들어갑니다.

2. 의존관계상 클라이언트가 구체 클래스에 의존합니다. -> DIP를 위반한다.

3. 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높습니다.

4. 테스트하기 어렵습니다.

5. 내부 속성을 변경하거나 초기화하기 어렵습니다.

6. private 생성자로 자식 클래스를 만들기 어렵습니다.

7. 결론적으로 유연성이 떨어집니다

8. 안티 패턴으로 불리기도 합니다.

 

싱글톤 컨테이너

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

지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈입니다.

 

싱글톤 컨테이너

- 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리합니다. 이전에 설명한 컨테이너 생성 과정을 살펴보면 컨테이너는 객체를 하나만 생성해서 관리합니다.

 

- 스프링 컨테이너는 싱글톤 컨테이너 역할을 합니다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 합니다.

 

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

 

- 싱글톤 패턴을 위한 상투적이고 지저분한 코드가 들어가지 않아도 됩니다.

 

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

위의 코드를 실행하면 memberService1과 memberService2는 같은 것을 확인할 수 있고 테스트 또한 성공합니다.

 

싱글톤 컨테이너 적용 후

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

 

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

 

싱글톤 방식의 주의점

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(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;
     }
}

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

public 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("userB", 20000);
         
         //ThreadA: 사용자A 주문 금액 조회
         int price = statefulService1.getPrice();
         
         //ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
         System.out.println("price = " + price);
         Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
     }
 
     static class TestConfig {
         @Bean
         public StatefulService statefulService() {
            return new StatefulService();
         }
     }
}

위의 코드에서 StatefulService의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경하고 있습니다. 사용자 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와 orderService는 두 개 다 memberRepository를 호출합니다. 결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보입니다.

스프링 컨테이너는 이 문제를 어떻게 해결할까요?

직접 테스트해보겠습니다.

 

검증 용도의 코드 추가

 

public class MemberServiceImpl implements MemberService {
     private final MemberRepository memberRepository;
     
     //테스트 용도
     public MemberRepository getMemberRepository() {
     	return memberRepository;
     }
}
    
public class OrderServiceImpl implements OrderService {
	 private final MemberRepository memberRepository;
 	//테스트 용도
    
 	public MemberRepository getMemberRepository() {
 		return memberRepository;
 	}
}

위와 같이 검증 용도로 코드를 작성해줍니다.

 

테스트 코드

import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;

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);
                
         //모두 같은 인스턴스를 참고하고 있다.
         System.out.println("memberService -> memberRepository = " +
        		memberService.getMemberRepository());
         
         System.out.println("orderService -> memberRepository = " +
        		orderService.getMemberRepository());
         System.out.println("memberRepository = " + memberRepository);
         
         //모두 같은 인스턴스를 참고하고 있다.
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);

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

위의 코드를 실행시키면 다음과 같은 결과가 나옵니다.

출력된 것을 보면 모두 같은 인스턴스가 공유되어서 사용하는 것을 볼 수 있습니다.

AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository를 호출해서 다른 인스턴스가 생성되어야 하는데 그렇지 않습니다. 한번 실험을 해보겠습니다.

 

AppConfig에 호출 로그 남김

import hello.core.discount.DiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

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

스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성합니다. 그래서 memberRepository()는 총 3번 호출되어야 하는 것 아닐까요?

 

그런데 출력 결과는 다음과 같이 모두 1번만 호출됩니다.

 

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

스프링 컨테이너는 싱글톤 레지스트리입니다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 합니다. 그런데 스프링이 자바 코드까지 어떻게 하기는 어렵습니다. 저 자바 코드를 보면 분명 3번 호출되어야 하는 것이 맞습니다. 그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용합니다. 모든 비밀은 @Configuration을 적용한 AppConfig에 있습니다.

 

코드 하나를 보여드리겠습니다.

@Test
void configurationDeep() {
     ApplicationContext ac = new
    		AnnotationConfigApplicationContext(AppConfig.class);
            
     //AppConfig도 스프링 빈으로 등록된다.
     AppConfig bean = ac.getBean(AppConfig.class);

     System.out.println("bean = " + bean.getClass());
     //출력: bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70
}

- 사실 AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록됩니다.

- 그래서 AppConfig 도 스프링 빈이 됩니다.

- AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보겠습니다.

 

결과는 다음과 같습니다.

 

 

 

순수한 클래스라면 다음과 같이 출력되어야 합니다.

그런데 예상과는 다르게 클래스 명에 xxxCGLIB가 붙으면서 상당히 복잡해졌습니다. 이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고 그 다른 클래스를 스프링 빈으로 등록한 것입니다.

 

 

 

그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해줍니다. 아마도 다음과 같이 바이트 코드를 조작해서 작성되어 있을 것입니다.(실제로는 CGLIB의 내부 기술을 사용하는데 매우 복잡하다고 합니다.)

 

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

 

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

 

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

@Configuration을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만 만약 @Bean만 적용하면 어떻게 될까요?

 

AppConfig.java에서 @Configuration을 삭제하고 아까의 AppConfig.class의 빈을 조회하는 테스트를 실행해보면 다음과 같이 나옵니다.

이 출력 결과를 통해서 AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있습니다.

 

 

이 출력 결과를 통해서 MemberRepository가 총 3번 호출된 것을 알 수 있습니다. 1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서이고, 2번은 각각 memberRepository()를 호출하면서 발생한 코드입니다.

 

인스턴스가 같은지 테스트 결과

당연히 인스턴스가 같은지 테스트하는 코드도 실패하고, 각각 다른 MemoryMemberRepository인스턴스를 가지고 있습니다.

 

정리

@Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않습니다.

memberRepository()처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다는 것입니다.

그래서 크게 고민할 것 없이 스프링 설정 정보는 항상 @Configuration을 사용하면 됩니다.