[Spring] 싱글톤 컨테이너

Spring

[Spring] 싱글톤 컨테이너

위시리 2025. 4. 5. 01:23

[김영한] 스프링 핵심 원리 - 기본편 Section 6. 싱글톤 컨테이너 강의 정리

01 웹 애플리케이션과 싱글톤

스프링은 기업용 온라인 서비스 기술을 지원하기 위해 탄생
대부분의 스프링 애플리케이션은 웹 애플리케이션이다. (웹이 아닌 다른 개발도 가능)
웹 애플리케이션은 보통 여러 고객이 동시에 요청

클라이언트의 요청마다 객체가 생성됨 (new) - 문제

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

		// test는 눈으로 확인하면 xxx, 꼭 자동화 시키기!
        // mem1 != mem2
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }
}

호출을 할 때마다 객체를 계속 새로 생성 - 소멸 : 메모리 낭비가 심하다..

→ 해결 : 객체가 1개만 생성되고 생성된 객체 인스턴스를 공유

02 싱글톤 패턴

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

package hello.core.singleton;

public class SingletonService {

    // 이렇게 생성하면 클래스 레벨에 생성되기 때문에 딱 1개만 생성됨 (static : 정적 변수, final : 재할당 불가)
    private static final SingletonService INSTANCE = new SingletonService();

    // 조회 : 인스턴스 참조를 꺼낼 수 있는 유일한 방법
    public static SingletonService getInstance() {
        return INSTANCE;
    }
    private SingletonService() {} // 다른 클래스에서 new하지 못하도록

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

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

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

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("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest() {
        SingletonService singletonService1 = SingletonService.getInstance();
        SingletonService singletonService2 = SingletonService.getInstance();

        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);
        
        Assertions.assertThat(singletonService1).isSameAs(singletonService2);
    }
}

Spring Container를 사용하면 알아서 객체를 싱글톤으로 관리해준다.

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

싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
의존 관계상 클라이언트가 구체 클래스에 의존한다. → DIP 위반 (getInstance 한 것을 불러와야 함)
클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
테스트가 어렵다.
내부 속성을 변경하거나 초기화하기 어렵다.
private 생성자로 자식 클래스를 만들기 어렵다.
유연성이 떨어진다. (dependency injection 적용이 어려움)
그래서 안티패턴으로 불리기도 한다.

03 싱글톤 컨테이너

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

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리
- 이전의 컨테이너 생성 과정을 보면, 컨테이너는 객체를 하나만 생성해서 관리한다.
- @Bean 생성하면 객체 인스턴스를 미리 생성해서 관리
스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. → 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다.
스프링 컨테이너의 이런 기능 덕분에 싱클톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.
- 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
- DIP, OCP, test, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

@Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
//        AppConfig appConfig = new AppConfig();
        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);
        
        Assertions.assertThat(memberService1).isSameAs(memberService2);
    }

싱글톤 컨테이너 적용 후

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

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

04 싱글톤 방식의 주의점

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

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

        // ThreadA : 사용자A 주문 금액 조회 -> 10000원이 출력될 것을 기대
        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();
        }
    }
}

(실제 스레드는 사용 x)
Thread A가 사용자 A 코드를 호출하고, Thread B가 사용자 B 코드를 호출한다고 가정하자.
StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
사용자 A의 주문 금액은 10,000원 이여야 하는데 20,000원이라는 결과가 나왔다.
실무에서 이런 경우를 종종 보는데, 이로인해 정말 해결하기 어려운 큰 문제가 발생한다.
공유필드는 진짜 조심해야 한다!! 스프링 빈은 상항 무상태(stateless)로 설계하자!!

해결 코드

package hello.core.singleton;

public class StatefulService {

    private int price; // 상태를 유지하는 필드 : 10000 -> 20000

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

    public int getPrice() {
        return price;
    }
}

price가 지역변수가 되어 사용자의 price가 return - 지역 변수는 공유 xxx

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.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        // ThreadA : A 사용자 10000원 주문
        int userAPrice = statefulService1.order("userA", 10000);
        // ThreadB : B 사용자 20000원 주문
        int userBPrice = statefulService2.order("userB", 20000);

        // ThreadA : 사용자A 주문 금액 조회 -> 10000원이 출력될 것을 기대
