[스프링 핵심원리 기본편] 5.1 싱글톤 컨테이너

👋들어가면서👋

피곤하다. 오늘은 이거 말고도 빅데이터랑 한언사랑 컴연방공부도 해야하는데...
잠은 언제 자지? 🛏️

나보다 바쁜 사람들은 어떻게 살아갈까? 진짜로 😩 
나보다 바쁜 사람도 훨씬 많을텐데...

내가 의지 박약인가,,,? 그럴수도... 

🎯 목표

📌 웹 어플리케이션과 싱글톤 
📌 싱글톤 패턴
📌 싱글톤 컨테이너

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

🔍 스프링 애플리케이션은?

• 스프링 애플리케이션은 보통 웹 애플리케이션이다.
• 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 하게 된다.

🔍 기존에 만든 appConfig

➡️ 클라이언트가 memberService를 요청할때마다 DI 컨테이너가 새로운 객체를 제공한다.

  @Bean
  public MemberService memberService() { //key : 메소드 이름(membserService)
    return new MemberServiceImpl(memberRepsitory()); //참조값을 넣어준다.
  }

🤔예제

public class SingletonTest {

  @Test
  @DisplayName("스프링 없는 순수한 DI 컨테이너")
  void pureContainer() {
    AppConfig appConfig = new AppConfig();

    MemberService memberService1 = appConfig.memberService();
    MemberService memberService2 = appConfig.memberService();

    System.out.println("memberService1 = " + memberService1);
    System.out.println("memberService2 = " + memberService2);

  }
}

💻 실행화면
👉 새로운 객체 생성

memberService1 = hello.core.member.MemberServiceImpl@13d5681d
memberService2 = hello.core.member.MemberServiceImpl@4a150b01

🙅‍♀️ 문제점

요청을 할 때 마다 객체 생성⁉️
👉 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다!
⚠️ 메모리 낭비가 심하다.

🔨 해결방안 : 해당 객체를 딱 하나만 생성하고, 그 인스턴스를 공유하도록 설계하면 된다.
➡️ 싱글톤 패턴

📌 싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
  🔨 private 생성자 사용

☑️ 싱글톤 패턴의 규칙

• static 영역에 객체 인스턴스를 미리 생성한다.
  private static final SingletonService instance = new SingletonService();
• 객체 인스턴스는 getInstance를 통해서만 반환받을 수 있다.
  ⭐ 이 객체 인스턴스는 항상 같은 인스턴스를 반환한다.
• 생성자를 🔒private로 막아 외부에서 생성자를 통해 객체 인스턴스를 생성하는 것을 받는다.

🔨 싱글톤 패턴 예제

public class SingletonService {

  private static final SingletonService instance = new SingletonService();

  public static SingletonService getInstance() {
    return instance;
  }

  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
  }

💻 실행 화면

singletonService1 = hello.core.singleton.SingletonService@5e621cc1
singletonService2 = hello.core.singleton.SingletonService@5e621cc1

📒 싱글톤 패턴의 문제점

• 코드가 길어진다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다. DIP를 위반한다.

SingletonService.getInstance();

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

🤔 그러면 어떻게 해야하는데여..?

👉 스프링 컨테이너를 사용하면 된다.

📌 싱글톤 컨테이너

🔨 싱글톤 컨테이너

• 스프링 컨테이너는 싱글턴 패턴을 자동으로 적용해준다.
  🔍 컨테이너 생성과정을 다시 생각해보자. 👉 컨테이너는 객체를 하나만 생성해서 관리한다.
• 스프링 컨테이너 🟰 싱글톤 컨테이너
• 싱글톤 레지스트리 : 싱글톤 객체를 생성하고 관리하는 기능

✔️ 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.
👉 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
👉 DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다

⭐ 스프링 컨테이너를 사용하는 이유~!

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

  @Test
  @DisplayName("스프링 컨테이너와 싱글톤")
  void springCantainer() {

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

    assertThat(memberService1).isSameAs(memberService2);

  }

💻 실행화면 : 통과 🫡

memberService1 = hello.core.member.MemberServiceImpl@8bb663e
memberService2 = hello.core.member.MemberServiceImpl@8bb663e

🔍 물론 싱글톤 방식이 아닌 새로운 객체를 생성해서 반환하는 기능도 제공한다.

빈 스코프에서 설명하겠다. 

✔️ 물론 싱글톤 패턴 사용시에 주의해야할 점이 있다.

📌 싱글톤 방식의 주의점

• 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유
  👉 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.

✔️ 무상태(stateless)로 설계해야 한다!

- 특정 클라이언트에 "의존적인 필드"가 있으면 안된다.
-> 특정 클라이언트가 사용하는, 변경할 수 있는 
- 특정 클라이언트가 "값을 변경할 수 있는 필드"가 있으면 안된다!
- 가급적 "읽기만 가능"해야 한다.
- 필드 대신에 자바에서 "공유되지 않는, 지역변수, 파라미터, ThreadLocal등을 사용"해야 한다.
✔️ 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다!!!

🔍 싱글톤 방식에서 생길 수 있는 문제

👉 공유되는 변수 값이 생겨 오류를 발생한다
싱글톤 예제

public class StatefulService {

  private int price;

  public void order(String name, int price) {
    System.out.println("name = " + name);
    System.out.println("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.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();

    //ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
    System.out.println("price = " + price);

    assertThat(statefulService1.getPrice()).isNotEqualTo(10000);
  }

  static class TestConfig {

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

💻 실행 화면

name = userA
price = 10000
name = userB
price = 20000
price = 20000

⚒️ 해결하기

➡️ 공유되는 문제를 해결한다.
해결한 싱글톤 코드

  public class StatefulService {

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

테스트 코드 수정

public 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원 주문
    int userAPrice = statefulService1.order("userA", 10000);
    //ThreadB: B사용자 20000원 주문
    int userBPrice = statefulService2.order("userB", 20000);

    //ThreadA: 사용자A 주문 금액 조회
//    int price = statefulService1.getPrice();

    //ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
    System.out.println("price = "+ userAPrice);

//    assertThat(statefulService1.getPrice()).isNotEqualTo(10000);
  }

  static class TestConfig {

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

💻 실행화면

name = userAprice = 10000
name = userBprice = 20000
price = 10000

📢 꼭 무상태로 개발하길...!!

⚠️ 테스트 코드에서 오류 발생

org.springframework.beans.factory.BeanCreationException: 
Error creating bean with name 'test': 
Instantiation of bean failed; 
nested exception is org.springframework.beans.BeanInstantiationException: 
Failed to instantiate [org.junit.jupiter.api.Test]: 
Specified class is an interface

"ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);"`
➡️ 여기서 그냥 `Test.class` 로 하는 바람에, 이게 클래스가 아니고 인터페이스다~~ 라는 오류가 뜬 것!

✔️ 에러 메시지를 읽고 잘 해결해서 뿌듯하다.~

슬의생 꿀잼 오류 발생 해결이랑 무상태가 뭔지 추가로 알아봐야겠다.