Section 5. 싱글톤 컨테이너

오늘은 싱글톤 컨테이너에 대해 알아볼 것이다.

🙄

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

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

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

🔗 코드 확인하기

위의 사진과 같이 세 명의 사람이 동시에 memberService를 요청할 때, 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청할 때마다 객체를 새로 생성한다.

이런 방법은 매우 비효율적이며 메모리 낭비도 심하다!

💡 해결방법

해당 객체가 딱 1개만 생성되고, 공유하도록 설계해주자! → 싱글톤 패턴!

✔ 싱글톤 패턴

클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴

그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
→ private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

싱글톤 패턴 적용하기

package hello.core.singleton;

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("싱글톤 객체 로직 호출");
    }
}

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

싱글톤 패턴을 사용하는 테스트 코드

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletoneServiceTest() {
	
    //private으로 생성자를 막아두었기 때문에, 컴파일 오류 발생한다.
    //new SingletonService();
    //1. 조회: 호출할 때마다 같은 객체를 반환
    SingletonService singletonService1 = SingletonService.getInstance();
    //2. 조회: 호출할 때마다 같은 객체를 반환
    SingletonService singletonService2 = SingletonService.getInstance();

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

    //memberService1 == memberService2
    assertThat(singletonService1).isSameAs(singletonService2);
    singletonService1.logic();
}

• private으로 new 키워드를 막아두었기 때문에 생성자를 만들려고 하면 컴파일 오류가 발생한다.
• 호출할 때마다 같은 객체 인스턴스를 반환하는 것을 알 수 있다.

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

싱글톤 패턴의 문제점

• 싱글톤 패턴을 적용하기 위해 구현할 코드의 양이 많아지면서 비용이 늘어난다.
• 의존관계상 클라이언트가 구체 클래스에 의존하게 되면서, DIP, OCP 원칙을 위반하게 된다.
• 테스트하기 어렵다. (인스턴스를 미리 다 받아서 설정이 끝난 상태이기 때문에 유연한 테스트를 하기 힘들다.)
• 내부 속성을 변경하거나 초기화하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어진다.
• 안티패턴(anti-pattern)으로 불리기도 한다.

📌 안티패턴
실제 많이 사용되는 패턴이지만 비효율적이거나 비생산적인 패턴을 말한다.

전체 코드 확인하기

🔗 코드 확인하기

✔ 싱글톤 컨테이너

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

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

싱글톤 컨테이너 적용 후

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

🔗 코드 확인하기

✔ 싱글톤 방식의 주의점

잠깐!! 싱글톤 방식에서 주의해야하는 부분이 있다.
이 부분에서 실수하면 해결하는 과정도 어렵고 대형 사고가 날 수도 있으므로 잘 알아두자!!

싱글톤 상태를 유지(stateful)하도록 설계하면 안된다.

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

무상태로 설계하기 위해서는

✔ 특정 클라이언트에 의존적인 필드가 있으면 안된다.
✔ 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다!
✔ 가급적 읽기만 가능해야 한다.
✔ 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다!!

상태를 유지할 경우 발생하는 문제점 예시

ThreadA가 사용자 A 코드를 호출하고, ThreadB가 사용자 B 코드를 호출한다고 가정하자.
StatefulService의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
사용자A의 주문금액은 10,000원이 되어야 하는데, 20,000원이라는 결과가 나왔다!

❌ 이렇게 특정 클라이언트가 값을 변경할 수 있도록 코드를 작성하면 안된다!

🔗 코드 확인하기

✔ @Configuration과 싱글톤

여기서 잠깐! 다음의 코드를 보자!

@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도 memberRepository()를 호출해서 new MemoryMemberRepository()를 호출하고, orderService도 memberRepository()를 호출해서 new MemoryMemberRepository()를 호출하면 결과적으로 각각 다른 MemoryMemberRepository 가 생성되어 싱글톤이 깨지는 것 아니야?!

그런데 분명 스프링 컨테이너는 빈들을 하나만 생성해서 관리한다고 했는데,,

테스트를 통해 알아보자!

🔗 코드 확인하기

MemberRepository를 조회하는 기능을 추가해서 출력해보면 놀랍게도 같은 인스턴스가 공유되어 사용되고 있음을 확인할 수 있다!

왜죠,,?

분명 자바 코드 상으로는 다음의 과정으로 memberRepository()를 3번 호출해야 한다.

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

하지만 출력 결과 모두 1번만 호출된다..! 😵

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

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

스프링 컨테이너는 싱글톤 레지스트리이기 때문에 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.

그런데 스프링이 자바 코드까지 조작하기는 어렵기 때문에 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

잡았다 요놈!
모든 비밀은 @Configuration을 적용한 AppConfig에 있었다!

아래의 코드를 실행시켰을 때 결과가 어떻게 나올까?

@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가 나와야 할 것이다.

하지만 실제 출력 결과는..!

이렇게 클래스 명 뒤에 뭔가 되게 많이 붙어있는 것을 확인할 수 있다.
이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록했기 때문이다!

그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다.
아마도 다음과 같이 바이트 코드를 조작해서 작성되어 있을 것이다. (실제로는 매우 복잡하다.)

AppConfig@CGLIB 예상 코드

@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고,
스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
→ 덕분에 싱글톤이 보장되는 것이다!

🔗 코드 확인하기

📌 추가적으로

@Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다.
그러므로 @Configuration을 사용하도록 하자!

📘 오늘의 TIL 정리

싱글톤 어렵다,, 꼭 복습하자,,