Web/Spring

싱글톤 컨테이너

느낌표 공장장 2021. 8. 7. 23:38

 

웹 어플리케이션과 싱글톤

싱글톤 적용 전

  • 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.
  • 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.
  • 그런데 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! ➡︎ 메모리 낭비 
  • 해결방안은 해당 객체가 딱 1개만 생성되고, 해당 인스턴스를 공유하도록 설계하면 된다. ➡︎ 싱글톤 패턴 

 

 

싱글톤 패턴

  • 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다. 
    • (한 자바 서버 안에서는 객체 인스턴스가 딱 1개만 생성된다)
  • 어떻게 해야할까 ? ➡︎ 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
    • private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

 

생성 과정 

  1. static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
    • 이렇게 되면 class 레벨에 올라가기 때문에 딱 하나만 존재하게 된다.
  2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다. (생성한 걸 가져다 쓴다.) 
  3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아서 혹시라도 외부에서 new 키워 드로 객체 인스턴스가 생성되는 것을 막는다.
    • Public 이면 2-3개 만들 수 있음. 싱글톤이라고 생각 X

✔︎ 참고

  • 싱글톤 패턴을 구현하는 방법은 여러 가지가 있다. 
  • 호출할 타이밍에 생성이 안되어 있으면 그 때 생성하는(지연해서 처리) 방식도 있지만, 
  • 로딩할 때 객체를 미리 생성해두는 방법이 가장 단순하고 안전하다. (객체 인스턴스가 메모리를 많이 잡아먹는 게 아니라면)

 

장점 

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

 

싱글톤 패턴 문제점

  • 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
  • 의존관계상 클라이언트가 구체 클래스에 의존한다. ➡︎ DIP를 위반
    • getInstance() 한걸 불러와야 하기 때문이다. 
    • ( AppConfig에서 인스턴스를 꺼내려면 구체클래스.getInstance() 로 꺼내야 한다.)
  • 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다. 
  • 유연하게 테스트하기 어렵다.
    • 싱글톤은 딱 지정해서 가져온다. 싱글톤은 인스턴스를 미리 받아와서 설정이 다 끝나버린다. 
  • 내부 속성을 변경하거나 초기화하기 어렵다.
  • private 생성자로 자식 클래스를 만들기 어렵다.
  • 결론적으로 유연성이 떨어진다.
    • DI 적용하기 어려움 
  • 안티 패턴으로 불리기도 한다.

 

 

싱글톤 컨테이너

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

 

싱글톤 컨테이너

  • 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
    • 컨테이너 생성 과정을 보면, 컨테이너는 객체를 하나만 생성해서 관리한다.
    • ( Bean을 다 호출해서 객체 인스턴스를 미리 생성시켜놓고 관리 ) 
  • 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
  • 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.
    • 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
    • DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

 

싱글톤 컨테이너 적용 후 

  • 스프링 컨테이너 덕분에 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유 해서 효율적으로 재사용할 수 있다.
  • 참고
    • 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공한다.(스코프)
      • 근데 거의 99% 는 싱글톤 빈만 사용한다. 가끔 특별한 기능을 할 때 싱글톤이 아닌 다른 방식을 사용한다. ( 예를 들어 요청할 때마다 새로 꺼낸다거나, http request 라이프 사이클에 맞춰 빈 라이프 사이클을 맞추거나,  http 세션이랑 같은 라이프 사이클을 맞추거나 할 때)

 

 

싱글톤 방식의 주의점

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

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

public class StatefulService {

    // 주문할 때 가격을 저장
    public int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        return price;
    }
}
       
 @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원 주문 (A가 주문하고 조회하는 사이에 B가 끼어든상황)
        int UserBPrice = statefulService2.order("userB", 20000);

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

        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(10000);
    }

 

 

 

@Configuration과 싱글톤

