[Spring] Basic, 싱글톤 컨테이너

웹 어플리케이션과 싱글톤

---

웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.
이때 만명 이상이 동시에 요청을 한다고 가정해 보자.

그럼 스프링 컨테이너에서 서비스 계층으로 주입되어야 할 객체들은 몇 번 생성돼야 하는가? 한 서비스 계층 당 하나의 빈들만 주입해야 한다고 해도 만개 이상의 객체가 생성되고 사용되는 과정을 거쳐야 한다.
이런 과정은 비효율적이고 메모리 낭비다.

확인 코드 작성

public class SingleToneTest {

    @Test
    @DisplayName("스프링 없는 순수한 DI 컨테이너")
    void pureContainer() {
        AppConfig appConfig = new AppConfig();
        
        //1. 조회: 호출할 때마다 객체 생성
        MemberService memberService1 = appConfig.memberService();

        //2. 조회: 호출할 때마다 객체 생성
        MemberService memberService2 = appConfig.memberService();

        //3. 참조 값 확인
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        //memberService != memberService2
        assertThat(memberService1).isNotSameAs(memberService2);
    }
}

✅ 조회한 각각의 빈의 참조 주소가 다르게 나온다.

이전 포스팅에서 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다. 고객 트래픽이 초당 10,000이 나오면 초당 10,000개 객체가 생성되고 소멸된다.

해결 방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. 👉 싱글톤 패턴

싱글톤 패턴

---

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

    private SingletonService() {
    }

    public static SingletonService getInstance() {
        return instance;
    }
    
    public void logic() {
        System.out.println("called singleton");
    }
}

• 기본 생성자를 private로 만들어서 외부에서 해당 서비스를 생성할 수 없도록 막아놨다.

  • 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

• 프로젝트 구동시 최초 1회 생성되고 그 이후 어디서도 해당 서비스를 생성할 수 없다.

• 해당 서비스가 필요하면 getInstance() 메서드를 통해서 해당 서비스를 조회해서 사용할 수 있고, 이는 항상 같은 인스턴스를 반환한다.

그럼 이번에는 싱글톤 패턴으로 작성한 SingletonService를 테스트 코드를 통해 정말 동일한 인스턴스를 반환하는지 확인해 보자.

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonService() {
    SingletonService instance1 = SingletonService.getInstance();
    SingletonService instance2 = SingletonService.getInstance();

    System.out.println("instance1 = " + instance1);
    System.out.println("instance2 = " + instance2);
    
    assertThat(instance1).isSameAs(instance2);
}

✅ 조회한 각각의 빈의 참조 주소가 같다.

• isSameAs는 동일성 비교로 연산자 == 와 동일하며 isEqualTo가 동등성 비교로 equals 연산자와 동일하다.
  ✅ 간단히 말해 동일성 비교는 참조 값 비교, 동등성 비교는 내용물(값) 비교

스프링 컨테이너를 쓰면 자체적으로 빈들을 싱글톤으로 만들어서 사용한다. 그렇기에 실제로 스프링 컨테이너를 사용할 때는 스프링 빈들을 다 싱글톤으로 만들어줄 필요는 없다.

싱글톤 패턴 문제점
싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
의존관계상 클라이언트가 구체 클래스에 의존 👉 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);

 	//3. 참조 값이 같은 것을 확인
 	System.out.println("memberService1 = " + memberService1);
 	System.out.println("memberService2 = " + memberService2);
 
 	//memberService1 == memberService2
 	assertThat(memberService1).isSameAs(memberService2);
}

이처럼 싱글톤 컨테이너가 적용되면 많은 사용자가 각각 요청을 할 때마다 하나의 인스턴스를 공유해서 사용함으로써 효율적으로 재사용이 가능해진다.

싱글톤 방식의 주의점

---

싱글톤 컨테이너든, 싱글톤 패턴이든 싱글톤을 사용한다면 주의해야 하는 부분이 있다.

싱글톤 패턴에서는 객체 인스턴스를 하나만 생성해서 공유하는 방식이기 때문에 여러 클라이언트에서 해당 인스턴스를 공유하게 된다. 그렇기 때문에 해당 객체가 상태를 유지하는 stateful 방식의 객체이면 문제가 발생한다.

그렇기 때문에 상태를 유지하지 않는 stateless 상태로 객체를 설계해야 한다.

상태를 유지하지 않는 객체를 설계하기 위해서는

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

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

StatefulService

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

