싱글톤 컨테이너

2023. 5. 12. 02:10Spring/Java

웹 어플리케이션과 싱글톤

웹 어플리케이션은 수 많은 사람들이 동시에 요청을 보낸다. 하지만 요청 하나 하나 마다 객체를 만든다면 메모리가 당연히 과부하가 올 것이다. 예를 들어 100만명의 고객이 초당 요청을 하나씩 보낸다 생각하면 초당 객체가 100만개가 생성되고 소멸된다. 그림으로 보면 다음과 같을 것이다.

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

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

        // memberService2 != memberService2
        assertThat(memberService1).isNotSameAs(memberService2);
    }

서로 다른 객체가 생성 되는 것을 알 수 있다. 순수 자바 코드이므로 너무나도 당연하긴하다.

 

이를 해결하기 위해서는 객체를 딱 1개만 생성되고, 공유하도록 설계하는 것이다. -> 싱글톤 패턴


싱글톤 패턴 (Singleton Pattern)

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

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 을 이용하여 간단한 싱글톤 패턴을 구현해보았다.

싱글톤 패턴을 적용하면 위에서 언급한 메모리 문제를 해결할 수 있다. 요청 하나하나 마다 객체를 만들지 않고 하나의 객체만을 만들어 그 객체를 공유하며 사용할 수 있기 때문이다.

 

하지만 싱글톤 패턴은 많은 문제점을 가지고 있다.

싱글톤 패턴의 문제점

  • 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
  • 의존관계상 클라이언트가 구현체에 의존한다 -> DIP 위반
  • 클라이언트가 구현체에 의존하기 때문에 OCP 원칙을 위반할 가능성이 높다.
  • 테스트하기 어렵다
  • 내부 속성을 변경하거나 초기화 하기 어렵다
  • private 생성자로 자식 클래스를 만들기 어렵다

-> 유연성이 떨어지며 안티패턴(Anti-Pattern) 이라고도 불린다.

 

싱글톤 컨테이너

스프링 컨테이너는 이런 싱글톤 패턴의 문제점을 해결하면서, 객체를 싱글톤 패턴으로 관리한다.
-> 객체지향적이며 메모리를 낭비하지 않을 수 있다.

 

스프링 컨테이너 이용

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

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

스프링 컨테이너를 사용하니 두 가지 객체를 생성했지만 같은 참조값을 가진 것이 확인되었다. 이 두 객체는 스프링 컨테이너가 싱글톤 패턴으로 관리 해주는 것이다! 

 

싱글톤 방식의 주의점

싱글톤 패턴, 싱글톤 컨테이너인 스프링 컨테이너, 객체 인스턴스를 하나만 생성해서 공유하는 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안 된다.

 

싱글톤 객체가 상태를 유지할 경우 아래와 같은 코드 처럼 문제가 발생할 수 있다.

public class StatefulService {

    private int price;

    public int 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", StatefulService.class);
        StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);

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

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

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

    static class TestConfig {

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

상태를 유지한다면 userA의 주문이 10000원이어야 하지만 20000원으로 변경된다. 왜? 상태가 유지되고 있으니깐! 실제 서비스라면? 아주 대형사고 일 것이다.

 

따라서 싱글톤 방식은

무상태(stateless)로 설계해야 한다.

  • 특정 클라이언트에 의존적인 필드가 있으면 안 된다.
  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다.
  • 가급적 읽기만 가능해야 한다.
  • 필드 대신에 자바에서 공유되지 않는, 지역변수, Parameter, ThreadLocal 등을 사용해야 한다.
public class StatefulService {

    public int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        return price;
    }
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원 주문
        int userAPrice = statefulService1.order("userA", 10000);
        //ThreadB : B 사용자 20000원 주문
        int userBPrice = statefulService1.order("userB", 20000);

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

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

    static class TestConfig {

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

무상태로 설계한 코드이다. order 함수에서 this.price = price를 제외하여 특정 클라이언트가 필드값을 변경할 수 없도록 만들었다. 또한 Parameter를 이용하여 값을 조작해주는 모습을 볼 수 있다.

 

 

@Configuration 을 적용한 DI 컨테이너

AppConfig라는 DI Container에 @Configuration 이라는 스프링 설정정보 annotation 을 달아준 후  AppConfig의 class를 getBean()으로 확인하면 AppConfig이 아니라 AppConfigxxxCGLIB 의 AppConfig 클래스를 상속받은 임의의 다른 클래스가 만들어 진다. 그리고 스프링은 이 클래스를 스프링 빈으로 등록한 것이다. 이 임의의 클래스가 싱글톤이 보장되도록 해준다.

 

따라서 스프링 설정 정보는 항상 @Configuration 을 사용해서 싱글톤 컨테이너의 장점을 살리도록 하자.