김영한 (스프링 핵심원리 5) 싱글톤 컨테이너

웹 애플리케이션과 싱글톤

현제의 Appconfig.class 의 형식이다. 클라이언트가 서비스를 요구할때마다 새로운 객체를 return 해주는 방식이다.

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

        MemberService memberService1 = appConfig.memberService();
        MemberService memberService2 = appConfig.memberService();
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }
}

확인을 해보면 매번 새로운 객체를 생성하는것을 알 수 있다. 너무 많은 클라이언트의 요청이 들어오면 이것은 메모리 낭비 로 이어질 수 있다. 싱글톤이 해결책이다.

package hello.core.singleton;

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

    public static SingletonService getInstance()
    {
        return instance;
    }

    private SingletonService()
    {

    }
    
}

static 으로 하나의 객체를 받아오고 생성자를 private으로 함으로써 다른데서 또 다른 새로운 객체를 생성하는 것을 방지 할 수 있다. 불러올 떄는 함수로 불러온다. 객체를 미리 생성해두는 가장 단순하고 안전한 방법이다. 

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

        Assertions.assertThat(instance1).isSameAs(instance2);

    }

getInstance는 static 메소드이기에 클래스를 객체로 생성하지 않고도 접근할 수 있다. 

same == 객체가 진짜 같은지  , equal == 오버라이드 해서 쓰는 메소드 

 

싱글톤 패턴 문제점

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

의존관계상 클라이언트가 구체 클래스에 의존한다. DIP를 위반함

클라이언트가 구체 클래스에 의존하여 OCP 원칙을 위반할 가능성이 높다.

테스트하기 어렵다.

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

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

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

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

BUT 스프링이 해결해준다.

 

싱글톤 컨테이너

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

이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

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

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

아까 와 같지만 이번엔 스프링 컨테이너를 이용한 것이다. 역시 같은 객체를 참조함으로 테스트가 성공한다. 

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

 

싱글톤 방식의 주의점

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

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

class StatefulServiceTest
{
    @Test
    void statefulServiceSingleton()
    {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        //ThreadA = A사용자 1만원 주문
        statefulService1.order("userA",10000);
        //ThreadB = B사용자 2만원 주문
        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();
        }
    }
}

사용자A와 사용자B의 주문금액이 서로 같은 객체의 변수를 조회하고 쓰기 때문에 오류가 발생해버린다. 이렇게 간단한 코드라면 눈에 확들어오지만 실무에서는 굉장히 복잡한 멀티스레딩 문제로 이어진다고 했다. 꼭 조심하자ㅓㅓ

 

@Configuration과 싱글톤

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 MemberRepository memberRepository()
    {
        return new MemoryMemberRepository();
    }

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

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

meberService와 orderService를 호출할때 new MemoryMemberRepository를 각각 호출 하기에 싱글톤 패턴이 깨지는 것 같다. 한번 test를 통해 확인을 해보자.

   @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("memberRepository1 = " + memberRepository1);
        System.out.println("memberRepository2 = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);
                
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
    }

결과는 똑같다. memberRepository 를 3번호출을 하는것이아니라 1번만 호출하는 것이다. 어떻게 된일일까?

 

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

스프링 컨테이너는 싱글톤 레지스트리다. 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그치만 스프링이 자바 코드까지 어떻게 하기는 어렵다. 3번 호출되는 것이 맞다. 그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다. 확인해보자

    @Test
    void configurationDeep()
    {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        AppConfig bean = ac.getBean(AppConfig.class);
        System.out.println("bean = " + bean.getClass());
    }

hello.core.AppConfig$$EnhancerBySpringCGLIB$$112e5515

뒤에 추가로 EhancerBySpringCGLIB~ 이런게 붙어서 나온다. 이것은 내가 만든게 아니라 CGLIB 라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 송삭받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록을 한 것이다.

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

CGLIB 의 대략적 인 로직이다.

getBean으로 AppConfig.class 로 했는데 조회가 가능한것은 부모 자식 관계 때문이다. 부모를 조회하면 다 딸려나온다. AppConfig가 빈으로 등록되는게 아니라 AppConfig@CGLIB 가 등록되고 이름도 가져간다.

@Configuration 을 붙여야 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장한다.