스프링 핵심원리 기본편 - Ch05. 싱글톤 컨테이너

목록

1. 포스팅 개요
2. 본론
     2-1. 웹 애플리케이션과 싱글톤
     2-2. 싱글톤 패턴
     2-3. 싱글톤 컨테이너
     2-4. 싱글톤 방식의 주의점
     2-5. @Configuration과 싱글톤
     2-6. @Configuration과 바이트코드 조작의 마법
3. 요약

1. 포스팅 개요

인프런에서 영한님의 스프링 핵심 원리 기본편 Section05 싱글톤 컨테이너를 학습하며 정리한 포스팅이다.

| 참고 이전 포스팅

2. 본론

2-1. 웹 애플리케이션과 싱글톤

싱글톤

싱글톤은 객체가 프로젝트 생명주기에서 단 하나의 인스턴스만 존재하는 패턴을 의미한다.

• 스프링의 태생은 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
• 대부분의 스프링 애플리케이션은 웹 애플리케이션이다.
  • 웹이 아닌 애플리케이션 개발도 가능하다.

웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

다음 그림을 보자.

클라이언트가 동시에 요청을 하면, AppConfig.java로부터 memberService() 메서드로 생성된 MemberServiceImpl인스턴스가 생성되어 반환된다.
3번의 요청이 오면, 3개의 인스턴스가 반환되는 것이다.

즉 요청이 올 때마다 인스턴스를 생성해야한다는 문제가 있다.

먼저 스프링이 없는 순수한 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);

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

결과는 다음과 같다.

지금 보면 다른 인스턴스가 생성되고 있다.
이렇게 되면 jvm 메모리에 계속 객체가 생성되어 올라간다.
이처럼 객체가 계속 생성되는 건 효율적이지 않다.

그리고 사실 총 4개의 객체가 생성되었다.
memberService()에서 다른 팩토리 메서드를 호출하기 때문이다.

• 현재 스프링이 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다 객체를 새로 생성한다.
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! 메모리 낭비가 심하다.
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. 이것이 싱글톤 패턴이다.

이제 문제를 싱글톤 패턴으로 해결해보자.

2-2. 싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
• 그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
  • private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

싱글톤 인스턴스는 다음과 같이 선언하여 jvm 내에서 공유되도록 하면 된다.

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance() {
        return instance;
    }

    private SingletonService() {
    }

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

그리고 외부에서 생성하려고 해보자.

    public static void main(String[] args) {
        SingletonService instance = new SingletonService();
    }

다음과 같이 컴파일 오류가 발생한다.

경고메세지는 다음과 같다.

private으로 되어있어서 생성자에 접근하지 못한다고 한다.
따라서 호출하려면, getInstance()메서드로만 호출할 수 있다.
그리고 항상 같은 인스턴스를 반환한다.
딱 한 개의 객체 인스턴스만 존재하므로, 생성자를 private으로 막아서 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막아야 한다.

싱글톤 객체를 생성한 테스트 코드를 작성해보자.

    @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);
        // same => == 비교
        // equal => equals 비교
    }

결과는 다음과 같다.

싱글톤 객체 구현을 해봤으니 이제 AppConfig.java에서도 싱글톤으로 호출되게 하면된다.
고 생각하겠지만, 스프링 컨테이너에서 알아서 해준다.
싱글톤 패턴이 적용되면, 객체를 새로 생성하지 않고, 있는 객체를 재사용함으로써 성능을 더욱 효율적으로 사용할 수 있다.

그런데 싱글톤 패턴의 문제점도 있다.
다음과 같은 문제가 있다.

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다.
  • memberService()메서드 같은 경우, 구체 클래스인 MemberServiceImpl을 반환해야한다.
  • DIP를 위반한다.
  • 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
• 지정해서 가져와야 하기 때문에 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어진다.
  • 구체 클래스에 getInstance()를 사용해야 한다.
• 안티패턴으로 불리기도 한다.

2-3. 싱글톤 컨테이너

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

싱글톤 컨테이너

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

스프링 컨테이너에서 관리하는 객체가 싱글톤인지 확인해보자.

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

결과는 다음과 같다.

이처럼 싱글톤 패턴과 관련된 코드가 하나도 없다.
그리고 스프링 컨테이너를 통해서 싱글톤 컨테이너가 적용되면 위에서 보았던 세명의 클라이언트 요청으로 세 개의 인스턴스가 생성되는 그림은 다음처럼 바뀐다.

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

참고

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

2-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;
    }
}

테스트 코드는 다음과 같다.

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext 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 price = statefulService1.getPrice();

        System.out.println("price = " + price);

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

    static class TestConfig {

        @Bean // 싱글톤
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }

}

price는 얼마일까?
기대값은 1000원이지만, 20000원이 결과로 나온다.
사용자 A는 statefulService1, 사용자 B는 statefulService2를 사용하더라도 동일한 객체이기 때문에
사용자 B의 주문 정보가 설정되어있기 때문에 20000원이 나온다.

• StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.

따라서 진짜 공유필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자!

싱글톤 문제를 해결해보면 다음과 같다.

public class StatefulService {

    public int order(String name, int price) {
        System.out.println("name = " + name + ", price = " + price);
        return price;
    }
}

