[Spring] 기본편 05. 싱글톤 컨테이너

이 글은 스프링 [핵심원리 - 기본편]을 듣고 정리한 내용입니다.

📌 웹 애플리케이션과 싱글톤

• 스프링은 기업용 온라인 서비스 기술을 지원하기 위해 만들어졌다.

• 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.
  

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

package hello.core.singleton;

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

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
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }
}

• 우리가 만들었던 순수한 DI 컨테이너인 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 FixDiscountPolicy();
            return new RateDiscountPolicy();
        }


    }

• 해결방안은 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. -> 싱글톤 패턴

📌 싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
  - private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막는다.

package hello.core.singleton;

public class SingletonService {

    //자기자신을 내부에 private static 으로 선언
    //static으로 선언했으므로 class 레벨에 올라가기 때문에 딱 하나만 존재한다.
    private static final SingletonService instance = new SingletonService();

    // SingletonService instance를 private으로 선언했으므로, 이 인스턴스의 참조를 꺼낼수 있는건(조회 할수 있는건) 이 static 메서드 밖에 없다.
    // 생성은 아무대서도 할 수 없다.
    public static SingletonService getInstance(){
        return instance;
    }

    // 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 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);
        // same : ==
        // equal : 자바의 equals 
    }

• 참조값이 같음을 확인 할 수 있다.
  
• 객체 인스턴스를 생성하는 비용이 1000 정도라면, 참조를 통해 가져오는 비용은 1정도로 생각하면 된다.
• *참고 : 싱글톤 패턴을 구현하는 방법은 여러가지가 있는데, 여기서는 객체를 미리 생성해두는 가장 단순하고 안전한 방법으로 구현하였다.

🌱 싱글톤 패턴 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어감. 아래코드 처럼 구현코드가 길어짐.

// 1.static 영역에 객체를 딱 1개만 생성해둔다.
 private static final SingletonService instance = new SingletonService();
	//2. public으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를  통해서만 조회하도록 허용한다.
    public static SingletonService getInstance(){
        return instance;
    }
    
    //3. 생성자를 private으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {
    }

• 의존관계상 클라이언트가 구체 클래스에 의존. -> DIP 원칙 위반. OCP 원칙you 위반할 가능성 높아짐.
• 테스트하기 어렵다
• 내부 속성을 변경하거나 초기화 하기 어렵다
• private 생성자이기 때문에 자식 클래스 만들기 어렵다
  -> 결론적으로 유연성이 떨어지고, 안티패턴 으로 불리기도 한다.

📌 싱글톤 컨테이너

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

• 우리가 작성했던 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

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

• 싱글톤 패턴을 위한 긴 코드가지 않아도 되고(앞에 작성했던 것처럼) 싱글톤 패턴 문제점을 해결 가능하다.

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

 @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
//        AppConfig appConfig = new AppConfig();
        ApplicationContext ac = new
                AnnotationConfigApplicationContext(AppConfig.class);

        MemberService memberService1 = ac.getBean("memberService",MemberService.class);
        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 등을 사용해야 한다.
  
• 상태를 유지할 경우 발생하는 문제점 예시

   package hello.core.singleton;
   
  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;
	} 
}

• 테스트

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

 // 사용자 A가 주문을 하고, 금액을 꺼낼라 하는데 그 사이에 사용자 B가 끼어들어온 상황.
 // statefulService1에서 가져왔음에도 20000원이 출력된다.
//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 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 실무에서 종종 발생하는데, 정말 해결하기 어려운 큰 문제이다!
• 공유필드는 항상 조심하자. 스프링 빈은 항상 무상태로 설계하자!

📌 @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가 생성되면서 싱글톤이 깨지는것 같다. 스프링 컨테이너는 어떻게 싱글톤을 보장할까?

• 정말 각각 다른 객체인지 테스트해보자

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

• ConfigurationSingletonTest.class

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 -> memberRepository = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);

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

    }
}

• 결과 출력에서 처럼, 모두 같은 인스터를 참고하고 있다.
• AppConfig를 보면 분명 각각 따로 2번 new MemoryMemberRepository를 호출했는데 어떻게 된걸까?

    @Configuration
    public class AppConfig {

        //@Bean memberService -> new MemoryMemberRepository()
        //@Bean orderService -> new MemoryMemberRepository()
        //싱글톤이 깨지는 것은 아닐까?

        //예상되는 호출 (순서는 다를수 있음. 그러나 아래처럼 총 5번의 call 출력이 예상됨)
        //call AppConfig.memberService
        //call AppConfig.memberRepository
        //call AppConfig.memberRepository
        //call AppConfig.orderService
        //call AppConfig.memberRepository

        @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 FixDiscountPolicy();
            return new RateDiscountPolicy();
        }


    }

• 주석에서 쓴 것처럼 총 5번의 call 출력이 예상된다.
  
• 그러나 출력 결과는 각각 모두 1번씩만 출력된다.

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

• 스프링 컨테이너는 싱글톤 레지스트리다.
• 스프링이 자바 코드 자체까지 어떻게 조절하기는 어려우므로, 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.
• @Configuration 어노테이션에 답이 있다.!

• AppConfig 스프링 빈을 조회해서 클래스 정보를 출력하는 코드를 보자
  - AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록되므로, AppConfig도 스프링 빈이 된다.

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

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

• 순수한 클래스면 class hello.core.AppConfig라고 출력되어야 하는데 출력 결과를 보면 뒤에 $$Enhancer~~CGLIB~~ 가 붙는다.
• 이것은 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.
  
• 이 임의의 클래스가 싱글톤이 보장되도록 해주는 것이다.
• AppConfig@CGLIB 예상 코드

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

• @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 그것을 반환하고, 빈이 존재하지 않으면 새로 생성해서 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다. -> 이를 통해** 싱글톤 보장
• AppConfig에 @Configuration을 쓰지 않으면 어떻게 되나 보자

//@Configuration 삭제
 public class AppConfig {
}

• 출력결과를 보면 bean.getClass() = class hello.core.AppConfig가 보인다.
  -AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록되었다
• call 출력결과를 보면 앞에서 예상했던 대로 5번의 call이 출력되었다
  - MemberRepository는 3번인데 1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서이고, 나머지 2번은 각각 memberRepository를 호출하면서 발생한 결과이다.
• 인스턴스가 같은지도 다시 확인하였다.
  
• 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있다.
  - @Configration 어노테이션 돌려놓음.

🌱 정리

• @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤은 보장되지 않는다.
• 스프링 설정 정보는 항상 @Configuration 어노테이션을 사용하면 된다!