[스프링 기본] 싱글톤 컨테이너

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

 

 

웹 애플리케이션과 싱글톤

- 스프링은 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.

- 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 물론 웹이 아닌 애플리케이션도 개발할 수 있다.

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

- 클라이언트가 요청할 때마다 객체가 생성된다. (비효율)

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

public class SingletonTest {

    @Test
    @DisplayName("스프링 없는 순수한 DI 컨테이너")
    void pureContainer() {
        AppConfig appConfig = new AppConfig();
        //호출할 때마다 객체 생성
        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);
    }
}

- 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청할 때마다 객체를 생성한다.

- 객체가 1개만 생성되고, 공유하도록 설계하자 

 

인텔리제이 단축키

- 새 클래스 생성 : command + N

 

싱글톤 패턴

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


}

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

- 따라서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.

- 동작 방식

 ㄴ static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.

 ㄴ 이 객체 인스턴스는 getInstance() 메서드를 통해서만 조회할 수 있다.

 ㄴ 생성자를 private으로 막아서 외부에서 새로운 객체 인스턴스가 생성되는 것을 방지한다.

 

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

- private으로 new 키워드를 막아두었기 때문에 호출할 때 마다 같은 객체 인스턴스를 반환한다.

- isSameAs : 객체의 참조 비교

- isEqualTo : 객체의 값 비교

 

싱글톤 패턴을 적용하면 고객의 요청마다 객체를 생성하지 않고, 이미 만들어진 객체를 공유하여 효율적으로 사용할 수 있다. 그러나 싱글톤 패턴에는 여러 문제점이 있다.

 

싱글톤 패턴 문제점

- 구현 코드가 복잡해진다.

- 클라이언트가 구체 클래스에 의존해 DIP와 OCP 원칙을 위반할 가능성이 높다.

- 테스트가 어렵다.

- 내부 속성 변경이나 초기화가 어렵다.

- private 생성자로 인해 자식 클래스를 만들기 어렵다.

- 유연성이 떨어지며, 안티패턴으로 불리기도 한다.

 

싱글톤 컨테이너

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

지금까지 학습한 스프링 빈이 싱글톤으로 관리되는 빈이다.

 

싱글톤 컨테이너

- 스프링 컨테이너는 싱글톤 패턴 없이도 객체 인스턴스를 싱글톤으로 관리한다.

- 스프링 컨테이너는 싱글톤 컨테이너 역할을 하며, 이를 싱글톤 레지스트리라 한다.

- 지저분한 코드 없이 DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

 

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

 

- 스프링 컨테이너 덕분에 고객의 요청마다 객체를 생성하지 않고, 이미 만들어진 객체를 공유하여 효율적으로 재사용할 수 있다.

 

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

 

싱글톤 방식의 주의점

싱글톤 방식에서는 여러 클라이언트가 하나의 객체를 공유하므로, 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안 된다.

package hello.core.singleton;

public class StatefulService {

    private int price; //상태를 유지하는 필드

    public void order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        this.price = price; //여기가 문제!!!!! 10000 -> 20000
    }

    public int getPrice() {
        return price;
    }

}

package hello.core.singleton;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

class StatefulServiceTest {

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

        //A사용자 10000원 주문
        statefulService1.order("userA", 10000);
        //B사용자 20000원 주문
        statefulService2.order("userB", 20000);

        //A사용자 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price = " + price); // 20000원 나옴

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

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

- 사용자 A는 10000원을 주문 했는데 2000원이라는 결과가 나왔다.

- StatefulService의 price필드가 공유되는 필드인데, 특정 클라이언트(사용자 B)가 값을 변경했기 때문이다.

 

따라서, 스프링 빈은 항상 무상태(stateless)로 설계해야한다.

 

@Configuration과 싱글톤

AppConfig 코드에서 이상한 점이 있다. 

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

- memberService와 orderService 빈을 만드는 코드는 둘 다 memberRepository()를 호출하며,

이 메서드는 new MemoryMemberRepository()를 호출한다.

 

각기 다른 2개의 MemoryMemberRepository가 생성되어 싱글톤이 깨지는 것처럼 보인다.

 

MemberServiceImpl

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

 

OrderServiceImpl

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

- 테스트를 위해 MemberServiceImpl과 OrderServiceImpl에 MemberRepository를 조회할 수 있는 기능을 추가한다.

 

테스트코드

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

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

    }
}

- AppConfig의 자바 코드를 보면 분명히 두 번 new MemoryMemberRepository가 호출되어 다른 인스턴스가 생성되어야 한다.

- 하지만, memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다. 

 

어떻게 된 일일까? 실험을 통해 알아보자.

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

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

하지만 결과는 모두 1번만 호출된다.

 

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

스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해야 한다.

그러나 스프링이 자바 코드까지 직접 제어하기는 어렵다. 자바 코드 상에서는 3번 호출되는 것이 맞다.

이를 해결하기 위해 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

모든 비밀은 @Configuration이 적용된 AppConfig에 있다.

 

ConfigurationSingletonTest 코드

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

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

- AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 따라서 AppConfig도 스프링 빈이 된다.

- 순수한 클래스라면 class hello.core.AppConfig와 같이 출력되어야 한다. 

 

그렇다면 뒤에 붙은 $$SpringCGLIB$$0은 뭘까?

 

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

그 임의의 클래스가 싱글톤을 보장한다. 바이트 코드를 조작하여 다음과 같이 작성된 것처럼 동작할 것이다.

(실제로는 CGLIB의 내부 기술을 사용하는데 매우 복잡하다.)

 

AppConfig@CGLIB 예상 코드

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

- @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 그 빈을 반환하고

- 스프링 빈이 없으면 새로 생성하여 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.

- 덕분에 싱글톤이 보장된다.

 

 

그럼 @Configuration을 적용하지 않고 @Bean만 적용하면 어떻게 될까?

 

//@Configuration
public class AppConfig {

- AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.

- MemberRepository가 총 3번 호출된 것을 알 수 있다. 1번은 @Bean에 의해 스프링 컨테이 너에 등록하기 위해서이고, 2번은 각각 memberRepository()를 호출하면서 발생한 코드다.

 

인스턴스가 같은지도 테스트해보자

 

configurationTest()

- 각각 다른 MemoryMemberRepository 인스턴스를 가진다.

 

정리

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