다음은 테스트 코드다.

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

        // ThreadA : A사용자 10000원 주문
        int userAPrice = statefulService1.order("userA", 10000);

        // ThreadB : B사용자 20000원 주문
        int userBPrice = statefulService2.order("userB", 20000);

        System.out.println("userAPrice price = " + userAPrice);
        System.out.println("userBPrice price = " + userBPrice);
    }

결과는 다음과 같다.

이처럼 지역변수로 사용되도록 변경했다.

중요한 것은 공유필드는 조심해야 한다!
스프링 빈은 항상 무상태(stateless)로 설계하도록 하자!

2-5. @Configuration과 싱글톤

AppConfig의 코드를 보자.

@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemoryMemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

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

@Bean memberService()를 호출하면 new MemoryMemberRepository()이 호출된다. 그리고,
@Bean orderService()를 호출하면 new MemoryMemberRepository()이 호출된다.

지금 new MemoryMemberRepository()가 두 번 호출되었다.
그럼 싱글톤이 깨지는 거 아닌가?하고 생각하는 것이 정상이다.
(ㅇㅇㅇㅇ 맞지 맞다...'')

과연 그런지 테스트해보자.

먼저 OrderServiceImpl과 MemberServiceImpl에서 다음과 같은 코드를 작성해주자.

    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }

테스트 코드는 다음과 같다.

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

   // Impl로 꺼내야 getMemberRepository() 호출 가능
   MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
   OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);

   MemberRepository memberRepository1 = memberService.getMemberRepository();
   MemberRepository memberRepository2 = orderService.getMemberRepository();

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

}

결과는 다음과 같다.

ac에서 그냥 memberRepository를 가져와보자.

MemberRepository memberRepository = ac.getBean("memberRepository", MemberRepository.class);

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

결과는 다음과 같다.

결과적으로 같은 인스턴스인 것을 확인할 수 있다.

AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository 호출해서 다른
인스턴스가 생성되어야 하는데, 혹시 두 번 호출이 안되는 것일 수도 있다.
다음 코드들로 확인해보자.

AppConfig.java에서 다음과 같이 메서드 중간에 출력문을 작성해준다.

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

@Bean
public MemoryMemberRepository 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());
}

call 메세지는 다음처럼 나와야 한다.

call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository

그럼 "call AppConfig.memberRepository" 메세지는 3번, 총 메세지는 5번 출력되어야 한다.
그리고 이전 테스트 코드를 돌려보자. 결과를 보면 다음과 같다.

call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService

기가 막히고 코가 막힐 노릇이다.

이처럼 스프링이 싱글톤을 보장해준다는 것을 느낄 수 있다.

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

스프링 컨테이너는 싱글톤 레지스트리다.
따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다.
자바 코드를 보면 분명 memberRepository()는3번 호출되어야 하는 것이 맞다.
그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

이에 대한 궁금증의 해결하는 열쇠는 @Configuration을 적용한 AppConfig.java 에 있다

AppConfig.class 자체를 확인해보자

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

   System.out.println("bean = " + bean.getClass()); // 클래스타입 확인
}

결과는 다음과 같다.

참고로 영한님은 이렇게 나온다.

보통 클래스 이름은 이렇게 나와야 정상이다.

bean = class hello.core.AppConfig

그런데 뒤에 무슨 이상한 게 붙었다.

bean = class hello.core.AppConfig$$SpringCGLIB$$0

클래스명에 에 xxxCGLIB가 붙었는데, 이것은 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

그림으로 보면 다음과 같다.

이 스프링이 만든 클래스가 바로 싱글톤이 보장되도록 해준다.
AppConfig@CGLIB는 다음처럼 만들어져 있을 것이다.(예상일 뿐이다.)

@Bean
public MemberRepository memberRepository() {

   if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
      return 스프링 컨테이너에서 찾아서 반환;
   } else { //스프링 컨테이너에 없으면
      기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
   return 반환;
   }
}

코드가 위와 같은 식으로 동작하기 때문에 싱글톤이 보장될 수 있는 것이다.

| 참고로 AppConfig@CGLIB는 AppConfig의 자식 타입이므로, AppConfig타입으로 조회되었던 것이다.

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

@Configuration을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약
@Bean만 적용하면 결과는 다음과 같다.
(AppConfig.java에서 @Configuration을 주석처리하고, configurationDeep을 테스트 한다.)

순수한 자바 클래스타입이 나왔다.
또한 다음 화면을 보면, (이미 보일 수 있겠지만...)

처음에 예상했던대로 출력문이 총 5번 호출된다.
즉 싱글톤이 깨진 것이다.

그리고 configurationTest()를 해보면 각각 다른 인스턴스가 출력된다.

그리고 또 다른 문제가 발생한다.
MemberServiceImpl에 주입된 MemberRepository는 스프링 빈이 아니다.

왜냐하면 AppConfig에서 return new MemberServiceImpl(...)을 반환해주기 때문이다.

참고로 @Autowired로 문제를 해결할 수 있다.

정리하자면,

• @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다.
• memberRepository()처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지
  않는다.
  그냥 @Configuration을 사용하자!

영한님과 나의 CGLIB가 결과가 달랐는데, 혹시나 GPT한테 물어봤다.

ㅇㅇ 맞다고 한다.

3. 요약

스프링은 싱글톤을 보장해준다.
싱글톤을 사용할 때 필드가 공유되지 않고, 무상태로 되도록 설계되도록 해야한다.

기분 좋게 마무리.