싱글톤 컨테이너

웹 애플리케이션과 싱글톤

스크린샷 2023-09-25 오후 9.42.09.png

스프링 없는 순수한 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
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }
}

현재 스프링 없는 순수한 DI 컨테이너AppConfig는 요청을 할 때 마다 객체를 새로 생성합니다.

스크린샷 2023-09-25 오후 9 51 19

그림을 보면 생성된 객체의 값이 다른걸 알 수 있습니다.

예를 들어 고객 트래픽이 초당 100이 나오면 초당 100개의 객체가 생성되고 소멸됩니다. 즉, 메모리 낭비가 심하다는 뜻입니다.

이것을 해결하려면 싱글톤 패턴 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 됩니다.

싱글톤 패턴

싱글톤 패턴은 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴입니다.

그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 하는데, private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하게 하는 방식을 사용해보겠습니다.

public class SingletonService {

    private static final SingletonService instance = new SingletonService();
		
    public static SingletonService getInstance() {
        return instance;
    }

    private SingletonService() {
    }

    public void logic() {
        System.out.println("싱글톤 객체 로직 호출");
    }
}

위 코드를 설명하면, static 영역에 객체 instance를 미리 하나 생성해서 올려둡니다.

만약 해당 객체가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있습니다. 이 메서드를 호출 하면 항상 같은 인스턴스를 반환합니다.

딱 1개의 객체 인스턴스만 존재해야하기 때문에 생성자를 private으로 설정해서 막는 것 입니다.

그러면 싱글톤 패턴을 사용하는 테스트를 진행해보겠습니다.

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

앞서서 private으로 new 키워드를 막아두었습니다.

아래 그림을 보시면 호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있습니다.

스크린샷 2023-09-25 오후 10 19 33

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

하지만 싱글톤 패턴은 여러 문제점을 가지고 있는데,

싱글톤 패턴 문제점

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

  • 의존관계상 클라이언트가 구체 클래스에 의존하게 됩니다. 즉, DIP를 위반하는 것 입니다.

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

  • 테스트하기 어렵습니다.

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

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

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

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

싱글톤 컨테이너(스프링 컨테이너)

싱글톤 컨테이너는 싱글톤 패턴의 문제점을 해결해주면서, 객체 인스턴스를 싱글톤으로 관리해 줍니다.

지금까지 알아본 스프링 빈이 바로 싱글톤으로 관리되는 빈입니다.

정리하면,

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

    • 즉, 컨테이너는 객체를 하나만 생성해서 관리합니다.

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

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

    • 싱글톤 패턴을 위한 복잡한 코드가 들어가지 않아도 됩니다.

    • DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있습니다.

그러면 스프링 컨테이너를 사용하는 코드로 테스트를 해보겠습니다.

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

        //memberService1 == memberService2
        assertThat(memberService1).isSameAs(memberService2);
    }

위에 코드를 실행하면 마찬가지로 동일한 값을 넣어주는 것을 확인할 수 있습니다.

스크린샷 2023-09-25 오후 10 37 42
스크린샷 2023-09-25 오후 10.35.52.png

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

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

싱글톤 방식의 주의점

객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지하게 설계하면 안된다고 합니다.

즉, 무상태로 설계를 해야 합니다.

  • 특정 클라이언트에 의존적인 필드가 존재하면 안된다.

  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.

  • 가급적이면 읽기만 가능해야 한다.

  • 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, 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;
    }
}
class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        statefulService1.order("userA", 10000);
        statefulService2.order("userB", 20000);

        int price = statefulService1.getPrice();
        System.out.println("price = " + price);

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

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

코드에서는 쓰레드를 사용하지 않았습니다.

예를 들어서 ThreadA가 사용자A를 호출하고, ThreadB가 사용자B를 호출한다고 가정할 때,

StatefulServiceprice 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경합니다.

사용자A의 주문금액은 10000원이 되어야 하는데, 실행해보면 아래 그림처럼 20000원이 나옵니다.

스크린샷 2023-09-26 오전 12 38 18

실무에서 이런 경우가 종종 보이는데, 해당 문제로 인하여 해결하기 어려운 큰 문제들이 터진다고 합니다.

