[Spring MVC - 핵심 원리 기본] 04. 싱글톤 컨테이너

01. 웹 애플리케이션과 싱글톤

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

• 고객이 3번 요청을 하면 3개의 객체가 생성이 되는 상황?
  • 순수 DI를 사용 한다는 가정하에 얘기하는 것
• 간단한 테스트 코드를 생성 해보자

01-1. SingletonTest

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 test() throws Exception {
        //given
        AppConfig appConfig = new AppConfig();

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

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

        //when
        //then
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }

}

"C:\\Program Files\\ojdkbuild\\java-11-openjdk-11.0.15-1\\bin\\java.exe" -ea -Didea.test.cyclic.buffer.size=1048576 -javaagent:C:\\Users\\ym108\\AppData\\Local\\JetBrains\\Toolbox\\apps\\IDEA-U\\ch-0\\222.4345.14\\lib\\idea_rt.jar=59801:C:\\Users\\ym108\\AppData\\Local\\JetBrains\\Toolbox\\apps\\IDEA-U\\ch-0\\222.4345.14\\bin -Dfile.encoding=UTF-8 -classpath C:\\Users\\ym108\\.m2\\repository\\org\\junit\\platform\\junit-platform-launcher\\1.7.2\\junit-platform-launcher-1.7.2.jar;C:\\Users\\ym108\\.m2\\repository\\org\\apiguardian\\apiguardian-api\\1.1.0\\apiguardian-api-1.1.0.jar;C:\\Users\\ym108\\.m2\\repository\\org\\junit\\platform\\junit-platform-engine\\1.7.2\\junit-platform-engine-1.7.2.jar;C:\\Users\\ym108\\.m2\\repository\\org\\opentest4j\\opentest4j\\1.2.0\\opentest4j-1.2.0.jar;C:\\Users\\ym108\\.m2\\repository\\org\\junit\\platform\\junit-platform-commons\\1.7.2\\junit-platform-commons-1.7.2.jar;C:\\Users\\ym108\\AppData\\Local\\JetBrains\\Toolbox\\apps\\IDEA-U\\ch-0\\222.4345.14\\lib\\idea_rt.jar;C:\\Users\\ym108\\AppData\\Local\\JetBrains\\Toolbox\\apps\\IDEA-U\\ch-0\\222.4345.14\\plugins\\junit\\lib\\junit5-rt.jar;C:\\Users\\ym108\\AppData\\Local\\JetBrains\\Toolbox\\apps\\IDEA-U\\ch-0\\222.4345.14\\plugins\\junit\\lib\\junit-rt.jar;C:\\workspace-study\\core\\build\\classes\\java\\test;C:\\workspace-study\\core\\build\\classes\\java\\main;C:\\workspace-study\\core\\build\\resources\\main;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework.boot\\spring-boot-starter-test\\2.5.6\\ae7b6c974539d7789bfff7bb150b333f1ffb5795\\spring-boot-starter-test-2.5.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework.boot\\spring-boot-starter\\2.5.6\\d5d1fada1afe9a808abf48da7066a993cf679aa\\spring-boot-starter-2.5.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework.boot\\spring-boot-test-autoconfigure\\2.5.6\\8e5fdad6e7e508fde028f8f5179b061ec47c5636\\spring-boot-test-autoconfigure-2.5.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework.boot\\spring-boot-test\\2.5.6\\d51fcfd9c4f1236e6460a476be93c96a5687612e\\spring-boot-test-2.5.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework\\spring-test\\5.3.12\\f993b6846c26a1f0f4ed60bc5fdba22a4839c9c1\\spring-test-5.3.12.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework\\spring-core\\5.3.12\\662e6536968246af9baa84fbac2d3eb56a04fda9\\spring-core-5.3.12.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\com.jayway.jsonpath\\json-path\\2.5.0\\c35ef29095125b51638d19120f63e2b56eff20e9\\json-path-2.5.0.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\jakarta.xml.bind\\jakarta.xml.bind-api\\2.3.3\\48e3b9cfc10752fba3521d6511f4165bea951801\\jakarta.xml.bind-api-2.3.3.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.assertj\\assertj-core\\3.19.0\\f64cb5690b85e68d5e1e6c6152bfb6e3840a452d\\assertj-core-3.19.0.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.hamcrest\\hamcrest\\2.2\\1820c0968dba3a11a1b30669bb1f01978a91dedc\\hamcrest-2.2.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.junit.jupiter\\junit-jupiter\\5.7.2\\62faa742964a9d8dab8fdb4a0eab7b01441c171f\\junit-jupiter-5.7.2.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.mockito\\mockito-junit-jupiter\\3.9.0\\871745ab6af5a269411ea3c1f99ced82ed079436\\mockito-junit-jupiter-3.9.0.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.mockito\\mockito-core\\3.9.0\\b7573430aea743b26434b44f4f46272af613e660\\mockito-core-3.9.0.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.skyscreamer\\jsonassert\\1.5.0\\6c9d5fe2f59da598d9aefc1cfc6528ff3cf32df3\\jsonassert-1.5.0.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.xmlunit\\xmlunit-core\\2.8.3\\79be4916d0203c17944d0e891c2b17c555727af\\xmlunit-core-2.8.3.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework.boot\\spring-boot-autoconfigure\\2.5.6\\b9f4016180c5242530da465561ff25c7cac14bf3\\spring-boot-autoconfigure-2.5.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework.boot\\spring-boot\\2.5.6\\d8c6b97fd3182fb6d7d06ebf710cd9ccabc83b89\\spring-boot-2.5.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework.boot\\spring-boot-starter-logging\\2.5.6\\a900356a11b1a41f4277136f1d13ce7a13f43b3c\\spring-boot-starter-logging-2.5.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\jakarta.annotation\\jakarta.annotation-api\\1.3.5\\59eb84ee0d616332ff44aba065f3888cf002cd2d\\jakarta.annotation-api-1.3.5.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.yaml\\snakeyaml\\1.28\\7cae037c3014350c923776548e71c9feb7a69259\\snakeyaml-1.28.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework\\spring-jcl\\5.3.12\\2b5f5bb4a78af879bd174ceff5226da3f014ab9d\\spring-jcl-5.3.12.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\net.minidev\\json-smart\\2.4.7\\8d7f4c1530c07c54930935f3da85f48b83b3c109\\json-smart-2.4.7.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.slf4j\\slf4j-api\\1.7.32\\cdcff33940d9f2de763bc41ea05a0be5941176c3\\slf4j-api-1.7.32.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\jakarta.activation\\jakarta.activation-api\\1.2.2\\99f53adba383cb1bf7c3862844488574b559621f\\jakarta.activation-api-1.2.2.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.junit.jupiter\\junit-jupiter-params\\5.7.2\\685f832f8c54dd40100f646d61aca88ed9545421\\junit-jupiter-params-5.7.2.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.junit.jupiter\\junit-jupiter-api\\5.7.2\\f4b4079732a9c537983324cfa4e46655f21d2c56\\junit-jupiter-api-5.7.2.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\net.bytebuddy\\byte-buddy\\1.10.22\\ef45d7e2cd1c600d279704f492ed5ce2ceb6cdb5\\byte-buddy-1.10.22.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\net.bytebuddy\\byte-buddy-agent\\1.10.22\\b01df6b71a882b9fde5a608a26e641cd399a4d83\\byte-buddy-agent-1.10.22.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.objenesis\\objenesis\\3.2\\7fadf57620c8b8abdf7519533e5527367cb51f09\\objenesis-3.2.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\com.vaadin.external.google\\android-json\\0.0.20131108.vaadin1\\fa26d351fe62a6a17f5cda1287c1c6110dec413f\\android-json-0.0.20131108.vaadin1.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework\\spring-context\\5.3.12\\d5f5f044e05109b7f3337ea2cf692fd62d1ecbb6\\spring-context-5.3.12.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\ch.qos.logback\\logback-classic\\1.2.6\\b09efa852337fa0dd9859614389eec58dc287116\\logback-classic-1.2.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.apache.logging.log4j\\log4j-to-slf4j\\2.14.1\\ce8a86a3f50a4304749828ce68e7478cafbc8039\\log4j-to-slf4j-2.14.1.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.slf4j\\jul-to-slf4j\\1.7.32\\8a055c04ab44e8e8326901cadf89080721348bdb\\jul-to-slf4j-1.7.32.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\net.minidev\\accessors-smart\\2.4.7\\3970cfc505e6657ca60f3aa57c849f6043000d7a\\accessors-smart-2.4.7.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.apiguardian\\apiguardian-api\\1.1.0\\fc9dff4bb36d627bdc553de77e1f17efd790876c\\apiguardian-api-1.1.0.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.junit.platform\\junit-platform-commons\\1.7.2\\34adfea6c13fc4a996cf38cdad80800ce850d198\\junit-platform-commons-1.7.2.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.opentest4j\\opentest4j\\1.2.0\\28c11eb91f9b6d8e200631d46e20a7f407f2a046\\opentest4j-1.2.0.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework\\spring-aop\\5.3.12\\882db41939109e96f4c78cd5c0931cc4aebc3d58\\spring-aop-5.3.12.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework\\spring-beans\\5.3.12\\caaa1d489bce88d6aa01ddd255ad5046acf8f282\\spring-beans-5.3.12.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.springframework\\spring-expression\\5.3.12\\50c82e995b3b8e20a3f313b4356237db5a26e14a\\spring-expression-5.3.12.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\ch.qos.logback\\logback-core\\1.2.6\\25be1abb32e870ff042e698a799b56587e0dca9a\\logback-core-1.2.6.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.apache.logging.log4j\\log4j-api\\2.14.1\\cd8858fbbde69f46bce8db1152c18a43328aae78\\log4j-api-2.14.1.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.ow2.asm\\asm\\9.1\\a99500cf6eea30535eeac6be73899d048f8d12a8\\asm-9.1.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.junit.jupiter\\junit-jupiter-engine\\5.7.2\\9415680a889f00b8205a094c5c487bc69dc7077d\\junit-jupiter-engine-5.7.2.jar;C:\\Users\\ym108\\.gradle\\caches\\modules-2\\files-2.1\\org.junit.platform\\junit-platform-engine\\1.7.2\\2573770b46b8a199ed5f6b0f96fb99e468bfe891\\junit-platform-engine-1.7.2.jar com.intellij.rt.junit.JUnitStarter -ideVersion5 -junit5 hello.core.singleton.SingletonTest,test
memberService1 = hello.core.member.MemberServiceImpl@3b69e7d1 # 다른 객체 주소임
memberService2 = hello.core.member.MemberServiceImpl@815b41f

