[스프링 기본] 05. 싱글톤 컨테이너

🖥️ 스프링 핵심 원리 - 기본편 (김영한, 인프런)

섹션5. 싱글톤 컨테이너

05-1. 웹 애플리케이션과 싱글톤

대부분의 스프링 애플리케이션은 웹 애플리케이션이다.

(물론 배치 애플리케이션, 데몬 애플리케이션 등 웹이 아닌 애플리케이션 개발도 얼마든지 가능하다.)

웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

이때 스프링 없는 순수한 DI 컨테이너(예 : AppConfig)는 고객이 요청을 할 때마다 객체를 새로 생성하므로 메모리 낭비가 심하다.

이를 해결하기 위해서는 해당 객체가 딱 1개만 생성되고 공유되도록 설계하면 된다.

-> 싱글톤 패턴

 

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

 

이미지 출처 : 강의자료

 

test/java/hello/core/singleton/SingletonTest.java

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 컨테이너")
    public 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);
    }

}

 

테스트 결과

 

 

memberService1과 memberService2의 참조값이 서로 다른 것을 알 수 있다.

 

05-2. 싱글톤 패턴

싱글톤 패턴

싱글톤 패턴은 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.

따라서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아두어야 한다.

 

싱글톤 패턴을 적용하기

    1. static 영역에 객체 인스턴스를 미리 하나 생성해서 올려둔다.

    2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다. 

    3. private 생성자를 사용해서 외부에서 임의로 new 키워드로 객체 인스턴스를 생성하는 것을 막는다.

 

(참고) static과 싱글톤에 대한 정리

https://moominie.tistory.com/14

06-5. 인스턴스 멤버와 정적 멤버

 

test/java/hello/core/singleton/SingletonService.java

package hello.core.singleton;

public class SingletonService {

    // 1. static 영역에 객체 인스턴스를 미리 하나 생성해서 올려둔다.
    private static final SingletonService instance = new SingletonService();

    // 2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
    public static SingletonService getInstance() {
        return instance;
    }

    // 3. private 생성자를 사용해서 외부에서 임의로 new 키워드로 객체 인스턴스를 생성하는 것을 막는다.
    private SingletonService() {

    }

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

 

test/java/hello/core/singleton/SingletonTest.java

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.*;

public class SingletonTest {

    @Test
    @DisplayName("스프링없는 순수한 DI 컨테이너")
    public 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);
    }

    @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    public void SingletonServiceTest() {

        // new 연산자로 객체 생성 불가
//        SingletonService singletonService = 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과 singletonService2의 참조값이 같은 것을 확인할 수 있다.

 

이렇게 싱글톤 패턴을 적용하면 고객의 요청이 올 때마다 객체를 새로 생성하지 않고, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.

하지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있다.

 

싱글톤 패턴의 문제점

    - 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.

    - 의존관계상 클라이언트가 역할이 아닌 구체 클래스에 의존한다. (예 : MemberServiceImpl.getInstance())

        -> DIP를 위반한다.

    - 위와 같은 이유로 OCP를 위반할 가능성이 높다.

    - 테스트하기 어렵다.

    - 내부 속성을 변경하거나 초기화하기 어렵다.

    - private 생성자로 자식 클래스를 만들기 어렵다.

    - 결론적으로 유연성이 떨어진다.

    - 안티패턴으로 불리기도 한다.

 

이러한 문제를 스프링은 어떻게 해결할까?

 

05-3. 싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서 객체 인스턴스를 싱글톤으로 관리한다.

지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

 

싱글톤 컨테이너

    - 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리한다.

    - 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

    - 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

        -> 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.

        -> DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

 

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

test/java/hello/core/singleton/SingletonTest.java

(생략)

    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    public 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);
    }
    
(생략)

 

테스트 결과

 

 

memberService1과 memberService2는 참조값이 같다.

즉, 스프링 컨테이너는 스프링 빈을 싱글톤으로 관리한다.

 

싱글톤 컨테이너

 

이미지 출처 : 강의자료

 

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

 

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

 

05-4. 싱글톤 방식의 주의점

    - 무상태(stateless)로 설계해야 한다.

        -> 싱글톤 방식은 객체 인스턴스를 하나만 생성해서 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.

    - 특정 클라이언트에 의존적인 필드가 있으면 안된다.

    - 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.

    - 가급적 읽기만 가능해야 한다.

    - 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

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

 

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

test/java/hello/core/singleton/StatefulService.java

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

}

 

test/java/hello/core/singleton/StatefulServiceTest.java

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

        // TreadA : A사용자 10000원 주문
        statefulService1.order("userA", 10000);

        // TreadB : B사용자 20000원 주문
        statefulService2.order("userB", 20000);

        // A사용자의 주문금액은 기대와 다르게 10000원이 아닌 20000원이 출력된다.
        System.out.println("userA의 주문 금액 : " + statefulService1.getPrice());

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

    public static class TestConfig {

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

}

 

테스트 결과

 

 

위의 테스트 예제에서 최대한 단순하게 설명하기 위해 실제 쓰레드는 사용하지 않았다.

ThreadA가 사용자A 코드를 호출하고, ThreadB가 사용자B 코드를 호출한다고 가정하자.

StatefulService의 price 필드는 공유되는 필드인데 특정 클라이언트에 의해 값이 변경되었다.

그 결과 사용자A의 주문금액은 10000원이 아닌 20000원이라는 결과가 나왔다.

