[Spring] 싱글톤 컨테이너

 

 

웹 애플리케이션과 싱글톤

 

 

스프링은 기업용 온라인 서비스 기술을 지원하기 위해 탄생했으며 대부분 스프링 애플리케이션은 웹 애플리케이션이다. 이러한 웹 앱은 보통 여러 클라이언트가 동시에 요청을한다.

 

순수 자바 코드로 구현된 DI 컨테이너(AppConfig)의 경우 클라이언트에서 요청을 할 때마다 아래와 같이 객체를 새로 생성하여 서로 다른 참조값을 갖기에 메모리 낭비가 심한 문제가 있다. 이는 해당 객체가 딱 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
        assertThat(memberService1).isNotSameAs(memberService2);
    }
 }

 

싱글톤 패턴

- 클래스의 인스턴스가 딱 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("싱글톤 객체 로직 호출");
    }
}

1. 클래스 내부 static 영역에 객체 instance를 미리 하나 생성해 올려둔다.
2. 해당 객체 인스턴스가 필요시 오직 getInstance() 메서드를 통해서만 조회하게끔 하여 항상 같은 인스턴스를 반환하게 한다.
3. 1개의 객체 인스턴스만 존재해야 하므로 생성자를 private으로 제어해 외부에서 new 키워드로 객체 인스턴스가 생성되는 걸 막는다.

 

 

이 싱글톤 패턴을 적용했을 때 클라이언트의 요청이 올 때마다 객체를 생성하는 게 아니라 이미 만들어진 같은 참조값의 객체를 공유하기에 효율적으로 사용할 수 있으나 다음의 문제점들이 있다.

 

public class SingletonTest {
    @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest() {
        SingletonService singletonService1 = SingletonService.getInstance();
        SingletonService singletonService2 = SingletonService.getInstance();

        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);
	// singletonService1 == singletonService2
        assertThat(singletonService1).isSameAs(singletonService2);
    }
 }

싱글톤 패턴의 문제점 

- 싱글톤 패턴을 구현하는 코드 자체가 많이 들어가고, 의존관계상 클라이언트가 구체 클래스에 의존을 하며 클라이언트 코드도 변경되므로 DIP, OCP 원칙을 위반할 가능성이 높다.

- 테스트하기 어렵고 내부 속성을 변경하거나 초기화하기 어렵다. 또한, private 생성자로 자식 클래스를 만들기 어려워 유연성이 떨어진다.

 

싱글톤 컨테이너

 

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

 

 

싱글톤 컨테이너의 특징

- 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다. 즉, 스프링 컨테이너 생성시 객체를 하나만 생성해서 관리.

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

- 스프링 컨테이너의 이점으로 싱글톤 패턴의 모든 단점을 해결해주면서 객체를 싱글톤으로 유지할 수 있다.

  - 싱글톤 패턴을 위한 코드가 들어갈 필요 X
  - DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤 사용 가능

 

 

싱글톤 컨테이너를 사용했을 때의 테스트 코드는 아래와 같다.

 

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

싱글톤 컨테이너를 사용함으로써 클라이언트 요청이 들어올 때마다 객체를 생성하는 게 아니라 이미 만들어진 빈 객체를 공유해서 효율적으로 재사용 할 수 있다. 스프링의 기본 빈 등록 방식은 싱글톤이지만 요청할 때마다 새로운 객체를 생성해서 반환하는 기능도 제공해준다.

 

 

싱글톤 방식의 주의사항

싱글톤 패턴이나 스프링 싱글톤 컨테이너와 같이 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 참조하고 있기에 싱글톤 객체는 상태를 유지(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;
    }
}

 

class StatefulServiceTest {

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

        // Thread A : A 사용자 50000원 주문
        int userAPrice = statefulService1.order("userA", 50000);
        // Thread B : B 사용자 100000원 주문
        int userBPrice = statefulService2.order("userB", 100000);