Process finished with exit code 0

• 이전에 만든 순수 DI 컨테이너 AppConfig는 요청을 할 때마다 객체를 새로 생성한다
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸됨 → 메모리 낭비
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유 하도록 설계 → 싱글톤 패턴

02. 싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인패턴
• 그렇기에 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 함
  • private 생성자를 사용, 외부에서 임의로 new 키워드를 사용하지 못하도록 막는다

02-1. SingletonService

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 키워드로 객체 인스턴스가 생성되는 것을 막는다
4. 애플리케이션 로딩 시점에 instance 변수를 초기화 해둔다

02-2. SingletonService 테스트 코드 생성

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() throws Exception {
    //given
    //new SingletonService(); // compile error

    // 01. 처음 호출 방식
    //new SingletonService.getInstance();

    // 02. getInstance가 static method 이기에 아래와 같이 호출하여 사용 한다
    SingletonService singletonService1 = SingletonService.getInstance();
    SingletonService singletonService2 = SingletonService.getInstance();

    //when
    //then
    System.out.println("singletonService1 = " + singletonService1);
    System.out.println("singletonService2 = " + singletonService2);
    Assertions.assertThat(singletonService1).isSameAs(singletonService2);
    //Assertions.assertThat(singletonService1).isNotSameAs(singletonService2); // 같아야 함

    // same : ==
    // equal : java equals method
}