즉, 공유필드는 조심해야 하고, 스프링 빈은 항상 무상태로 설계해야 한다고 합니다.

@Configuration과 싱글톤

@Configuration은 싱글톤을 위해서 존재하는 것이라고 합니다.

그런데 구현해 놓은 AppConfig 클래스 코드를 보면 좀 이상한 점이 있습니다.

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

먼저 memberService 빈을 만드는 코드르 보면 memberRepository()를 호출합니다.

해당 메서드가 호출되면 new MemoryMemberRepository()를 호출합니다.

마찬가지로 orderService 빈을 만드는 코드도 동일하게 memberRepository()를 호출합니다.

그러면 또 new MemoryMemberRepository()를 호출하게 됩니다.

결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성 되면서 싱글톤이 깨진는 것처럼 보입니다.

그러면 Spring에서는 어떻게 해당 문제를 해결하는지 확인해보겠습니다.

먼저 각 MemberServiceImplOrderServiceImpl 에 테스트용으로 코드를 만들겠습니다.

public MemberReposiotry getMemberReposiotry() {
        return memberReposiotry;
    }

그리고 AppConfig에 각 메서드가 호출될 때마다 출력하는 코드를 넣어주겠습니다.

System.out.println("call AppConfig.orderService"); // 메서드 별 이름

테스트 코드

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);
        MemberReposiotry memberRepository = ac.getBean("memberRepository", MemberReposiotry.class);

        MemberReposiotry memberRepository1 = memberService.getMemberReposiotry();
        MemberReposiotry memberRepository2 = orderService.getMemberReposiotry();

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

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

스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성합니다.

아까 예상한 시나리오로 진행되면 memberServiceRepository()는 총 3번이 호출되어야 합니다.

스크린샷 2023-09-26 오전 1 11 15

그런데 출력 결과는 딱 한번만 출력이 됩니다.

@Configuration과 바이트코드 조작

스프링 컨테이너는 스프링 레지스트리입니다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 합니다.

하지만 스프링이 자바 코드까지 조작하기에는 어렵습니다. 즉, 실제로 자바코드를 보면 3번 호출되는 것이 맞습니다.

그래서 스프링은 이 문제를 해결하기 위해 바이트코드를 조작하는 라이브러리사용합니다.

@Configuration을 적용한 AppConfig으로 살펴보겠습니다.

@Test
 void configurationDeep() {
     ApplicationContext ac = new
 AnnotationConfigApplicationContext(AppConfig.class);
//AppConfig도 스프링 빈으로 등록된다.
AppConfig bean = ac.getBean(AppConfig.class);
     System.out.println("bean = " + bean.getClass());
스크린샷 2023-09-26 오전 1 31 29

AppConfig도 스프링 빈이 되는 것을 확인할 수 있습니다.

즉, 순수한 클래스라면 class hello.core.AppConfig 만 출력이 될 것 입니다.

그런데 출력된 값을 보면 클래스 명에 xxxCGLIB가 붙으면서 상당히 복잡해진 것을 볼 수 있습니다.

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

스크린샷 2023-09-26 오전 1.35.02.png

CGLIB가 만든 임의의 클래스가 바로 싱글톤을 보장해주는 것 입니다.

@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하여 반환하는 코드가 동적으로 생성되는 것 입니다.

이 덕분에 싱글톤이 보장되는 것 입니다.

@Configuration을 적용하지 않고, @Bean만 적용

AppConfig에 있는 @Configuration 을 삭제하고 실행하면, bean = class hello.core.AppConfig 이 출력됩니다.

해당 출력 결과를 통해 call AppConfig.memberRepository 도 총 3번 호출이 됩니다.

즉, 1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서고, 2번은 각각 memberRepository()를 호출하면서 발생한 코드입니다.

결과적으로는 인스턴스도 다릅니다.

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

memberRepository()처럼 의존관계 주입이 필요한 경우 직접 호출할 때 싱글톤을 보장하지 않습니다.

즉, 스프링 설정 정보는 항상 @Configuration을 사용하여 구현하면 됩니다.

참고 자료

Last updated