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

웹 애플리케이션과 싱글톤

스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생

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

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

고객들이 요청할때마다 객체가 계속 새로 생성됨

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

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

        // 참조값이 다른 것을 확인
        System.out.println("memberService = " + memberService);
        System.out.println("memberService2 = " + memberService2);
        
        // memverService1 != memverService2
        Assertions.assertThat(memberService).isNotSameAs(memberService2);
    }

테스트 실행시 다른 객체가 생성된 것을 확인할 수 있음

스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청할 때마다 객체를 새로 생성

고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸됨 → 메모리 낭비 심하다

해결방안 : 해당 객체가 딱 1개만 생성되고 공유하도록 설계 → 싱글톤 패턴

싱글톤 패턴

클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴

→ 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야함

→ private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야함

package hello.core.singleton;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

public class SingletonService {

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

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

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

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

1. 자기자신을 내부의 private으로 가지고 있음. static이라서 class레벨에 올라가서 딱 하나만 생성

2. 인스턴스에 접근가능한 유일한 방법 : getInstance() 메서드

   이때 항상 같은 인스턴스를 반환함

3. 1개의 객체 인스턴스만 존재해야하므로, 혹시라도 외부에서 new로 생성하지 못하도록 막음

@Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest(){
        // new SingletonService(); private으로 생성자를 막아두었으므로 컴파일 오류 발생
        
        SingletonService singletonService1 = SingletonService.getInstance();
        SingletonService singletonService2 = SingletonService.getInstance();

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

        Assertions.assertThat(singletonService1).isSameAs(singletonService2);
    }

호출할 때마다 같은 객체 인스턴스를 반환하는것을 확인할 수 있음

isSameas → == 이걸 의미

isEqualto

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

싱글톤 패턴을 적용하면 고객의 요청이 올때마다 객체를 생성하는 것이 아니라 만들어진 객체를 공유하여 효율적으로 사용가능

싱글톤 패턴 문제점

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

싱글톤 컨테이너

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

지금까지 배운 스프링빈이 바로 싱글톤으로 관리되는 빈이다

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리 → 컨테이너는 객체를 하나만 생성해서 관리

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

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

• 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도됨
• DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤 사용가능

@Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberService memberService = ac.getBean("memberService",MemberService.class);
        MemberService memberService2 = ac.getBean("memberService",MemberService.class);

        // 참조값이 동일함
        System.out.println("memberService = " + memberService);
        System.out.println("memberService2 = " + memberService2);

        // memverService1 == memverService2
        Assertions.assertThat(memberService).isSameAs(memberService2);

    }

참조값이 동일하기때문에 테스트 성공

고객이 요청할때마다 객체를 생성하는 것이 아니라 이미 만들어져있는 객체를 공유하여 효율적으로 재사용

+) 스프링의 기본 빈 등록 방식은 싱글톤이지만 싱글톤 말고 요청할때마다 새로 객체 생성해서 반환하는 기능도 제공 → 빈 스코프

싱글톤 방식의 주의점

싱글톤 패턴이든, 스프링같은 싱글톤 컨테이너를 사용하든 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 하나의 같은 객체 인스턴스를 공유하기때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면안됨

→ 무상태 stateless로 설계해야함

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

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

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

}

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 주문 금액 조회
        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();
        }
    }

}

StatefulService의 price필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경해버리면 문제가 발생

사용자 A가 10000원을 주문하여 this.price에 10000원이 할당됨

→ 사용자 B가 20000원을 주문하여 20000원이 할당

→ 사용자 A가 자신의 객체를 이용하여 주문 조회를 해도 실체 객체 인스턴스가 하나기때문에 20000원이 찍힘 : 문제 발생!!

스프링빈은 항상 무상태로 설계해야함!

public int order(String name, int price){
        System.out.println("name = "+name + " price = "+price);
        return price;
    }

int userAPrice = statefulService1.order("userA",10000);
int userBPrice = statefulService2.order("userB",20000);

System.out.println("price = " + userAPrice);

이런식으로 지역변수를 할당해서 문제를 해결할 수 있음

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

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

@Bean memberService() → MemoryMemberRepository()

@Bean orderService() → MemoryMemberRepository(), RateDiscountPolicy()

이렇게되면 MemoryMemberRepository가 2개 생성되면서 싱글톤이 깨지는 것 아닌가?라는 의문점이 들 수 있음

    @Test
    void configurationTest(){
        AnnotationConfigApplicationContext 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);

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

검증결과 memberRepository 인스턴스는 모두 같은 인스턴스가 공유하여 사용

스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성한다. 이때 memberRepository()는

1. 처음 등록 1번
2. memberService()에서 한번
3. orderService()에서 한번

총 세번 호출되는가? → 아님

실제로 각 한번씩만 호출된다

call AppConfig.memberService

call AppConfig.memberRepository

call AppConfig.orderService

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

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

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

AnnnotationConfigApplicationContext에 파라미터로 넘긴값은 스프링 빈에 등록되므로 Appconfig도 스프링빈이됨

Appconfig 스프링 빈을 조회해서 클래스 정보를 출력해본 결과

bean.getClass() = class hello.core.AppConfig$$SpringCGLIB$$0

위와같은 결과가 나옴

순수한 클래스라면 class hello.core.AppConfig 이런 결과가 나와야함스프링이 CGLIB이라는 바이트코드 조작 라이브러리를 사용해서
AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링빈으로 등록한 것이다

이 임의의 다른 클래스가 싱글톤이 보장되도록 해줌

AppConfig@CGLIB 예상코드

@Bean
public MemberRepository memberRepository() {

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

memberRepository는 바이트코드를 조작해서 다음과 같은 형식으로 다시 작성될 것

@Bean이 붙은 메소드마다 이미 등록되어있으면 존재하는 빈을 반환하고 없으면 생성해서 스프링빈에 등록하고 반환 → 싱글톤!

+) AppConfig@CGLIB은 AppConfig의 자식타입이므로, AppConfig 타입으로 조회가능

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

AppConfig가 CGLIB 기술없이 순수한 AppConfig로 스프링빈에 등록됨

→ bean = class hello.core.AppConfig

호출결과도 MemberRepository가 총 3번 호출됨

→ 여기서 각각 인스턴스 또한 다 다름

즉, 싱글톤이 깨짐

@Bean만 사용해도 스프링빈으로 등록되지만 싱글톤 보장 X

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

---

인프런 스프링 핵심 원리 기본편 - 김영한 강의를 듣고 정리한 내용입니다