// 동일한 인스턴스를 반환하는 것을 확인할 수 있음
singletonService1 = hello.core.singleton.SingletonService@1165b38
singletonService2 = hello.core.singleton.SingletonService@1165b38

• private 생성자를 생성하여, new 키워드 사용이 불가능
• AppConfig를 호출 할때와는 다르게 동일한 객체를 반환 한다
• 싱글턴 패턴을 적용하면 고객의 요청이 올때마다 객체를 생성하는 것이 아닌,
  이미 만들어진 객체를 공유해서 사용 한다

02-3. 싱글톤 패턴 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어감
• 의존관계상 클라이언트가 구체 클래스에 의존 → DIP 위반
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙 위반할 가능성 높음
• 테스트하기 어려움
• 내부 속성을 변경하거나 초기화 하기 여러움
• private 생성자로 자식 클래스 만들기 어려움
• 유연성이 떨어지며, 안티패턴이라고도 불린다

03. 싱글톤 컨테이너

• 스프링 컨테이너가 이러한 싱글톤 패턴의 문제점을 해결하여, 객체 인스턴스를 싱글톤으로 관리 해준다
• 지금까지 학습한 스프링 빈이 싱글톤으로 관리되는 빈

03-1. 싱글톤 컨테이너

• 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리
  • 즉, 컨테이너는 객체를 하나만 생성해서 관리함
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 수행
• 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 지칭
• 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 단점을 극복
  • 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다
  • DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤 사용 가능

