Spring 싱글톤 컨테이너

1️⃣ Web Application 과 싱글톤

• Spring 은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생
• 대부분의 Spring Application 은 Web Application 이다. 물론 Web 이 아닌 Application 개발도 얼마든지 개발할 수 있다.
• Web Application 은 보통 여러 고객이 동시에 요청을 한다.

 

Spring 이 없는 순수한 DI Container Test

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

 

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

 

2️⃣ 싱글톤 패턴

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

package hello.core.singleton;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.*;

public class SingletonService {

    // 1. static 영역에 객체를 딱 1개만 생성해둔다.
    private static final SingletonService instance = new SingletonService();

    // 2. public 으로 열어서 객체 인스턴스가 필요하면 이 static method 를 통해서만 조회하도록 허용한다.
    public static SingletonService getInstance() {
        return instance;
    }

    // 3. 생성자를 private 으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {
    }

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

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

 

Test Code

@Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    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);

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

        singletonService1.logic();

    }

• private 으로 new 키워드를 막아두었다.
• 호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

참고)
싱글톤 패턴을 구현하는 방법은 여러가지가 있다. 여기서는 객체를 미리 생성해두는 가장 단순하고 건전한 방법을 선택했다.

 

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

 

싱글톤 패턴 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어감.
• 의존관계상 클라이언트가 구체 클래스에 의존한다. -> DIP 를 위반함.
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 안티패턴으로 불리기도 한다.
• 싱글톤은 인스턴스를 미리 받아와서 설정이 다 끝나있기 때문에 유연하게 테스트하기 어렵다.
• 결론적으로 유연성이 떨어지는데, DI 를 적용하기 어렵다.

3️⃣ 싱글톤 컨테이너

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

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

Spring container 를 사용하는 Test Code

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

 

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

참고 )
Spring 의 기본 Bean 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때 마다 새로운 객체를 생성해서
반환하는 기능도 제공한다. (거의 99.9 % 정도 싱글톤 방식을 사용한다)

 

4️⃣ 싱글톤 방식의 주의점

• 싱글톤 패턴이든, Spring 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지 (stateful) 하게 설계하면 안된다.
• 무상태 (stateless) 로 설계해야 한다!
  • 특정 클라이언트에 의존적인 필드가 있으면 안된다.
  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
  • 가급적 읽기만 가능해야 한다.
  • 필드 대신에 Java 에서 공유되지 않는 지역변수, Parameter, ThreadLocal 등을 사용해야 한다.
• Spring Bean 의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다!

상태를 유지할 경우 발생하는 문제점 예시 + 해결방법

 package hello.core.singleton;

public class StatefulService {

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

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

//    public int getPrice() {
////        return price;
//    }
}

 

상태를 유지할 경우 발생하는 문제점 예시 + 해결방법 (Test)

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;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;

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원 주문
        int userAPrice = statefulService1.order("userA", 10000);
        // ThreadB : B 사용자 20000원 주문
        int userBPrice = statefulService2.order("userB", 20000);

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

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

    static class TestConfig {

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

• StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 실무에서 이러한 경우를 종종 볼 수 있는데, 이로 인해 정말 해결하기 어려운 큰 문제들이 터질 수 있다.
• 공유필드는 진짜로 조심해야 한다! Spring Bean 은 항상 무상태 (stateless) 로 설계해야 한다!

5️⃣ @Configuration 과 싱글톤

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

• memberService Bean 을 만드는 코드를 보면 memberRepository() 를 호출한다.
  • 이 method 를 호출하면 new MemoryMemberRepository() 를 호출한다.
• orderService Bean 을 만드는 코드도 동일하게 memberRepository() 를 호출한다.
  • 이 method 를 호출하면 new MemoryMemberRepository() 를 호출한다.

결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것 처럼 보인다.

Spring container 는 이 문제를 어떻게 해결할까?

 

검증 용도의 코드 추가

public class OrderServiceImpl implements OrderService{

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

public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

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

 

Test Code

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

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

        // 모두 같은 인스턴스를 참고하고 있음.
        Assertions.assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        Assertions.assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);

    }
}

• 확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
• AppConfig 의 Java code 를 보면 분명히 각각 두 번 new MemoryMemberRepository 호출해서 다른 인스턴스가 생성되어야 하지만 결과는 다르게 나왔다.

AppConfig 호출 로그

@Configuration
public class AppConfig {

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

    @Bean
    public MemberRepository memberRepository() {
        // 2번? 3번?
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }
    @Bean
    public OrderService orderService() {

        // 1번
        System.out.println("call AppConfig.orderService");
        return new OrderServiceImpl(
                memberRepository(),
                discountPolicy()
        );
    }
    
}

 

6️⃣ @Configuration 과 바이트코드 조작

Spring container 는 싱글톤 레지스트리이다. 따라서 Spring Bean 이 싱글톤이 되도록 보장해주어야 한다. 그런데, Spring 이 Java code 까지 어떻게 하기는 어렵다. 아래의 Java code 를 보면 분명 3번 호출이 되어야 하는 것이 맞다. 그래서 Spring 은 class 의 bytecode 를 조작하는 라이브러리를 사용한다.

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

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

        System.out.println("bean = " + bean.getClass());
        // 출력 : bean = class hello.core.AppConfig$$SpringCGLIB$$0
    }

• 사실 AnnotationConfigApplicationContext 에 parameter 로 넘긴 값은 Spring Bean 으로 등록된다. 그래서 AppConfig 도 Spring Bean 이 된다.
• AppConfig Spring Bean 을 조회해서 class 정보를 출력해보면 위와 같은 주석으로 나온다.
• 순수한 클래스라면 class hello.core.AppConfig 이렇게 출력이 되어야 한다.

하지만, 뒤에 xxxCGLIB 가 붙으면서 상당히 복잡해진 것을 볼 수 있는데, 이것은 사용자 본인이 만든 클래스가 아니라 Spring 이 CGLIB 라는 Bytecode 조작 라이브러리를 사용해서 AppConfig class 를 상속받은 임의의 다른 클래스를 만들고, 그 클래스를 Spring Bean 으로 등록한 것이다.

이 임의의 다른 클래스가 싱글톤이 되도록 보장해준다. 아마 다음과 같이 Bytecode 를 조작해서 작성되어 있을 것이다.

 

AppConfig@CGLIB 예상 코드

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

• @Bean 이 붙은 메서드마다 이미 Spring Bean 이 존재하면 @Bean 을 반환하고, Spring Bean 이 없으면 생성해서 Spring Bean 으로 등록하고 반환하는 코드가 동적으로 만들어진다.
• 이 때문에 싱글톤이 보장되는 것이다.

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

 

@Configuration 을 적용하지 않고 @Bean 만 적용한 경우

• @Configuration 을 붙이면 Bytecode 를 조작하는 CGLIB 기술을 적용하여 싱글톤을 보장하지만, @Bean 만 적용하면 순수한 AppConfig 로 Spring Bean 에 등록된다.
• 그러면 싱글톤이 깨진다.

정리

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