[Spring] 스프링 핵심 원리 - 기본편 섹션 5 싱글톤 컨테이너

본 내용은 인프런 김영한T 스프링 핵심원리 - 기본편 강의를 정리한 내용입니다:)

 

[Spring] 스프링 핵심 원리 - 기본편 섹션 5 싱글톤 컨테이너

🟦 웹 애플리케이션과 싱글톤

대부분의 스프링 애플리케이션은 웹 애플리케이션고, 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

스프링 없는 순수한 DI 컨테이너는 위 그림처럼 고객이 요청할때마다 객체가 만들어진다.

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

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

⬜ 싱글톤 패턴

package com.basic.basicproject.singleton;

public class SingletonService {
    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance() {
        return instance;
    }

    private SingletonService() { // 다른 곳에서 생성 못하게 ...
    }

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

객체를 미리 생성해두는 방법으로 싱글톤 패턴을 구성한다. private으로 new 키워드를 막아두었다.

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {

    // private 으로 생성자를 막아두어 컴파일 오류 발생
    // new SingletonService();

    // 호출할 때마다 같은 객체를 반환
    SingletonService singletonService1 = SingletonService.getInstance();
    SingletonService singletonService2 = SingletonService.getInstance();

    // 참조값이 같은 것을 확인
    System.out.println("singletonService1 = " + singletonService1);
    System.out.println("singletonService2 = " + singletonService2);

    // singletonService1 == singletonService
    assertThat(singletonService1).isSameAs(singletonService2);
}

singletonService1 = com.basic.basicproject.singleton.SingletonService@40e6dfe1 singletonService2 = com.basic.basicproject.singleton.SingletonService@40e6dfe1

이제 테스트를 해보면, 아까와 다르게, 호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

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

 

💢싱글톤 패턴 문제점

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

🧊 싱글톤 컨테이너

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

스프링 컨테이너(또는 싱글톤 레지스트리)는 싱글톤 컨테이너 역할을 한다.

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

    // 1. 조회: 호출할 때마다 같은 객체를 반환
    MemberService memberService1 = ac.getBean("memberService", MemberService.class);
    // 1. 조회: 호출할 때마다 같은 객체를 반환
    MemberService memberService2 = ac.getBean("memberService", MemberService.class);
    // 참조값이 같은 것을 확인
    System.out.println("memberService1 = " + memberService1);
    System.out.println("memberService2 = " + memberService2);

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

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

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

💥 싱글톤 방식의 주의점

싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다. 무상태(stateless)로 설계해야 한다!

• 특정 클라이언트에 의존적인 필드나, 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다!
• 클라이언트는 가급적 읽기만 가능해야 한다.
• 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
• 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다!!!

상태를 유지할 경우 발생하는 문제점 예시를 살펴보자. 먼저 아래처럼 stateful하게 가격을 유지하는 클래스를 만들어준다.

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

이제 테스트를 진행해보자. 위처럼 StatefulService 의 price 필드는 공유되는 필드인데, 아래처럼 특정 클라이언트가 값을 변경한다. 그래서 사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.

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);
        statefulService2.order("userB",20000);

        // ThreadA: 사용자A 주문 금액 조회
        int price = statefulService1.getPrice();
        // ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
        System.out.println("price = " + price);

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

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

}

name = userAprice = 10000 // 출력
name = userBprice = 20000
price = 20000

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

🤔 @Configuration과 싱글톤

여기서 한가지 의문이 든다.

1. AppConfig 코드에서, memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다.
   (이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.)
2. orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다.
   (이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다. )
3. 결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것 처럼 보인다. 
   스프링 컨테이너는 이 문제를 어떻게 해결할까?

테스트를 위해 임시로 MemberRepository를 조회할 수 있는 기능을 추가하고, 테스트를 해보자. 

public class MemberServiceImpl implements MemberService {
     private final MemberRepository memberRepository;
     //테스트 용도
     public MemberRepository getMemberRepository() {
     return memberRepository;
     }
}
public class OrderServiceImpl implements OrderService {
     private final MemberRepository memberRepository;
     //테스트 용도
     public MemberRepository getMemberRepository() {
     return memberRepository;
     }
}

public class ConfigurationSingletonTest {

    @Test
    void configurationTest() {
        AnnotationConfigApplicationContext 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);

        // 모두 같은 인스턴스를 참고하고 있다.
        System.out.println("memberService-> memberRepository = " + memberService.getMemberRepository());
        System.out.println("orderService -> memberRepository = " + memberService.getMemberRepository());
        System.out.println("memberRepository = " + memberRepository);

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

    }
}

memberService-> memberRepository = com.basic.basicproject.member.MemoryMemberRepository@512baff6 orderService -> memberRepository = com.basic.basicproject.member.MemoryMemberRepository@512baff6 memberRepository = com.basic.basicproject.member.MemoryMemberRepository@512baff6

확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다. AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository 호출해서 다른 인스턴스가 생성되어야 하는데!!!

 

아래와같이 AppConfig에서 로그를 확인할 수 있도록 수정하고, 다시 호출하면, 예상대로라면 아마 세번이 호출되어야 할 것이다.

1. 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean이 붙어있는 memberRepository() 호출
2. memberService() 로직에서 memberRepository() 호출
3. orderService() 로직에서 memberRepository() 호출

@Configuration
public class AppConfig {

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

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

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

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

그런데 출력 결과는 모두 1번만 호출된다. 즉 싱글톤이 유지되고있다는 말씀...!

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

스프링 컨테이너는 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 이를 위해 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

@Configuration 을 적용한 AppConfig 를 보자.AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래서 AppConfig 도 스프링 빈이 된다. 그러면 AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보자

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

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

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

call AppConfig.memberRepository
call AppConfig.memberService
call AppConfig.orderService
bean = class com.basic.basicproject.AppConfig$$SpringCGLIB$$0

그런데 마지막 줄을보면, 예상과는 다르게 클래스 명에 xxxCGLIB가 붙어있다.

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

위로 하여금 싱글톤이 보장되도록 해준다. (실제로는 CGLIB 내부 기술 사용)

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

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

🪄 참고 AppConfig@CGLIB는 AppConfig의 자식 타입이므로, AppConfig 타입으로 조회 할 수 있다.

이처럼 @Configuration 을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장한다.

그렇다면 @Configuration 을 적용하지 않고, @Bean 만 적용하면 어떻게 될까? 아래 출력 결과를 보자.

bean = class hello.core.AppConfig

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

위 출력 결과를 통해서 AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.

그리고 MemberRepository가 총 3번 호출되었다.

memberService -> memberRepository = hello.core.member.MemoryMemberRepository@6239aba6
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@3e6104fc memberRepository = hello.core.member.MemoryMemberRepository@12359a82

인스턴스가 같은지도 테스트해보면, 실패하고 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있음을 확인 가능하다!

 

 

🟢 정리

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