03-2. 스프링 컨테이너를 사용하는 테스트 코드

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

    //1. 조회: 호출할 때 마다 객체를 생성
    MemberService memberService1 = ac.getBean("memberService", MemberService.class);

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

    //when
    //then
    System.out.println("memberService1 = " + memberService1);
    System.out.println("memberService2 = " + memberService2);
    assertThat(memberService1).isSameAs(memberService2);
    //assertThat(memberService1).isNotSameAs(memberService2);
}

03-3. 싱글톤 컨테이너 적용 후 (Spring Container : ApplicationCotext)

• 1000명의 고객이 동시에 요청(TPS 400)하여도 동일한 객체를 반환
• 이렇게 반환되는 객체는 스프링 컨테이너에 의해 관리되는 싱글톤 객체를 반환
• 즉, 이미 만들어진 객체를 효율적으로 반환

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

04. 싱글톤 방식의 주의점

⚠️ 이번 Chapter에서 가장 중요한 부분

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

04-1. 상태를 유지할 경우 발생하는 문제점 예시 : AS-IS

package hello.core.singleton;

public class StatefulService {

    //private int price; // 상태를 유지하는 필드는 제거되어야 한다

    public int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        //this.price = price;
        return price;
    }

//    public int getPrice() {
//        return this.price;
//    }

}

• 기존 공유 필드인 price를 제거하고, 바로 return 해버린다

package hello.core.singleton;

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

class StatefulServiceTest {

    @Test
    @DisplayName("싱글톤 컨테이너의 문제점 시나리오 구성")
    void statefulServiceSingleton() throws Exception {
        //given
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        //when
        //ThreadA: A사용자 10000원 주문
        statefulService1.order("userA", 10000);

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

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

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

    /**
     * 싱글톤 컨테이너의 Stateful 문제점 시나리오 구성
     */
    static class TestConfig {
        @Bean
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }

}

• 최대한 단순히 설명하기 위해, 실제 쓰레드 사용 안함
• ThreadA가 사용자 A 코드 호출하고, ThreadB가 사용자 B 코드 호출한다 가정
• StatefulService의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경
• 진짜 공유 필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계해야 한다

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

class StatefulServiceTest {

    @Test
    @DisplayName("싱글톤 컨테이너의 문제점 시나리오 구성")
    void statefulServiceSingleton() throws Exception {
        //given
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        //when
        //ThreadA: A사용자 10000원 주문
        int userA = statefulService1.order("userA", 10000);

        //ThreadB: B사용자 20000원 주문
        int userB = statefulService2.order("userB", 20000);

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

        //then
        Assertions.assertThat(userA).isEqualTo(10000);
    }

    /**
     * 싱글톤 컨테이너의 Stateful 문제점 시나리오 구성
     */
    static class TestConfig {
        @Bean
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }
}

• 반환값을 받지 않았던 기존과는 다르게, 반환값을 통해 처리한다

05. @Configuration과 싱글톤

package hello.core;

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 -> memberService() 호출 -> new MemoryMemberRepository() 호출
    //@Bean -> ??

    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public static 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개의 객체)가 아니라 2~3개의 객체가 생성되는 것 같은데… 싱글톤이 깨지는거 아닌가?? 그리고 스프링 컨테이너는 싱글톤을 보장한다고 하였다..??

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

AppConfig.class에서 빈을 등록하는 메서드가 static 메서드일 때. - 인프런 | 질문 & 답변

05-1. MemberServiceImpl, OrderServiceImpl 수정

package hello.core.member;

...

public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }

    **//싱글톤 컨테이너 테스트용 -> 추가 된 부분**
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

package hello.core.order;

...

public class OrderServiceImpl implements OrderService {

    /* 기존 Client 소스를 변경 하여야 한다 */
//    private final DiscountPolicy discountPolicy = new FixDiscountPolicy();
//    TODO: 03. 관심사의 분리 내용 진행
//    private final DiscountPolicy discountPolicy = new RateDiscountPolicy(); // 이 부분이 문제임, DIP 원칙 위배

    // 의존관계 역전 법칙 적용, 의존성 주입을 안해주고 있기 때문에 NullPointerException 발생!!
    // 누군가 대신 의존성 주입을 해줘야 Client 코드를 건드리지 않고 DIP 원칙을 지킬 수 있다
    // 누구?? -> 스프링 IOC 컨테이너 + DI 원칙
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