실무에서 이럴 경우 해결하기 어려운 큰 문제들이 터지기 때문에 공유필드는 조심해야 한다.

-> 스프링 빈은 항상 무상태(stateless)로 설계하자!

 

지역변수를 사용해서 문제를 해결한 예

test/java/hello/core/singleton/StatefulService.java

package hello.core.singleton;

public class StatefulService {

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

    public int order(String name, int price) {

        System.out.println("name = " + name + ", price = " + price);

        return price;
    }

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

}

 

test/java/hello/core/singleton/StatefulServiceTest.java

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

        // TreadA : A사용자 10000원 주문
        int priceA = statefulService1.order("userA", 10000);

        // TreadB : B사용자 20000원 주문
        int priceB = statefulService2.order("userB", 20000);

        System.out.println("userA의 주문 금액 : " + priceA);

        assertThat(priceA).isEqualTo(10000);
    }

    public static class TestConfig {

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

}

 

테스트 결과

 

 

05-5. @Configuration과 싱글톤

다시 AppConfig로 돌아가서 이상한 부분을 찾아보자.

 

main/java/hello/core/AppConfig.java

(생략)

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

(생략)
}

 

memberService 빈을 만들 때 memberRepository()를 호출한다.

    -> memberRepository() 메소드는 new MemoryMemberRepository()를 호출한다.

orderService 빈을 만들 때에도 memberRepository()를 호출한다.

    -> memberRepository() 메소드는 new MemoryMemberRepository()를 호출한다.

또 자체적으로 memberRepository 빈을 만드는 메소드도 있다.

 

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

스프링 컨테이너는 이 문제를 어떻게 해결하고 있을까?

 

검증 용도의 테스트 코드 추가

main/java/hello/core/member/MemberServiceImpl.java

package hello.core.member;

public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

  (생략)

    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

 

main/java/hello/core/order/OrderServiceImpl.java

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;

(생략)

    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

 

테스트

test/java/hello/core/singleton/ConfigurationSingletonTest.java

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;

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

public class ConfigurationSingletonTest {

    @Test
    public void configurationTest() {

        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberServiceImpl memberService = ac.getBean(MemberServiceImpl.class);
        OrderServiceImpl orderService = ac.getBean(OrderServiceImpl.class);
        MemberRepository memberRepository = ac.getBean(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(memberRepository1).isSameAs(memberRepository2);
        assertThat(memberRepository2).isSameAs(memberRepository);
        assertThat(memberRepository).isSameAs(memberRepository1);
    }
}

 

테스트 결과

 

 

테스트 결과 세 개의 memberRepository 모두 참조값이 같음을 알 수 있다.

즉, memberRepository의 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

 

AppConfig에 호출 로그 남기기

main/java/hello/core/AppConfig.java

(생략)

@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을 호출해서 스프링 빈을 생성한다.

그렇다면 memberRepository()는 다음과 같이 총 3번이 호출된다.

 

    1. @Bean memberRepository() 호출

    2. memberService() 로직에서 memberRepository() 호출

    3. orderService() 로직에서 memberRepository() 호출

 

그렇다면 다음과 같이 로그가 찍힐 것으로 예상할 수 있다.

call AppConfig.memberRepository
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
...

 

실제 출력 결과

 

 

그런데 실제 출력 결과를 보면 call AppConfig.memberRepository 는 1번만 찍혀있다.

 

05-6. @Configuration과 바이트코드 조작의 마법

스프링 컨테이너는 싱글톤 레지스트리이므로 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.

그렇지만 스프링이 자바 코드까지 어떻게 하기는 힘들다.

AppConfig의 자바 코드로만 봤을 때에는 memberRepository()는 분명 총 3번이 호출되는 것이 맞다.

그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

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

 

테스트용 코드

test/java/hello/core/singleton/ConfigurationSingletonTest.java

@Test
public void configurationDeep() {

    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

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

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

 

AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다.

그래서 AppConfig도 스프링 빈이 된다.

AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보면 다음과 같다.

 

bean.getClass() = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$b8933e89

 

순수한 클래스라면 다음과 같이 출력되어야 한다.

 

class hello.core.AppConfig

 

그런데 클래스명에 xxxCGLIB가 붙으면서 상당히 복잡해진 것을 알 수 있다.

이것은 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 내가 만든 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

 

이미지 출처 : 강의자료

 

그 임의의 클래스가 바로 싱글톤이 보장되도록 해준다.

CGLIB의 내부 코드를 예상해보면 다음과 같을 것이다.

 

AppConfig@CGLIB의 예상 코드

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

 

@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 없으면 생성해서 스프링 빈으로 등록한 후 반환하는 코드가 동적으로 만들어진다.

이 덕분에 싱글톤이 보장된다.

 

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

 

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

main/java/hello/core/AppConfig.java

//@Configuration
public class AppConfig {

(생략)

 

AppConfig의 @Configuration을 삭제하고 configurationDeep()을 똑같이 실행해보자.

 

bean.getClass() = class hello.core.AppConfig

 

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

 

 

또 MemberRepository가 총 3번 호출된 것을 알 수 있다.

한 번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서이고, 나머지 두 번은 각각 memberRepository()를 호출하면서 발생한 코드다.

 

인스턴스가 같은지 확인하기 위해 configurationTest()를 다시 실행해보면 다음과 같다.

 

 

각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있다.

 

정리

    - @Bean만 사용해도 스프링 빈으로 등록되지만 싱글톤을 보장하지 않는다.

        -> memberRepository()처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.

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