[기본] #5 싱글톤

본 포스팅은 인프런 - 스프링 핵심 원리(기본편)을 강의를 바탕으로 공부하고 정리한 글입니다.

 

웹 애플리케이션과 싱글톤

• 스프링은 태생이 기업용 온라인 웹 서비스 기술을 지원하기 위한 기술이다.
• 대부분의 스프링 애플리케이션은 웹 애플리케이션이다.(물론 아닌 것도 있음)
• 웹 애플리케이션은 보통 여러 고객이 동시에 사용하는 서비스로 많은 요청이 처리된다.
• 이전에 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할때 마다 객체를 새로 생성한다.
• 즉, 고객 트래픽이 초당 100이 나오면 초당 100개의 객체가 생성되고 소멸되는 것이다. → 메모리 낭비
• 따라서 우리는 단일 객체를 가지는 싱글톤 패턴을 적용해야 한다.
• 싱글톤 패턴으로 구현하는 경우, 효율적인 메모리 사용이 가능하다는 큰 장점을 가진다.
• 하지만, 공유자원을 동시접근 하는 경우 동시성 문제가 발생할 수 있기 때문에 이를 유의해서 설계해야만 한다.

👉🏻 스프링 없는 순수한 DI 컨테이너 테스트

📁 test/singleton/SingletonTest

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 키워드를 사용하지 못하도록 막음
• 싱글톤 패턴을 사용하면 고객의 요청이 올 때 마다 객체를 생성하지 않고, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다는 장점이 있다.

👉🏻 싱글톤 패턴 적용

📁 test/singleton/SingletonService

public class SingletonService {

    // static 영역에 객체를 딱 1개만 생성해둔다.
    private static final SingletonService instance = new SingletonService();

    // public으로 열어서 객체 인스턴스가 필요하면 이 static 메소드를 통해서만 조회하도록 허용한다.
    public static SingletonService getInstance() {
        return instance;
    }

    // 생성자를 private으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {
    }

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

• static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
• 이 객체 인스턴스가 필요하면 오직 getInstance() 메소드를 통해서만 조회할 수 있도록 한다. 이 메소드를 호출하면 항상 같은 인스턴스를 반환한다.
• 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아 혹시라도 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

 

👉🏻 싱글톤 패턴 테스트

public class SingletonService {
    @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);
    }
}

getInstance() 메소드를 호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

 

💡 문제점

• 싱글톤 패턴을 구현하는 코드가 많이 들어간다.
• 클라이언트가 구체 클래스에 의존한다. → DIP 위반, OCP 위반 가능성 높음
• 테스트마다 데이터를 초기화 해줘야 하므로 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 유연성이 떨어진다.
• 안티패턴으로 불리기도 한다.

 

 

싱글톤 컨테이너

스프링 컨테이너는 위와 같은 기존의 싱글톤 패턴의 문제점을 해결해준다.

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

• 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
• 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.
  • 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 됨
  • DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤 사용 가능
  • 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용

스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다.
요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공한다. (자세한 내용은 이후에 빈 스코프에서 설명)

 

👉🏻 스프링 컨테이너 사용 테스트

📁 test/singleton/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);

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

getBean() 메소드를 호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

 

 

 싱글톤 방식의 주의점

• 싱글톤 패턴이든, 스프링 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.
• 무상태(stateless)로 설계해야만 한다 !
  • 특정 클라이언트에 의존적인 필드가 있으면 안됨
  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안됨
  • 가급적 읽기만 가능해야 함
  • 공유 필드 대신에 자바에서 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
• 스프링 빈 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있기에 반드시 주의해야 한다.

 

👉🏻 상태를 유지(stateful)할 경우 발생하는 문제점 예제

📁 test/singleton/StatefulService

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; // 그 값을 꺼냄
    }
}

• price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 싱글톤 패턴에서 이런식으로 공유필드에 접근하다보면 예기치 못한 값들을 반환하는 장애가 일어난다.

👉🏻 상태를 유지(stateful)할 경우 발생하는 문제점 테스트

📁 test/singleton/StatefulServiceTest

class StatefulServiceTest {
    @Test
    void statefulServiceSingleton() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);
        
        // ThreadA : A사용자 10000원 주문
        statefulService1.order("userA", 10000);
        // ThreadB : B사용자 20000원 주문
        statefulService2.order("userB", 20000);
        
        // ThreadA : A사용자 주문 금액 조회
        int priceA = statefulService1.getPrice();
        // ThreadA : A사용자는 10000원을 기대했지만, 기대와 다르게 20000원 출력
        System.out.println("priceA = " + priceA);

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

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