//        int price = statefulService1.getPrice();
        System.out.println("userAPrice = " + userAPrice);

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

    static class TestConfig {

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

10000원 정상 출력!

05 @Configuration과 싱글톤

@Configuration은 싱글톤을 위해 존재하는 것이다.

AppConfig.java

package hello.core;

import hello.core.discount.DiscountPolicy;
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 // APP 설정정보, 구성정보
public class AppConfig {

    @Bean // spring container에 등록됨
    public MemberService memberService() { // 생성자 주입 (injection)
        return new MemberServiceImpl(memberRepository());
    }

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

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

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

위 코드를 보면

memberService Bean을 만드는 코드를 보면, 'memberRepository( )' 를 호출
- 이 메소드를 호출하면 'new MemoryMemberRepository( )' 를 호출
orderService Bean을 만드는 코드도 동일하게, 'memberRepository( )' 를 호출
- 이 메소드를 호출하면 'new MemoryMemberRepository( )' 를 호출

결과적으로 각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것처러 보인다.
스프링 컨테이너는 이 문제를 어떻게 해결할 것인가?

Test

package hello.core.member;

public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository; // 인터페이스 -> 추상화에만 의존 (dip)

    // 생성자
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

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

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }
    
    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

package hello.core.order;

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

public class OrderServiceImpl implements OrderService {

    // dip : 어떤 것을 참조할지 구체적인 정보 x
    private final MemberRepository memberRepository; // 회원을 찾아야 함
//    private final DiscountPolicy discountPolicy = new FixDiscountPolicy(); // 고정 할인 정책 - 남배우가 직접 상대 여배우를 캐스팅 하는꼴
//    private final DiscountPolicy discountPolicy = new RateDiscountPolicy(); // 고정 할인 정책
    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); // Order를 만들어서 반환
    }
    
    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return 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 configurationSingletonTest() {
        ApplicationContext ac= new AnnotationConfigApplicationContext(AppConfig.class);

        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);

        MemberRepository memberRepository1 = memberService.getMemberRepository();
        MemberRepository memberRepository2 = orderService.getMemberRepository();
        MemberRepository memberRepository = ac.getBean("memberRepository", MemberRepository.class);

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

    }
}

결과는 다 같음!
왜 new가 세 번 되서 객체가 3개 생성될 줄 알았는데 다 같은 인스턴스 일까?

확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
AppConfig 의 자바 코드를 보면 3번 'new MemoryMemberRepository( )' 호출해서 다른 인스턴스가 생성되어야 하는데..

AppConfig에 호출 로그 남김

package hello.core;

import hello.core.discount.DiscountPolicy;
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;

// 앱에 대한 환경 구성 : 앱의 실제 동작에서 필요한 구현 객체를 생성하고
// 연결하는 책임을 가지는 별도의 클래스
// 객체의 연결과 생성

// @Bean MemberService -> new MemoryMemberRepository()
// @Bean OrderService -> new MemoryMemberRepository()
// 이러면 싱글톤이 깨지는가..? -> test

@Configuration // APP 설정정보, 구성정보
public class AppConfig {

    @Bean // spring container에 등록됨
    public MemberService memberService() { // 생성자 주입 (injection)
        System.out.println("AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

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

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

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

System.out.println("AppConfig.memberRepository"); 이 한 번만 호출됨

왜?

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

스프링 컨테이너는 싱글톤 레지스터이다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.
그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다. 자바 코드를 보면 'new MemoryMemberRepository( )' 가 3번 호출 되어야 할 것처럼 보인다.
이는 @Configuration 을 적용한 'AppConfig' 때문이다.

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 configurationDeep(){
        ApplicationContext ac= new AnnotationConfigApplicationContext(AppConfig.class);
        Object bean = ac.getBean(AppConfig.class);

        // 클래스 타입 출력 : bean = class hello.core.AppConfig$$SpringCGLIB$$0 / $$~ : spring이 만든 클래스 정보
        System.out.println("bean = " + bean.getClass());
    }
}

순수한 클래스라면 'bean = class hello.core.AppConfig' 와 같이 출력되어야 한다.
근데 왜 복잡하게 출력된걸까?

왜냐하면 내(개발자)가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이기 때문이다.

그 임의의 다른 클래스가 싱글톤을 보장하도록 해준다.

아마 다음과 같은 바이트 코드를 조작해서 작성되어 있을 것 (실제 CGLIB의 내부 기술을 사용하는데 매우 복잡)

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

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

참고

"AppConfig@CGLIB 는 AppConfig의 자식 타입이므로, AppConfig 타입으로 조회할 수 있다.

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

결론은 안붙여도 된다. 대신 문제가 있다.

@Configuration 을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, @Bean만 적용하면 어떻게 되는지 확인해보자 -

AppConfig.java 에서 @Configuration 삭제하고 실행시키면 테스트 코드의 출력 결과가 순수한 'bean = class hello.core.AppConfig' 가 출력된다.
이 출력 결과를 통해서 AppConfig가 CGLIB 기술 없이 순수한 AppConfig 로 스프링 빈에 등록된 것을 확인할 수 있다.

call AppConfig.memberService 
call AppConfig.memberRepository // @Bean에 의해 스프링 컨테이너에 등록
call AppConfig.orderService
call AppConfig.memberRepository // memberRepository()를 호출하면서 발생
call AppConfig.memberRepository // ''

이전에 봤던 new를 만날 때마다 new로 생성됨
따라서 'new MemoryMemberRepository( )' 가 3번 호출

@Configuration 가 없으면 스프링 컨테이너가 코드의 싱글톤을 관리해주지 않는다.

memberService -> memberRepository = hello.core.member.MemoryMemberRepository@6239aba6
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@3e6104fc
memberRepository = hello.core.member.MemoryMemberRepository@12359a82

당연히 인스턴스가 같은지에 대한 테스트도 실패
각 다른 MemoryMemberRepository 인스턴스를 가지고 있다.

** 정리

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

저작자표시