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

Spring

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

아윤_ 2023. 8. 30. 19:07

싱글톤 컨테이너

웹 애플리케이션과 싱글톤

스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생한 기술이다. 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 물론, 웹이 아닌 애플리케이션 개발도 얼마든지 가능하다.

웹 애플리케이션에서는 보통 수많은 고객이 동시에 요청을 한다.

그림은 클라이언트 A, B, C 세 명이 스프링 컨테이너인 DI 컨테이너에 있는 memberService를 동시에 요청하는 모습이다. 이 경우, 요청을 할 때마다 새로운 memberService 객체가 반환되게 된다. 지금은 클라이언트가 세 명밖에 없지만, 실제 웹 애플리케이션의 경우 수많은 고객이 동시에 요청을 하기 때문에 문제가 발생하게 된다.

실제 코드를 통해 해당 상황이 일어나는 경우에 대해 살펴보자.

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

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;

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

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 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다. 만약, 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸되기 때문에 메모리 낭비가 매우 심하다. 이를 해결하기 위해서는 해당 객체가 딱 1개만 생성되고, 공유하도록 설계해야 한다. 이러한 디자인 패턴을 싱글톤 패턴이라 부른다.

싱글톤 패턴

싱글톤 패턴이란, 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴을 말한다. 따라서, 객체 인스턴스가 2개 이상 생성되지 않도록 막아야 한다. 코드를 통해 싱글톤 패턴에 대해 자세히 살펴보자.

싱글톤 패턴을 적용한 예제 코드

package hello.core.singleton;

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance() {
        return instance;
    }

    /**
     * private 생성자를 통해 외부에서 두 개 이상 생성하지 못하도록 막는다.
     */
    private SingletonService() {

    }

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

싱글톤 패턴을 적용한 코드의 동작 과정은 다음과 같다.

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

이제 해당 싱글톤 패턴을 사용하는 테스트 코드를 살펴보자.

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

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

        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);

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

해당 코드를 통해 private으로 new 키워드로 instance를 생성하는 것이 불가능하기 때문에 getInstance()를 통해 객체 인스턴스를 조회하는 것을 알 수 있으며, 실제 실행 결과를 통해 호출할 때마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

※ 참고

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

싱글톤 패턴의 적용을 통해 고객의 요청이 올 때마다 객체를 생성하지 않고 이미 만들어진 객체를 공유해 사용하여 효율적으로 사용할 수 있다. 하지만, 싱글톤 패턴에는 많은 문제들이 존재한다.

싱글톤 패턴의 문제점

싱글톤 패턴을 사용할 경우, 싱글톤 패턴을 구현하는 코드가 많이 들어간다.
의존관계상 클라이언트가 구체 클래스에 의존하기 때문에 DIP를 위반한다.
또한, 클라이언트가 구체 클래스에 의존하여 OCP 원칙을 위반할 가능성이 높다.
유연하게 테스트하기가 어렵다.
내부 속성을 변경하거나 초기화하기 어렵다.
private 생성자로 자식 클래스를 만들기 어렵다.
결론적으로 유연성이 떨어지게 되고, 안티패턴이라 불리기도 한다.

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하고, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다. 지금까지 우리가 학습한 스프링 빈이 바로, 싱글톤으로 관리되는 빈이다.

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

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

 @Test
    @DisplayName("스프링 컨테이너와 싱긅톤")
    void springContainer() {

        AnnotationConfigApplicationContext 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)하게 설계하면 안 된다. 즉, 무상태(stateless)로 설계해야 한다.

무상태 설계

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

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

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

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; // 여기가 문제!!
    }

    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.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

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

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext 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();
        System.out.println("price = " + price);

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

    static class TestConfig {

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

해당 코드에서 ThreadA가 사용자 A 코드를 호출하고 ThreadB가 사용자 B 코드를 호출한다 가정했을 때, StatefulService의 price 필드는 공유되는 필드이므로 특정 클라이언트가 값을 변경할 수 있다.

따라서, 사용자 A가 자신의 주문 금액을 확인하였을 때, 10000원이 나와야 하는데 20000원이 나온 것을 확인할 수 있다. 실무에서도 실제로 이런 경우가 종종 발생되며, 이러한 경우, 문제를 잡기 매우 어렵기 때문에 공유 필드는 정말 정말 조심해서 사용해야 한다. 즉, 스프링 빈은 항상 무상태로 설계해야 한다.

@Configuration과 싱글톤

사실 @Configuration에는 비밀이 숨겨져 있는데, AppConfig를 통해 살펴보자.

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.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 MemoryMemberRepositoy()를 호출하게 된다.

orderService 빈을 생성하는 코드도 마찬가지로 memberRepository()를 호출하여 new MemoryMemberRepositoy()를 호출한다.

즉, 각각 다른 두 개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보인다. 스프링 컨테이너는 싱글톤을 사용한다 했는데, 어떻게 이 문제를 해결한 것일까? 직접 테스트를 통해 알아보자.

검증 용도의 코드 추가

MemberServiceImpl

package hello.core.member;

public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    public void join(Member member) {
        memberRepository.save(member);
    }

    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }

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

