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

[6om1n]

웹 애플리케이션과 싱글톤

• 스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
• 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 웹이 아닌 애플리케이션도 개발 가능 !
• 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.
  

• 클라이언트 A,B,C 가 스프링에게 요청을 한다. 세 명이 동시에 요청을 하면 DI 컨테이너는 객체를 new 로 생성해서 건네준다.
• 고객이 3번 요청을 하면 객체가 3개 만들어진다.
• 이에 대한 문제점은 요청이 올 때마다 계속 객체를 만들어야한다.
• 웹 같은 경우는 객체 생성이 많이 되기에 효율적이지 않다.

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;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import java.lang.reflect.AnnotatedType;

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

        //3.참조값이 다른 것을 확인
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        //memberService != memberService2
        assertThat(memberService1).isNotSameAs(memberService2);

    }
}

• 우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig 는 요청을 할 때마다 객체를 새로 생성한다.
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다 ▶️ 메모리 낭비가 심함.
• 해결방안은 해당 객체가 딱 1개가 생성되고, 공유하도록 설계하면 된다. ▶️ 싱글톤 패턴을 이용해야 한다.

• 두 개의 참조값이 다른 것을 확인할 수 있다.

---

싱글톤 패턴

• 싱글톤 패턴 이란 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
• 그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
  • private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.
• 싱글톤 패턴을 적용한 예제 코드 확인하기. main 이 아닌 test 위치에 작성한다.

 package hello.core.singleton;

public class SingletonService {
   private static final SingletonService instance = new SingletonService();

   public static SingletonService getInstance() {
       return instance; //
   }
   private SingletonService() {

   }
  public void logic(){
       System.out.println("싱글톤 객체 로직 호출");
  }
}

1. static 영역에 객체 instance 를 미리 하나 생성해서 올려둔다.
2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private로 막아서 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

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

 @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest() {
        //1. 조회 : 호출할 떄 마다 같은 객체를 반환
        SingletonService singletonService1 = SingletonService.getInstance();
       // 2. 조회 : 호출할 떄 마다 같은 객체를 반환
        SingletonService singletonService2 = SingletonService.getInstance();
        //참조값이 같은 것을 확인
        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);
        //singleService1 == singleService2
        assertThat(singletonService1).isSameAs(singletonService2);
        singletonService1.logic();;
    }

이와 같이 코드를 작성하면 싱글톤이 되었다. instance의 참조를 꺼낼 수 있는 방법은 return instance 밖에 없다.

• private으로 new 키워드를 막아주었기 때문에 이와 같이 다른 클래스에서 new 로 호출하면 컴파일 오류가 발생한다.

• 호출할 때마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

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

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

🚫 싱글톤 패턴 문제점

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

스프링 컨테이너를 사용하면 객체를 다 싱글톤으로 만들어서 관리해준다.

---

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(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);

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

        //memberService == memberService2
        assertThat(memberService1).isSameAs(memberService2);
    }

싱글톤 컨테이너 적용 후

스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다.
📌 참고 : 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공한다.

---

⭐ 싱글톤 방식의 주의점 (중요 !!)

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

상태를 유지할 경우 발생하는 문제점 예시

package hello.core.singleton;

public class StatefulService {
    private int price; //상태를 유지하는 필드 10000 -> 20000

    public void order (String name, int price) {
        System.out.println("name = "+ name + " price = " + price);
        this.price = price; //여기가 문제!

    }

    public int getPrice() {
        return price;
    }
}

상태를 유지할 경우 발생하는 문제점 예시

package hello.core.singleton;

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;

import static org.junit.jupiter.api.Assertions.*;

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        //ThreadA : A사용자 10000원 주문
        statefulService1.order("userA", 10000);
        //ThreadB : B사용자 20000원 주문
        statefulService2.order("userB", 20000);

        //ThreadA: 사용자A 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price = " + price); // 기대한 것은 10000원인데 실제로 20000원 나옴
        //실제 들어가면 같은 인스턴스를 가리키기 때문이다, statefulService 는 같은 객체이다 .

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

    }
    static class TestConfig {
        @Bean
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }
}

• 최대한 단순히 설명하기 위해, 실제 쓰레드는 사용하지 않았다.
• ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.
• StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.
• 실무에서 이런 경우를 종종 보는데, 이로인해 정말 해결하기 어려운 큰 문제들이 터진다.(몇년에 한번씩 꼭 만난다.)
• ⭐ 진짜 공유필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자.

---

@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 가 생성되면서 싱글톤이 깨지는 것 처럼 보인다. 스프링 컨테이너는 이 문제를 어떻게 해결할 지 테스트 해보자.

검증 용도의 코드 추가

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

• 테스트를 위해 MemberRepository 를 조회할 수 있는 기능을 추가한다. 기능 검증을 위해 잠깐 사용하는 것이므로 인터페이스에 조회기능까지 추가하지는 않는다.

테스트 코드

package hello.core.singleton;

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

import java.sql.SQLOutput;

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 = memberService.getMemberRepository();

        //모두 같은 인스턴스를 참고하고 있다.
        System.out.println("memberService -> memberRepository = " + memberRepository1);
        System.out.println("memberService -> memberRepository = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);

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

    }
}

• 확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
• AppConfig의 자바 코드를 보면 각각 2번 new MemoryMemberRepository 호출해서 다른 인스턴스가 생성이 되어야 하는데 ? 어떻게 된 일일까?

AppConfig에 호출 로그 남김

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
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 -> memberService -> new MemoryMemberRepository()
    //@Bean orderService ->  new MemoryMemberRepository()

    /*이렇게 호출이 되어야 하는거 아닐까?*/
    //call AppConfig.memberService
    //call AppConfig.memberRepository
    //call AppConfig.memberRepository
    //call AppConfig.orderService
    //call AppConfig.memberRepository

    /*실제 이렇게 호출이 된다. */
    //call AppConfig.memberService
    //call AppConfig.memberRepository
    //call AppConfig.orderService

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

스프링 컨테이너가 각각 @Bean 을 호출해서 스프링 빈을 생성한다. 그래서 memberRepository() 는 다음과 같이 총 3번의 호출이 되어야 하는 것이 아닐까 고민해보았다.

1. 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean 이 붙어있는 memberRepository() 호출
2. memberService() 로직에서 memberRepository() 호출
3. orderService() 로직에서 memberRepository() 호출

❓ 그런데 출력 결과는 모두 1번만 호출된다.

---

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

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

• test/singleton/ConfigurationSingletonTest

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

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

• 위의 코드에서 AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래소 AppConfig 도 스프링 빈이 된다.

• AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보자.
  

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

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

• AppConfig 를 상속 받는 다른 임의의 클래스가 바로 싱글톤 이 되도록 보장해준다.

AppConfig@CGLIB 예상 코드

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

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

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

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

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

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

• 당연히 인스턴스가 같은지 테스트 하는 코드도 실패하고, 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있는 것을 확인할 수 있다.

📍 정리

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

---

🔖 번외 (단축키)

• ctrl + shift + t = test 만들기

[Pracrobo]

오 빨리하셨네요 ㅎㅎ

[6om1n]

분발하고 있습니당 ㅎㅎ

[YuDeokRin]

이게 꿈이아니죠 ?

[seyxxn]

ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ

[6om1n]

ㅋㅋㅋㅋㅋㅋ 이런 반응이 절 더 빠르게 하게 만듭니다
항상 채찍질 해주세요 (당근도 같이 ..)