@Configuration은 싱글톤을 위해 존재한다. 

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

 

  • memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다. 
    • 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
  • orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다. 
    • 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
  • 결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것처럼 보인다.
    • 스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성한다. 그래서 memberRepository() 는 다음과 같이 총 3번이 호출되어야 하는 것 아닐까?
      1. 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean이 붙어있는 memberRepository() 호출
      2. memberService() 로직에서 memberRepository() 호출
      3. orderService() 로직에서 memberRepository() 호출
    • 그런데 출력 결과는 모두 1번만 호출된다.
    • call AppConfig.memberService 
call AppConfig.memberRepository 
call AppConfig.orderService

 

 

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

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

 

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

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

}
  • 사실 AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래서 AppConfig 도 스프링 빈이 된다.
  • AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보면 아래와 같다.
    bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70​
  • 순수한 클래스라면 다음과 같이 출력되어야 한다. → class hello.core.AppConfig
  • 그런데 예상과는 다르게 클래스 명에 xxxCGLIB  가 붙으면서 상당히 복잡해진 것을 볼 수 있다. 이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다! (아래 그림 참고)

  • 그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다. 아마도 다음과 같이 바이트 코드를 조작해서 작성되어 있을 것이다.(실제로는 CGLIB의 내부 기술을 사용하는데 매우 복잡하다.)
  • 이름은 appConfig이지만, 사실 instance는 AppConfig@CGLIB이다. 

 

AppConfig@CGLIB 예상 코드

@Bean
    public MemberRepository memberRepository() {
    
	if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) { 
            return 스프링 컨테이너에서 찾아서 반환;
	} else { //스프링 컨테이너에 없으면
            기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록 
            return 반환
	} 
 }
  • @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈(오버라이드 된 아이)을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
  • 그래서 덕분에 싱글톤이 보장되는 것이다. ( 그래서 위에서의 출력 결과가 각각 1번씩 나오는 것이다.)
  • 참고
    •  AppConfig@CGLIB는 AppConfig의 자식 타입이므로, AppConfig 타입으로 조회할 수 있다.
    • appConfig를 호출하는 것 같지만, 사실은 AppConfig@CGLIB이다.

 

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

  • @Configuration 을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약 @Bean만 적용하면 어떻게 될까?
    • 안 붙여도 스프링 빈으로 등록된다.  근데 싱글톤이 깨진다. 
  • @Configuration을 제거하고 위의 테스트 케이스를 똑같이 실행시키면 아래와 같이 나온다.  
    • bean = class hello.core.AppConfig
      이 출력 결과를 통해서 AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.
  • 또한 
    • call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
call AppConfig.memberRepository
    • 이 출력 결과를 통해서 MemberRepository가 총 3번 호출된 것을 알 수 있다.
    • 1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서이고, 2번은 각각 memberRepository() 를 호출하면서 발생한 코드다
  • 인스턴스가 같은지 테스트 결과 
    • memberService -> memberRepository = hello.core.member.MemoryMemberRepository@6239aba6 
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@3e6104fc
memberRepository = hello.core.member.MemoryMemberRepository@12359a82
    • 당연히 인스턴스가 같은지 테스트하는 코드도 실패하고, 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있다.

 

정리

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

 

 

 

 

해당 게시물은 인프런 - 김영한님의 스프링 핵심 원리 - 기본편을 바탕으로 제작되었습니다.

https://www.inflearn.com/course/스프링-핵심-원리-기본편/dashboard



 

저작자표시

'Web > Spring' 카테고리의 다른 글

컴포넌트 스캔  (0) 2021.08.10
스프링 컨테이너와 스프링 빈  (0) 2021.07.30
스프링 핵심 원리 이해 (AppConfig)  (0) 2021.07.27
AOP  (0) 2021.07.25
스프링 DB 접근 기술  (0) 2021.07.25

'Web/Spring'의 다른글

  • 현재글싱글톤 컨테이너

관련글

댓글

티스토리툴바