        // 사용자 A 주문 금액 조회
        int price = statefulService1.getPrice();
        //ThreadA: 사용자A는 50000원을 기대했지만, 100000원 출력
        System.out.println("price = " + price);
        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(100000);
    }

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

 

스레드 A에 대한 코드를 호출한 후 스레드 B의 작업을 수행했을 때 StatefulService의 price 필드가 공유되면서 값이 변경되고, 의도치 않은 결과가 출력되는 것이다. 이렇듯 싱글톤 객체(스프링 빈)은 항상 무상태로 설계해야 한다.

 

 

@Configuration과 싱글톤

 

스프링 컨테이너 생성을 통해 AppConfig 내부에서 다른 객체가 여러 번 생성되면서 싱글톤이 깨지는 것 같으나 실제로 확인하였을 때 모두 같은 인스턴스가 공유되어 사용된다. 

 

@Configuration
public class AppConfig {
    @Bean
    public MemberService memberService() {
        System.out.println("Call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public OrderService orderService() {
        System.out.println("Call AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean
    public MemberRepository memberRepository() {
        System.out.println("Call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }

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

 

AppConfig의 구성 설정을 적용해 스프링 컨테이너를 생성해서 서비스 객체를 생성한다고 하였을 때 memberRepository 인스턴스는 모두 같은 인스턴스로 공유된다. new MemoryMemberRepository() 가 여러 번 호출되어 다른 객체를 참조하는 게 아닌가 의문이 들지만 여기에는 @Configuration 애노테이션이 붙은 클래스에서 바이트 코드가 내부적으로 조작되어 싱글톤이 보장된다. 

@Configuration과 바이트 코드 조작

스프링 컨테이너는 싱글톤 레지스트리이므로 스프링 빈이 싱글톤을 보장해줘야 하나 자바 코드 자체에 영향을 주기엔 한계가 있다. 따라서, 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다. 단, @Configuration를 적용한 AppConfig여야 한다.

 

AnnotationConfigApplicationContext 객체에 인자로 넘긴 값도 스프링 빈으로 등록되고, AppConfig 스프링 빈을 통해 클래스 정보를 출력해보면 아래 주석에 나와있듯 "basic.core.AppConfig$$EnhanceBySpringCGLIB" 의 결과로 CGLIB가 붙은 것을 확인할 수 있다.

 

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

        //AppConfig도 스프링 빈으로 등록된다.
        AppConfig bean = ac.getBean(AppConfig.class);

        System.out.println("bean = " + bean.getClass());
        //출력: bean = class basic.core.AppConfig$$EnhancerBySpringCGLIB$$112a2868
    }
}

 

클래스 명에 "CGLIB"가 붙으면서 자신이 만든 클래스가 아닌 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 클래스를 스프링 빈으로 등록한 것이다. 이 임의의 다른 클래스가 싱글톤이 보장되도록 해준다. 

 

 

AppConfig@CGLIB 

해당 라이브러리의 코드상 이미 스프링 컨테이너에 @Bean이 붙은 메서드마다 등록이 되어있는 빈이라면 스프링 컨테이너에서 찾아서 반환을 해주고, 없다면 기존 로직을 호출해 빈을 생성하고 컨테이너에 등록해 반환해주는 것이다. 이로써 싱글톤이 보장되는 것이다.

AppConfig@CGLIB는 AppConfig의 자식 타입이고, @Configuration을 붙이지 않는다면 CGLIB 기술이 사용되지 않아 서로 다른 객체가 생성되어 싱글톤이 깨진다.

 

결론적으로 @Bean만 사용해도 스프링 빈으로 등록은 되지만 싱글톤을 보장하지는 않는다. 의존관계 주입이 필요해 메서드를 직접 호출할 때 싱글톤 보장을 하지 않는 것이다. 이는 스프링 설정 정보에 @Configuration 애노테이션을 붙임으로써 해결해줄 수 있다.

 

 

본 내용은 인프런 핵심원리 - 기본편 김영한님의 강의를 참고하였습니다.