[2. 스프링 핵심 원리] 싱글톤 컨테이너

1. 스프링 컨테이너 생성

 

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

대부분의 스프링 애플리케이션은 웹 애플리케이션이다.

물론 웹이 아닌 애플리케이션 개발도 얼마든지 개발 할 수 있다. 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

→ 요청이 올 때마다 객체를 만들어야 할까?

 

 

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의 값이 다른걸 확인할 수 가 있다.

우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다 객체를 새로 생성한다. 

 

• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! → 메모리 낭비가 심하다.
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. → 싱글톤 패턴

 

2. 싱글톤 패턴

 

클래스의 인스턴스가 딱 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 영역에 객체 instance를 미리 하나 생성해서 올려둔다. 
• 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다. 
• 딱 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);

    }

새로운 테스트 코드를 돌려보자 

이제 같은 객체를 참조하는 것을 확인할 수 있다.

 

싱글톤 방식의 문제점 

 

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

하지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있다. 

 

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
• 의존 관계상 클라이언트가 구체 클래스에 의존한다. → DIP를 위반한다.
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
• 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어진다.
• 안티패턴으로 불리기도 한다.

 

 

3. 싱글톤 컨테이너

 

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

지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

 

싱글톤 컨테이너

 

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

 

    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

        // 1. 조회: 호출할 때마다 객체를 생성
        MemberService memberService1 = applicationContext.getBean("memberService", MemberService.class);

        // 2. 조회: 호출할 때마다 객체를 생성
        MemberService memberService2 = applicationContext.getBean("memberService", MemberService.class);

        // 참조값이 같은 것을 확인
        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);

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

        System.out.println("statefulService1.getPrice() = " + statefulService1.getPrice());
        assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

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

 

여기서 테스트 코드를 보면서 의문점이 생기지 않으면 안된다. 

 

분명 10000원을 주만한 userA의 pirce를 조회하는데 어째서 값이 20000원일까? 

 

이는 두 개의 객체 인스턴스인 statefulService1과 statefulService2가 같은 객체 인스턴스 StatefulService 객체를 바라보기 때문인데, statefulService1에서 userA가 10000원을 주문하면서 price에 10000원이 대입되었지만, 그 뒤 statefulService2에서 userB가 20000원을 주문했다. 그래서 price에는 20000원이 대입되는데 여기서 price 필드는 싱글톤으로 하나의 객체 인스턴스를 통해 공유되기 때문에 userA는 자신이 주문한 뒤 주문한 userB의 금액이 입력되는 것이다.

 

 

그렇기 때문에 싱글톤을 사용할때는 해당 객체 인스턴스에 공유필드가 있어서는 안된다. 즉, 싱글톤을 사용하려면 상태가 없어야(Stateless)한다

 

 

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

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

여기서 memberService와 orderService를 보자. 각각 자신의 구현체를 생성해서 반환하는데, 그 내부 파라미터를 보면 둘 다 memberRepository를 호출하고있다.

 

그런데, 여기서 memberRepository내부 코드는 MemoryMemberRepository 인스턴스를 생성해 반환하는 것이다.  그럼 memberService, orderService, memberRepository에서 총 세 번 내부 코드가 실행되는데, 싱글톤이 어떻게 유지되는지 의아할 것이다. 우리의 생각대로라면 해당 구성정보의 빈들이 등록되면 memberService와 orderService, memberRepository에서 꺼낸 각각의 memberRepository의 객체 참조주소가 달라야 한다. 

 

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

 

public class ConfigurationSingletonTest {

    @Test
    void configurationDeep() {
        ApplicationContext ac =  new AnnotationConfigApplicationContext(AppConfig.class);
        AppConfig bean = ac.getBean(AppConfig.class);

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

위 코드를 실행했을때 나오는 결과는 우리의 생각에는 무엇일까?

 

우리가 만든 AppConfig.class 라면 hello.core.AppConfig 가 나와야 정상이다.

하지만, 실행결과는 AppConfig뒤에 접미사가 많이 붙어있다. 왜이런걸까? 이유는 스프링에서 CGLIB 라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록했기 때문이다

 

이렇게 바이트코드 조작을 통해 만들어진 AppConfig@CGLIB에서 싱글톤이 보장되도록 해준다. 그러면서도 해당 객체는 AppConfig의 자식 타입으로 만들어져 AppConfig타입으로 조회가 가능하다. 

내부 로직은 아마도 스프링 빈이 없으면 기존 클래스의 생성로직을 수행하고, 스프링 빈이 있을 경우 존재하는 스프링 빈을 반환하도록 로직이 되어있을 것이다.

 

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

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