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

[Pracrobo]

웹애플리케이션과 싱글톤

• Spring 은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
• 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 물론 웹이 아닌 애플리케이션 개발도 얼마든지 개발할 수 있다.
• 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

1. memberService요청
2. AppConfig가 new로 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;

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
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    } //assertThat(memberService1).isNotSameAs(memberService2);
}

• 우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다 객체를 새로 생성한다.
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! -> 메모리 낭비가 심하다. , GC가 계속 작동되는 등의 문제가 발생
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. -> 싱글톤 패턴

싱글톤 패턴

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

싱글톤 패턴을 적용한 예제코드를 보자. main이 아닌 test 위치에 생성하자.

main에 영향을 안주고 test로 만들기 위해서 test로 만듦

package hello.core.singleton;

public class SingletonService {
    private static final  SingletonService instance = new SingletonService(); // static 영역에 class 레벨에 올라가 1개만 사용할 수 있다

    public static SingletonService getInstance() {
        return instance; //조회시 사용
    }

    private SingletonService() {
        // 이 클래스에서만 사용할 수 있게 만들고
    }

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

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

Test

package hello.core.singleton;

public class SingletonService {
   @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest() {
// new SingletonService () : 컴파일 오류 , private access  
        SingletonService singletonService1 = SingletonService.getInstance(); // 조회
        SingletonService singletonService2 = SingletonService.getInstance(); // 조회

        System.out.println("singletonService1 = " + singletonService1); // 참조값 확인
        System.out.println("singletonService2 = " + singletonService2); // 참조값 확인

        assertThat(singletonService1).isSameAs(singletonService2); // 객체 인스턴스 같은지 확인
        // isSameAs : same == 참조 비교
        // isEquals : equal Java equals 메소드 비교
}

• 결과

• private 로 new 키워드 막아두었다.
• 성능이 좋아진다.
• 호출할때마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

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

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

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

싱글톤 패턴의 문제점

1. 구현하는 코드 자체가 많이 들어간다.

package hello.core.singleton;

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

    public static SingletonService getInstance() {
        return instance;
    }

    private SingletonService() {

    }

기본적으로 이부분은 들어가야 한다.

2. 의존관계상 클라이언트가 구체 클래스에 의존한다. : get instance : DIP 위반
3. 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
4. 테스트 하기 어렵다. : 유연하게 테스트 하기 어렵다
5. 내부 속성을 변경하거나 초기화 하기 어렵다.
6. private 생성자로 자식 클래스를 만들기 어렵다.
7. 결론적으로 유연성이 떨어진다. : DI를 사용하기 어려움
8. 안티 패턴으로 불리기도 한다.

• 장점 : 쉐어를 할 수 있고, 하나의 객체만 불러온다.

싱글톤 컨테이너 = 스프링 컨테이너

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

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

package hello.core.singleton;

public class SingletonService {
    @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);

        // memberService1 =/= memberService2
        // test :  isSameAs
        assertThat(memberService1).isSameAs(memberService2);
    }
}

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

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

싱글톤 방식의 주의점

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

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

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

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

package hello.core.singleton;

public class StatefulService {
    private int price; // 상태를 유지하는 필드, 같은 객체라 10000 > 20000원으로 바뀜
    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.junit.jupiter.api.DisplayName;
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 사용자가 10000원 주문
        statefulService1.order("userA", 10000);

    // ThreadB : B 사용자가 20000원 주문
        statefulService1.order("userB", 20000);

        // ThreadA가 사용자A가 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price = " + price);
    }


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

• 기대와는 다른 값이 20000이 나온다.
• 기댓값은 10000이다. 사용자 A 가 조회하는 것이기 때문에
• 사용자 B가 바꿔버림 statefulService2.order

• 최대한 단순히 설명하기 위해, 실제 쓰레드는 사용하지 않았다.
• ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.
• StatefulService의 price필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 사용자 A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.
• 실무에서 이런 경우를 종종 보는데, 이로인해 정말 해결하기 어려운 큰 문제들이 터진다.(몇년에 한번씩 꼭 만난다.)
• 진짜 공유필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자.

**무상태로 설계하는 방법

• 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.**

package hello.core.singleton;

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

package hello.core.singleton;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DisplayName;
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.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);
    // ThreadA : A 사용자가 10000원 주문
        int userAPrice = statefulService1.order("userA", 10000);
    // ThreadB : B 사용자가 20000원 주문
        int userBPrice = statefulService1.order("userB", 20000);

        // ThreadA가 사용자A가 주문 금액 조회
        System.out.println("userAPrice = " + userAPrice);
    }


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

• 결과

• 복잡한 상황에서 터지는 문제가 많다.
• 공유필드 조심
• 스프링빈은 항상 무상태로 설계

@configuration과 싱글톤

• @Configuraton은 싱글톤을 위해 존재한다고 볼 수 있다.

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
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 static MemoryMemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
   @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }
    @Bean
    public DiscountPolicy discountPolicy(){
       return new FixDiscountPolicy();
       // return new RateDiscountPolicy();
    }
}

@bean memberService -> new MemoryMemberRepository()
@bean orderService -> new MemoryMemberRepository()

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

