[Spring] 5.싱글톤 컨테이너

[Spring] 5.싱글톤 컨테이너

 

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

- AppConfig의 경우 멤버 서비스 달라고하면 해당 Impl 생성해서 반환

- 요청할때마다 memberService 생성

 

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

* 요청이 올때마다 객체 생성되는지 테스트

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개만 생성되고, 공유하도록 설계하면 된다.(싱글톤 패턴)

 

---

2. 싱글톤 패턴

싱글톤 패턴

- 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴

- 객체 인스턴스를 2개 이상 생성하지 못하게 막아야함

   -> private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 함

 

싱글톤 생성

ㄴ (test)hello.cored.singleton

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

- static 영역에 객체 instance를 미리 하나 생성해서 올려둔다

- 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다.

  이 메서드를 호출하면 항상 같은 인스턴스를 반환

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

}

 

* 스프링 컨테이너를 쓰면 자동으로 싱글톤 패턴으로 만들어서 관리함 

 

* 싱글톤 패턴 문제점

- 구현 코드 많아짐

- 의존관계상 클라이언트가 구체 클래스 의존 (DIP 위반)

- 클라이언트가 구체클래스 의존해서 OCP 위반

- 테스트하기 어려움

- 내부 속성 변경 및 초기화 어려움

- private 생성자로 자식 클래스 만들기 어렵다

-> 유연성이 떨어짐 (안티패턴으로 불리기도 함)

---

3. 싱글톤 컨테이너

스프링 컨테이너는 싱그르톤 패턴 문제점 해결하면서 객체 인스턴스를 싱글톤으로 관리

 

싱글톤 컨테이너

- 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리

  (스프링 빈 객체 하나만 생성해서 관리)

- 스프링 컨테이너는 싱글톤 컨테이너 역할 (싱글톤 객체 생성 및 관리 = 싱글톤 레지스트리)

- 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지 가능

  (구현 코드 많아지지 않고 / 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);
  }
}

 

싱글톤 컨테이너 적용 후

- 요청 올때마다 이미 만들어진 객체를 공유해서 효율적으로 재사용 가능

---

4. 싱글톤 방식의 주의점

- 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 떄문에 싱글톤 객체는 상태를 유지하게(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;
  } 
}

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

 

무상태로 설계!

public class StatefulService {
  private int price; //상태를 유지하는 필드
  
  public void order(String name, int price) { 
    System.out.println("name = " + name + " price = " + price); 
    
    //여기가 문제!
    //this.price = price; 

    // 추가
    return price;
  }
}

//ThreadA: A사용자 10000원 주문 statefulService1.order("userA", 10000);
int userAPrice = statefulService1.order("userA", 10000);
//ThreadB: B사용자 20000원 주문 statefulService2.order("userB", 20000);
int userBPrice = statefulService1.order("userB", 20000);
    
//ThreadA: 사용자A 주문 금액 조회
int price = statefulService1.getPrice();

---

5. @Configuration과 싱글톤

AppConfig

@Configuration
public class AppConfig {
  @Bean
  public MemberService memberService() {
    return new MemberServiceImpl(memberRepository());
  }
  
  @Bean
  public OrderService orderService() {
    return new OrderServiceImpl(
    memberRepository(),
  } 
  
  @Bean
  public MemberRepository memberRepository() {
    return new MemoryMemberRepository();
  }
  ... 
}

- 결과적으로 MemboryMemberRepository가 각각 다르게 생성되면서 싱글톤이 깨지는 것처럼 보임

 

테스트

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

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

- memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용됨

- 두번 호출이 안되는 건가? -> 한번만 호출됨 = 싱글톤 보장해준다는 말

---

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

스프링은 클래스의 바이트코드 조작하는 라이브러리 사용

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

- 순수 클래스라면 class hello.core.Appconfig라고 출력되어야하지만

- bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70 으로 뜸

- 스프링이 CGLIB이라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고 그 다른 클래스를 스프링 빈으로 등록!

AppConfig@CGLIB 예상코드

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

- @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.

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

- 크게 고민할 것이 없다. 스프링 설정 정보는 항상 @Configuration 을 사용하자.