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

[cyzlcyzl]

웹 애플리케이션과 싱글톤

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

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

• 스프링이 없는 순수한 DI 컨테이너는 요청을 할 때마다 객체를 새로 생성함
• 고객 트래픽에 따라 수많은 객체가 생성되고 소멸됨 → 메모리 낭비

solution ➡️ 객체가 딱 1개만 생성되고 공유하도록 설계: 싱글톤 패턴

💡참고 isEqualTo와 isSameAs의 차이

isEqualTo: 내용 자체를 비교
isSameAs: 인스턴스 참조 값 (주소) 비교

싱글톤 패턴

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

싱글톤 패턴 적용 코드

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

💡 참고 또 다른 싱글톤 패턴 코드

class Singleton {
    private static Singleton one;

    private Singleton() {
    }

    public static Singleton getInstance() {
        if(one==null) {
            one = new Singleton();
        }
        return one;
    }
}

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

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
public void singletonServiceTest() {
    // private으로 생성자를 막아두었다. 컴파일 오류가 발생한다.
    // new SingletonService();

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

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

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

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

🚫 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어감
• 의존관계상 클라이언트가 구체 클래스에 의존 ➡️ DIP 위반
• DIP를 위반했기 때문에 OCP 원칙 역시 위반할 가능성이 높음
• 테스트하기 어려움
• 내부 속성을 변경하거나 초기화 하기 어려움
• private 생성자로 자식 클래스를 만들기 어려움

➡️ 결론적으로 유연성이 떨어지고 안티패턴으로 불리기도 한다.

싱글톤 컨테이너

• 싱글톤 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리
  • 컨테이너 생성 과정을 떠올려보면 컨테이너는 객체를 하나만 생성해서 관리함
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 함 ➡️ 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 함
• 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있음
  • 싱글톤 패턴을 위한 별도의 코드가 들어가지 않아도 됨
  • DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있음

스프링 컨테이너를 사용하는 테스트 코드

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
    ApplicationContext ac = new
            AnnotationConfigApplicationContext(AppConfig.class);
    
    // 1. 조회: 호출할 때 마다 같은 객체를 반환
    MemberService memberService1 = ac.getBean("memberService", MemberService.class);
    
    // 2. 조회: 호출할 때 마다 같은 객체를 반환
    MemberService memberService2 = ac.getBean("memberService", MemberService.class);
    
    // 참조값이 같은 것을 확인
    System.out.println("memberService1 = " + memberService1);
    System.out.println("memberService2 = " + memberService2);
    
    // memberService1 == memberService2
    assertThat(memberService1).isSameAs(memberService2);
}

스프링 컨테이너 적용 후

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

싱글톤 방식의 주의점

싱글톤 패턴이든 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 상태를 유지(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;
    }
}

• 필드로 인해 상태가 유지되고 있음

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

public 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);
        //ThreadB: B사용자 20000원 주문
        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();
        }
    }
}

• price 필드는 공유되는 필드인데, 클라이언트가 값을 변경함
• 사용자A의 주문금액은 10000원이 되어야 하는데 20000원이라는 결과가 나옴
• 공유필드 사용 조심! 스프링 빈은 항상 무상태(stateless)로 설계하자

@Configuration과 싱글톤

AppConfig 코드를 보면 new MemoryMemberRepository()가 memberService()와 orderService()에서 각각 호출되어 싱글톤이 깨지는 것처럼 보인다.

@Configuration
public class AppConfig {

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

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

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

테스트를 위해 테스트용 코드를 MemberServiceImpl과 OrderServiceImpl에 각각 추가해주고 AppConfig에 memberRepository()를 호출하는 곳에 System.out.println("call AppConfig.memberService"); 와 같은 호출 코드를 각각 추가해주었다.

테스트코드

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

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

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

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

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

결과

memberRepsoitory가 세 번 호출되어야 할 것 같지만 실제 코드를 보면 한번만 호출이 되며 각각 다른 곳에서 꺼낸 인스턴스의 주소값 역시 동일함을 확인할 수 있다.

@Configuration과 바이트코드 조작 🪄🔮

스프링 컨테이너는 싱글톤 레지스트리로 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. AppConfig의 자바 코드만 보면 memberRepository는 세 번 호출되어야 하는 것이 맞는데 실제로 호출 결과를 보면 한 번만 호출이 되었다. @Configuration 애노테이션이 클래스의 바이트코드를 조작하는 라이브러리를 사용하여 싱글톤이 되도록 보장해준다.

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

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

• AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록되기 때문에 AppConfig도 스프링 빈이 됨
• AppConfig 스프링 빈을 조회해서 클래스 정보를 출력하면 아래와 같이 출력된다.
  bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70

순수한 자바 클래스라면 class hello.core.AppConfig 이렇게 출력되어야 하는데 xxxCGLIB가 붙으면서 복잡해졌다. 이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

AppConfig@CGLIB 예상 코드

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

@Configuration을 적용하지 않고 @Bean만 적용한다면

호출 함수는 5번 호출된 것을 확인할 수 있고,

각각 생성된 `memberRepository`는 전부 다른 것을 확인할 수 있다.

➡️ @Bean만 사용해도 스프링 빈으로 등록은 되지만 @Configuration을 사용해야 싱글톤이 보장됨을 알 수 있다. 스프링 정보는 항상 @Configuration을 사용하자!