    /**
     * @param memberId : 회원 번호
     * @param itemName : 상품명
     * @param itemPrice : 상품 가격
     * @return 주문 정보 반환
     */
    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        // memberId를 기반으로 하여 회원 정보를 찾는다
        Member member = memberRepository.findById(memberId);

        // 회원 정보를 기반으로 할인율을 받아온다
        int discountPrice = discountPolicy.discount(member, itemPrice);

        // 회원 정보를 그대로 반환 해준다, DB는 사용하지 않음
        return new Order(memberId, itemName, itemPrice, discountPrice);
    }

    **//싱글톤 컨테이너 테스트용 -> 추가 된 부분**
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

• MemberRepository를 가져와 테스트 코드를 통해 비교하기 위해 생성 한다
• //싱글톤 컨테이너 테스트용 -> 추가 된 부분 주석 참고

05-2. ConfigurationSingletonTest

package hello.core.singleton;

...

public class ConfigurationSingletonTest {

    @Test
    @DisplayName("싱글톤 패턴이 정말 1개의 객체만 반환하는게 맞는지 확인")
    void configurationTest() throws Exception {
        //given
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        //when
        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);
        MemoryMemberRepository memberRepository = ac.getBean("memberRepository", MemoryMemberRepository.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);

        //then
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
    }
}

• AppConfig에서 memberService 호출 시에 2 ~ 3번 정도의 객체 생성이 발생하는데 실제 출력을 해보면 동일한 객체를 사용한다..?
• AppConfig 내에 System.out.print()을 사용하여 디버깅 진행

05-3. AppConfig 디버깅

package hello.core;

...

@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        System.out.println("AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    // AppConfig.class에서 빈을 등록하는 메서드가 static 메서드인 경우 -> 싱글턴 보장이 안된다
    // <https://www.inflearn.com/questions/609357/appconfig-class%EC%97%90%EC%84%9C-%EB%B9%88%EC%9D%84-%EB%93%B1%EB%A1%9D%ED%95%98%EB%8A%94-%EB%A9%94%EC%84%9C%EB%93%9C%EA%B0%80-static-%EB%A9%94%EC%84%9C%EB%93%9C%EC%9D%BC-%EB%95%8C>
    @Bean
    public MemberRepository memberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        System.out.println("AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean
    public DiscountPolicy discountPolicy() {
//        return new FixDiscountPolicy();
        return new RateDiscountPolicy();
    }
}

• AppConfig의 Bean 생성 순서는 보장안됨
• Sysout을 통해 로그 분석
• 테스트 코드 다시 실행

• 테스트 코드를 실행하였고 우리가 예상한 결과와는 다르게 로그가 1번만 찍혀 있다
• 어떻게 이러한 상황이 발생하였는지는 다음에 알아보자

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

• 스프링 컨테이너는 싱글톤 레지스트리이기에 스프링 빈이 싱글톤이 되도록 보장 해야 한다
• 하지만 스프링이 자바 코드까지 제어하지는 못한다 (위에서 로그가 한번 찍힌 부분)
  • 우리가 생각하기에는 3번의 메서드가 호출이 되고 Sysout도 3번 찍혔어야 했다..
• 이러한 문제를 해결하기 위해 스프링은 클래스의 바이트코드를 조작하는 라이브러리 사용
• 모든 비밀은 @Configuration을 사용한 AppConfig에 존재

06-1. configurationDeep

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

    // bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$3f6ce1e3
    System.out.println("bean = " + bean.getClass());

    //when

    //then
}

• bean 변수의 클래스 타입을 조회
• 일반적인 결과 : class hello.core.AppConfg
• 예외적인 결과 : bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$3f6ce1e3

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

• 그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다.
• 내가 등록한 객체는 임의의 다른 클래스가 싱글톤이 되도록 만들어주는 토대가 된다

06-2. AppConfig@CGLIB 예상 코드

public class AppConfig@CGLIB extends AppConfig {

    ...중략

    @Bean
    public MemberRepository memberRepository() {

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

@Bean
public MemberRepository memberRepository() {
    System.out.println("call AppConfig.memberRepository");
    return new MemoryMemberRepository();
}

• 기존 로직은 AppConfig의 해당 메서드를 실행 후 컨테이너에 등록
• 실행은 Override 된 AppConfig@CGLIB의 메서드가 호출 됨
• @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환, 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다
  • 덕분에 싱글톤 보장
• @Configuration을 적용하지 않고 @Bean만 적용하게 되면?
  • 스프링 Bean은 등록이 된다
  • 싱글톤 보장 하지 않음
  • 스프링 설정 쪽에는 항상 @Configuration 넣어서 사용 하자

•