StatefulServiceTest

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

        statefulService1.order("userA", 10000);
        statefulService2.order("userB", 20000);

        System.out.println("statefulService1.getPrice() = " + statefulService1.getPrice());
        assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

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

분명 10000원을 주문한 userA의 pirce를 조회하는데 어째서 값이 20000원일까?

이는 두 개의 객체 인스턴스인 statefulService1과 statefulService2가 같은 객체 인스턴스 StatefulService 객체를 바라보기 때문인데, statefulService1에서 userA가 10000원을 주문하면서 price에 10000원이 대입되었지만, 그 뒤 statefulService2에서 userB가 20000원을 주문했다. 그래서 price에는 20000원이 대입되는데 여기서 price 필드는 싱글톤으로 하나의 객체 인스턴스를 통해 공유되기 때문에 userA는 자신이 주문한 뒤 주문한 userB의 금액이 입력되는 것이다.

그렇기에, 싱글톤을 사용할 때는 해당 객체 인스턴스에 공유 필드가 있어서는 안 된다.

즉, 싱글톤을 사용하려면 상태가 없어야(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();
    }

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

여기서 memberService와 orderService를 보자. 각각 자신의 구현체를 생성해서 반환하는데, 그 내부 파라미터를 보면 둘 다 memberRepository를 호출하고 있다.

그런데, 여기서 memberRepository 내부 코드는 MemoryMemberRepository 인스턴스를 생성해 반환하는 것이다. 그럼 memberService, orderService, memberRepository에서 총 세 번 내부 코드가 실행되는데, 싱글톤이 어떻게 유지되는지 의아할 것이다. 우리의 생각대로라면 해당 구성 정보의 빈들이 등록되면 memberService와 orderService, memberRepository에서 꺼낸 각각의 memberRepository의 객체 참조 주소가 달라야 한다. 이를 코드를 통해 바로 확인해 보자.

MemberServiceImpl

public class MemberServiceImpl implements MemberService{
    ...

    //for Test
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

OrderServiceImpl

public class OrderServiceImpl implements OrderService{
		...

    //for Test
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

ConfigurationSingletonTest

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("memberRepository = " + memberRepository);
        System.out.println("memberService.getMemberRepository() = " + memberService.getMemberRepository());
        System.out.println("orderService.getMemberRepository() = " + orderService.getMemberRepository());

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

실행 결과를 보면 세 가지 빈의 memberRepository의 참조 값이 모두 같은 걸 알 수 있다.

코드상으로 memberRepository가 3번 호출되면 MemoryMemberRepository 객체 인스턴스는 3번 생성되어야 맞는데 어째서 모두가 동일한 것인가?

이를 확인하기 위해 AppConfig에 로깅 코드를 넣어서 확인해 보자.

AppConfig

@Configuration
public class AppConfig {

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

    @Bean
    public OrderService orderService() {
        System.out.println("AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

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

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

// 실행 결과
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService

실행 결과를 확인해 보면 예상과는 다르게 memberRepository 메서드는 단 한 번만 호출되었다.
어째서 그럴까?

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

---

이 의문점에 대한 정답은 @Configuration 어노테이션에 있다.
다음 테스트를 실행해 보면서 @Configuration 어노테이션을 적용한 AppConfig.class의 클래스 타입을 확인해 보자.

public class ConfigurationSingletonTest {

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

// 실행 결과
bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70

하지만, 실행 결과는 AppConfig 뒤에 접미사가 많이 붙어있다. 왜 이런 걸까? 이유는 스프링에서 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록했기 때문이다.

이렇게 바이트코드 조작을 통해 만들어진 AppConfig@CGLIB에서 싱글톤이 보장되도록 해준다. 그러면서도 해당 객체는 AppConfig의 자식 타입으로 만들어져 AppConfig 타입으로 조회가 가능하다.

내부 로직은 아마도 스프링 빈이 없으면 기존 클래스의 생성 로직을 수행하고, 스프링 빈이 있을 경우 존재하는 스프링 빈을 반환하도록 로직이 되어있을 것이다.

그렇다면 @Configuration을 적용하지 않고 @Bean만 적용한다면?
AppConfig에서 @Configuration 어노테이션을 뺀 상태로 실행을 해보자.

// 실행 결과
bean = class hello.core.AppConfig

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

//실행 결과
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
call AppConfig.memberRepository

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

✅ 스프링 설정 정보는 항상 @Configuration 을 사용하자.