• statefulSerivce는 싱글톤으로 사용자A가 사용하는 statefulSerivce1과 사용자B가 사용하는 statefulService2는 같은 객체이다. 따라서 사용자A와 사용자B는 같은 객체의 price 필드에 접근하게 된다.
• 사용자A의 주문금액을 호출했는데, 10000이 아닌 20000원이라는 결과가 나온 것을 확인 할 수 있다.
• 이러한 문제가 발생할 수 있기 때문에 스프링 빈은 항상 무상태로 설계하는 것이 중요하다.

 

👉🏻 무상태 설계 수정 예시

public class StatefulService {
    // private int price; // 공유필드는 사용하지 말자

    public int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        // this.price = price; // 값을 넣는 행위 금지, 읽기만 하자
        return price;
    }

    /* 사용하지 말자
    public int getPrice() {
        return price;
    }
    */
}

 

 

@Configuration과 싱글톤

@Configuration의 역할이 무엇일까?

@Bean을 해주면 해당 인스턴스를 Bean에 등록해주는데, @Configuration을 명시하는 것과 안하는게 무슨 차이일까?

 

@Configuration의 유무 차이는 각각의 인스턴스 call 횟수를 통해 확인 할 수 있다.

📁 AppConfig

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

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

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

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

• 스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성한다.
• 그 과정에서 memberRepository()는 3번 호출되는 것처럼 보인다.
  1. 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean이 붙어있는 memberRepository() 호출
  2. memberService() 로직에서 memberRepository() 호출
  3. orderService() 로직에서 memberRepository() 호출

결과적으로 각각 다른 MemberRepository가 생성되면서 싱글톤이 깨지지 않나? 하는 의문이 들 수 있다.

스프링 컨테이너는 이러한 문제를 어떻게 해결하는지 테스트를 통해 알아보도록 하자.

 

👉🏻 @Configuration이 있는 경우 테스트

📁 test/singleton/ConfigurationSingletonTest

public class ConfigurationSingletonTest {
    @Test
    void configurationTest() {
        ApplicationContext 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("memberService -> memberRepository = " + memberRepository1);
        System.out.println("orderService -> memberRepository = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);

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

• 결과를 보면 memberRepository 인스턴스는 모두 같은 인스턴스(@c055c54)가 공유되어 사용되는 것을 확인할 수 있다.
• AppConfig의 자바 코드만 보면 각각 new MemoryMemberRepository();를 호출해 다른 인스턴스가 생성될 것이라 예상했는데 싱글톤으로 관리되었다.
• call 로그를 찍어서 확인해보면 new MemoryMemberRepository();가 단 1번만 호출되어 싱글톤이 보장된 것을 확인할 수 있다.

 

👉🏻 @Configuration이 없는 경우 테스트

• @Configuration이 없는 경우, 호출될 때마다 call 로그가 찍혀 여러번 호출이 일어나고 싱글톤이 보장되지 않는 것을 확인할 수 있다.

 

 

CGLIB 라이브러리

@Configuration을 사용했을 때 어떻게 스프링은 싱글톤을 보장하는 걸까? 그 비밀은 CGLIB 라이브러리에 있다.

• 스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해줘야 한다.
• 스프링은 @Configuration을 붙이면 클래스의 바이트코드를 조작하는 CGLIB 라이브러리를 사용해 싱글톤을 보장한다.

@Test
void configurationDeep() {
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);    
    AppConfig bean = ac.getBean(AppConfig.class);
	
    System.out.println("bean = " + bean.getClass());
}

• AnnotationConfigApplicationContext에 파라미터로 넘긴 AppConfig을 스프링 빈으로 등록된다.
• AppConfig 스프링 빈으로 조회해서 클래스 정보를 출력 한 결과 순수한 클래스명이 아닌 $$xxxCGLIB이 붙은 것을 확인 할 수 있다.
• 이는 우리가 만든 AppConfig가 아닌 스프링이 CGLIB이라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들어, 이를 스프링 빈으로 등록한 것을 의미한다.
• 이때 해당 임의의 다른 클래스가 스프링 빈이 싱글톤을 보장되도록 한다.
• AppConfig@CGLIB을 통해 @Bean이 붙은 메소드마다 이미 스프링이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
• 이 덕분에 @Configuration을 사용해 싱글톤이 보장될 수 있다.

 

💡 정리

• @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다.
• 싱글톤 보장을 위해 스프링 설정 정보는 항상 @Configuration을 사용하자!