실험을 하기 >> 직접 테스트 하기

MemberServiceImpl에 있는 MemberRepository의 실제 값을 확인하기

    public MemberRepository getMemberRepository() {
        return memberRepository;
    }

위 값을 MemberServiceImpl, OrderServiceImpl에 넣기

package hello.core.member;

public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository;

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

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.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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 memberRepository1 = memberService.getMemberRepository();
        MemberRepository memberRepository2 = orderService.getMemberRepository();

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

결과

처음 결과값이 달라서 찾아본 결과, static 변수 때문에 발생하는 오류였습니다.

    @Bean
    public static MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    } //이런식으로 static을 붙였더니 결과값이 달랐습니다.

이유는 static method에 @bean을 사용하게 되면 싱글톤 보장을 위한 지원을 받지 못한다.
'static 메서드는 proxy가 적용되지 않기 때문에 사용하면 안된다.
싱글톤을 보장받으려면 동일한 빈의 존재여부를 확인해서 받는다.
proxy로 인해 @bean이 붙은 메서드를 호출하면 컨테이너에 동일한 빈이 존재하는지 확인하게 된다. 그러나 proxy가 적용되지 않는 static 메소드는 컨테이너에 동일한 빈이 존재하는지에 대한 로직이 수행되지 않기 때문에 싱글톤을 보장하지 않는다'
'static 메소드는 특정 인스턴스에 속하지 않기 때문에 스프링 컨테이너가 빈을 관리하는 방식, 즉 인스턴스 레벨에서 처리하는 라이프사이클 관리, 의존성 주입 및 프록시 적용 등과 같은 과정을 거치기 어렵습니다.`

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.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

• 로직이 3번 실행됐을거 같은데 같은 결과가 나온다.

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

결과

• 확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되서 사용된다.
• AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository 호출해서 다른 인스턴스가 생성되어야 하는데 ?
• 어떻게 된 일인지? 혹시 두번~세번 호출이 안되는 것인지 ? 실험을 통해 알아보자.

@Configuration
public class AppConfig {

    // call AppConfig.memberService
    // call AppConfig.memberRepository
    // call AppConfig.memberRepository
    // call AppConfig.orderRepository
    // call AppConfig.memberService

    // 순서는 다르지만, memberService가 3번 호출될 것이다.


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

call해서 AppConfig가 3번 호출되었다.

• 의도와는 다르게 memberService, memberRepository, orderService 세번 호출했다.

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

예상은 memberRepository가 세번 호출되는 것인데 한번만 호출되었다.

// ConfigurationSingletonTest클래스에 
    @Test
    void configurationDeep() {
        ApplicationContext ac =  new AnnotationConfigApplicationContext(AppConfig.class);
        AppConfig bean = ac.getBean(AppConfig.class);
        System.out.println("bean = " + bean.getClass());

결과

클래스명 $$ EnhancerBySpringCGLIB$$~

• 순수한 클래스라면 다음 밑에와 같이 출력되어야 한다.
  class hello.core.AppConfig
  그런데 예상과는 다르게 클래스 명에 xxxCGLIB가 붙으면서 상당히 복잡해진 것을 볼 수 있다. 이것은 내가
  만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig
  클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

조작 라이브러리로 상속받아서 다른 클래스를 만든것이다.
AppConfig@CGLIB ~~~가 다른 임의의 클래스가 싱글톤이 보장되도록 해준다.

AppConfig@CGLIB의 예상 코드

@Bean
public MemberRepository memberRepository() {
    if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
        return 스프링 컨테이너에서 찾아서 반환;
    } else { //스프링 컨테이너에 없으면
        return 반환
    }
}

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

• 덕분에 싱글톤이 보장되는 것이다

• 오버라이딩 된 스프링 컨테이너가 없으면 등록한 걸 호출해준다.

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

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

• @configuration 을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약 @bean만 적용하면 어떻게 될까?

1. AppConfig에서 @configuration 지우고
2. ConfigurationSingletonTest에서 void configurationDeep() 실행해보기

• 순수한 AppConfig가 나온다.
• 실제 스프링 빈이 등록이 된다.
• 문제는 memberRepository가 세번 호출된다.

• 싱글톤이 안되는것.
• 이 출력 결과를 통해서 MemberRepository가 총 3번 호출된 것을 알 수 있다. 1번은 @bean에 의해 스프링 컨테이너에 등록하기 위해서이고, 2번은 각각 memberRepository()를 호출하면서 발생

3. void configurationTest() 메소드 돌려보면 결과값이 다 다르게 나온다.

• 여기서 MemoryMemberRepository는 private final MemberRepository memberRepository = new MemoryMemberRepository(); 처럼 주입한 결과와 똑같아진다.
• 스프링 빈이 관리하지 않는 것이다.

만약
@Autowired MemberRepository memberRepository; 하면 결과가 똑같아지고 test도 통과된다.

정리

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

단축키

Ctrl + Shift + Enter : code completion
Ctrl+Shift+T : Navigate
Ctrl + Alt + V : Extract/Introduce
(맨마지막 단축키가 잘 안외워져 올려뒀습니다.)