OrderServiceImpl

package hello.core.order;

        import hello.core.discount.DiscountPolicy;
        import hello.core.member.Member;
        import hello.core.member.MemberRepository;

public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        Member member = memberRepository.findById(memberId);
        int discountPrice = discountPolicy.discount(member, itemPrice);

        return new Order(memberId, itemName, itemPrice, discountPrice);
    }

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

테스트를 위해 MemberRepository를 조회할 수 있는 기능을 임시로 추가한다.

테스트 코드

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderService;
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;

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

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

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

실제로 결과를 확인해 보면, memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

AppConfig의 자바 코드를 보면 분명 각각 2번 'new MemoryMemberRepository' 호출해서 다른 인스턴스가 생성되어야 하는데 그렇지 않다.

이제 이 이유에 대해 다음 코드를 통해 알아보자.

AppConfig에 호출 로그 남기기

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

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

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

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

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

스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성한다. 그래서 memberRepository()는 다음과 같이 총 3번이 호출되어야 한다.

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

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

call AppConfig.memberService

call AppConfig.memberRepository

call AppConfig.orderService

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

스프링 컨테이너는 싱글톤 레지스트리이기 때문에 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 하지만, 스프링이 자바 코드까지 어떻게 하기는 어렵다. 저 자바 코드를 보면 분명 memberRepository()가 3번 호출되어야 하는 것이 맞다.

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

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

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

AnnotationConfigApplicationContext에 파라미터로 넘긴 값도 스프링 빈으로 등록되는데, AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해 보면, bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70과 같은 결과가 나오게 된다.

순수한 클래스일 경우, class hello.core.AppConfig 과 같이 출력되어야 한다.

예상과는 다르게 xxxCGLIB가 붙은 것을 볼 수 있는데, 이는 내가 만든 클래스가 아닌, 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 이 클래스를 스프링 빈으로 등록한 것이다.

그림과 같이 AppConfig를 이용해 CGLIB라는 바이트코드 조작 라이브러리를 가지고 AppConfig를 상속받아 다른 클래스를 하나 생성한다. 이 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다.

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

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

//@Configuration 삭제
public class AppConfig {

}

다음과 같이 @Configuration을 삭제하고, 똑같이 실행해 보자.

스프링 빈의 경우, bean = class hello.core.AppConfig 과 같이 출력된다. 이를 통해 AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.

또한, 다음과 같은 출력 결과가 나온다.

call AppConfig.memberService

call AppConfig.memberRepository

call AppConfig.orderService

call AppConfig.memberRepository

이를 통해 memberRepository 총 3번 호출된 것을 알 수 있다. 즉, 싱글톤이 깨지게 된다.

인스턴스가 같은지 테스트하는 코드를 실행하면, 다음과 같은 결과가 나온다.

memberService -> memberRepository = hello.core.member.MemoryMemberRepository@6239aba6

orderService -> memberRepository = hello.core.member.MemoryMemberRepository@3e6104fc

memberRepository = hello.core.member.MemoryMemberRepository@12359a82

출력 결과를 통해 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있다는 것을 알 수 있다. 이제 확인이 끝났으므로 @Configuration이 다시 동작하도록 돌려놓자.

정리

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

저작자표시 비영리 동일조건

'Spring' 카테고리의 다른 글

[스프링] 스프링 핵심 원리 기본편 정리: 7. 의존관계 자동 주입 (0)	2023.09.04
[스프링] 스프링 핵심 원리 기본편 정리: 6. 컴포넌트 스캔 (0)	2023.09.01
[스프링] 스프링 핵심 원리 기본편 정리: 4. 스프링 컨테이너와 스프링 빈 (0)	2023.08.27
[스프링] 스프링 핵심 원리 기본편 정리: 3. 스프링 핵심 원리 이해2 - 객체 지향 원리 적용 (0)	2023.08.17
[스프링] 스프링 핵심 원리 기본편 정리: 2. 스프링 핵심 원리 이해1 - 예제 만들기 (0)	2023.08.07

현재글[스프링] 스프링 핵심 원리 기본편 정리: 5. 싱글톤 컨테이너

공부 및 코딩 일지