5. 싱글톤 컨테이너

웹 애플리케이션과 싱글톤

• 스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생함.

• 이런 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

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

        assertThat(memberService1).isNotSameAs(memberService2);
    }
}

• AppConfig은 요청을 할 때 마다 객체를 새로 생성한다.

• 트래픽이 초당 100이 나오면 초당 100개의 객체가 생성되고 소멸된다.

• 해결방안은? 싱글톤

싱글톤 패턴

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

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() {
    SingletonService singletonService1 = SingletonService.getInstance();
    SingletonService singletonService2 = SingletonService.getInstance();

    System.out.println("singletonService1 = " + singletonService1);
    System.out.println("singletonService2 = " + singletonService2);

    assertThat(singletonService1).isSameAs(singletonService2);

    // same : ==
    // equal : .equals()
}

isSameAS

• == 메서드를 통한 비교

isEqualTo

• .equals() 메서드를 통한 비교

싱글톤 패턴의 문제점

• 싱글톤패턴을 구현하는 코드 자체가 많이 들어간다.

• 의존관계상 클라이언트가 구체 클래스에 의존한다. ⇒ DIP를 위반한다. (구체 클래스.getInstance()로 꺼내와야 한다.)

• 클라이언트가 구체클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.

• 테스트하기 어렵다.

• 내부속성을 변경하거나 초기화하기 어렵다.

• private 생성자로 자식클래스를 만들기 어렵다.

• 결론적으로 유연성이 떨어진다.

• 안티패턴으로 불리기도 한다.

싱글톤 컨테이너

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

• 우리가 직접 싱글톤을 적용하지 않아도, 알아서 싱글톤으로 관리한다.

• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

• 싱글톤 컨테이너의 모든 단점을 해결하면서 싱글톤으로 유지해준다.
  • 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않는다.
  • DIP, OCP, 테스트 priavte 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다.

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
    AnnotationConfigApplicationContext 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);
}

• 스프링 컨테이너 덕분에 고객의 요청이 들어올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다.

싱글톤 방식의 주의점

• 무상태(stateless)로 설계해야 한다.
  • 특정 클라이언트에 의존적인 필드가 있으면 안된다.
  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다.
  • 가급적 읽기만 가능해야한다.
  • 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야한다.

• 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다.

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

    public int getPrice() {
        return price;
    }
}

class StatefulServiceTest {
    @Test
    void statefulServiceSingleton() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

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

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

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

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

• ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.

• StatefulService의 price필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경해버린다.

• 진짜 공유필드는 조심해야한다. 항상 무상태로 설계하자. 제발!

@Configuration과 싱글톤

@Configuration
public class AppConfig{
    @Bean
    public MemberRepository memberRepository(){
        return new MemoryMemberRepository();
    }

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

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

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }
}

• memberService 빈을 만드는 코드를 보면 memberRepository()를 호출한다.
  • 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.

• orderService 빈을 만드는 코드를 보면 memberRepository()를 호출한다.
  • 이 메서드를 호출하면 new MemoryMemberRepository()를 호출하다.

⇒결과적으로 싱글톤이 깨지지 않을까??

직접 테스트

public class ConfigurationSingletonTest{
    @Test
    void configurationTest() {
        AnnotationConfigApplicationContext 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 = orderService.getMemberRepository();

        System.out.println("memberRepository1 = " + memberRepository1);
        System.out.println("memberRepository2 = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);

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

• 결과를 보면 세 인스턴스 모두 같은 인스턴스가 되어있다.

⇒ memberRepository는 3번 호출 되는게 아니라 1번만 호출된다.

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

AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig bean = ac.getBean(AppConfig.class);

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

• 출력이 class hello.core.AppConfig 가 아니다.

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

• 즉, 임의의 다른 클래스가 싱글톤으로 보장되도록 해준다. 아마도 아래와 비슷하게 작성되어 있을 것이다.(실제 CGLIB을 사용한 기술은 훨씬 더 복잡하다)

@Configuration 생략

• 생략시 CGLIB을 사용하지 않는다.

• Bean을 등록을 하긴 한다. 다만, 생성 시 Instance를 여러개 만들어버린다.

• 싱글톤이 깨져버린다.

Uploaded by N2T

(23.05.31 22:34)에 작성된 글 입니다.