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

[seyxxn]

5_싱글톤 컨테이너

웹 애플리케이션과 싱글톤

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

• 기존 AppConfig 코드에서의 문제점
  • 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 하는데, 이때마다 AppConfig에서 객체를 생성하게 된다.

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

• 스프링 없는 순수한 DI 컨테이너 테스트 코드

  • 호출할 때마다 무조건 객체를 다시 생성하기 때문에 memberService 객체의 값을 출력하면 다르게 나오는 것을 확인할 수 있다.

• 과거에 만들었던 스프링 없는 순순한 DI컨테이너인 AppConfig는 요청할 때 마다 객체를 새로 생성한다.

• 메모리 낭비가 심하다는 문제점이 있기 때문에 해결방안은 딱 1개만 생성하고, 그것을 공유하도록 하는 싱글톤 패턴을 사용한다.

싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴
• 한 자바 서버안에서는 객체 인스턴스가 딱 하나만 있어야 한다
• 같은 객체 타입의 인스턴스를 두개 이상 생성하지 못하도록 막는다

package hello.core.singleton;

public class SingletonService {

    // 1번
    private static final SingletonService instance = new SingletonService();
    // 자기자신을 내부에 private으로 하나만 가지는데 이때 static으로 가지고 있다.
    // 객체를 생성한 후에 instance에 참조를 넣는다


    // 2번
    // 위에서 만든 것을 조회
    public static SingletonService getInstance() {
        return instance; // instance의 참조를 꺼낼 수 있는 건 오로지 여기에서밖에 안된다.
    }

    // 3번
    // 더 이상 생성되는 것을 막기위해 private 생성자를 쓴다.
    private  SingletonService() {

    }

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

}

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

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

        // private으로 생성자를 막아두었기 때문에 컴파일 오류 발생
        // new SingletonService(); -> private access 오류 발생

        // 1. 조회 : 호출할 때 마다 같은 객체를 반환
        SingletonService singletonService1 = SingletonService.getInstance();

        // 2. 조회 : 호출할 때 마다 같은 객체를 반환
        SingletonService singletonService2 = SingletonService.getInstance();

        // 같은 객체 인스턴스가 반환이 됨을 확인
        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);

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

• 같은 객체 인스턴스가 반환이 됨(싱글톤)을 확인하는 Test코드

• 스프링 컨테이너를 사용하면 스프링 컨테이너가 기본적으로 객체를 다 싱글톤으로 만들어서 관리한다.

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

• 싱글톤의 문제점

  • 싱글톤 패턴을 구현하는 코드 자체가 많이 들어감
  • 의존관계상 클라이언트가 구체 클래스에 의존 -> DIP 위반
  • 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성 높음
  • 테스트하기 어려움
  • 내부 속성을 변경하거나 초기화하기 어려움
  • private 생성자로 자식 클래스를 만들기 어려움
  • 유연성이 떨어짐
  • 안티패턴으로 불리기도 함

• 스프링은 이 모든 싱글톤의 단점을 해결하면서 장점은 가져갈 수 있다.

싱글톤 컨테이너

싱글톤 컨테이너 적용 후

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

• 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다.

• 요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공한다.

싱글톤 방식의 주의점

• 객체 인스턴스를 하나만 생성해서 공유히는 싱글톤 방식은 여러 클라이언트가 하나의 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(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;
        }
    }

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원 주문
        statefulService2.order("userB", 20000);

        // ThreadA : 사용자A 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price = " + price); // 중간에 B사용자가 들어왔기 때문에 출력하면 2만원이 출력됨
        // 중간에 값을 바꿔줬으니까..

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

    static class TestConfig {

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

    }

}

• 상태를 유지하는 경우의 문제점이 나타난 코드이다.
• StatefulService의 price필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 따라서 사용자A의 주문금액은 10000원이 출력되어야하는데 20000원이라는 잘못된 결과가 나왔다.
• 공유필드는 항상 조심해야한다. 스프링 빈은 항상 무상태로 설계 !

public class StatefulService {

    public int order (String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        return price;
        // 공유되지 않는 지역변수를 넘겨주는 방식으로 변경
    }
}

    @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 = statefulService2.order("userB", 20000);

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

    }

• 위처럼 코드를 변경해주면 무상태로 설계되기 때문에 올바른 값이 나온다.

@configuration과 싱글톤

• Configration은 싱글톤을 위해 존재한다.

생각해보아야하는 부분

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

• AppConfig 코드
  • memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다.
    • 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
  • orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다.
    • 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
• 결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것 처럼 보인다.

검증 테스트 코드 작성

public class OrderServiceImpl implements OrderService{
    // ... 생략
    // 테스트용
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

• MemberRepository를 조회할 수 있는 기능을 추가

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

        System.out.println("memoryMemberRepository = " + memberRepository);
        // 3개 모두 같은 값을 가진다.

        // 모두 같은 인스턴스를 참고하고 있다. 
        Assertions.assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        Assertions.assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
    }
}

호출 횟수 살펴보기 위한 출력 코드 작성

@Configuration
public class AppConfig {
    @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());
    }

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

• AppConfig에 호출 로그를 남긴다.
  • 매서드 내에서 soutm을 입력하면 빠르게 출력문을 만들 수 있다.

1. 스프링 컨테이너가 스프링 빈에 등록하기 위해 @bean이 붙어있는 memberRepository()를 호출한다.
2. memberService() 로직에서 memberRepository()를 호출한다.
3. orderService() 로직에서 memberRepository()를 호출한다.

• 위와 같은 생각을 하면 memberRepository()는 총 3번이 호출되어야하는 것이 아닐까 ?
  • 출력해보면 모두 1번만 호출된다.

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

• 스프링 컨테이너는 싱글톤 레지스트이다.
• 따라서 스프링 빈이 싱글톤이 되도록 보장해야 한다.
• 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.
  • @Configuration을 적용한 AppConfig

    @Test
    void configurationDeep() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        
        //AppConfig도 스프링 빈으로 등록된다.
        AppConfig bean = ac.getBean(AppConfig.class);
        
        System.out.println("bean = " + bean.getClass());
        //출력: bean = class hello.core.AppConfig$$SpringCGLIB$$0
    }

• AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링으로 등록된다. -> AppConfig도 스프링 빈이 된다.
• AppConfig 스프링 빈을 조회하여 클래스 정보를 출력해보았다. (주석으로 출력 값 작성)
  • 순수한 클래스라면 class hello.core.AppConfig로 출력이 되어야 한다.
  • 예상과는 다르게 클래스 ㅁㅇ에 xxxCGLIB가 붙어 나왔다.
    • 즉, 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

• 그 임의의 다른 클래스가 싱글톤을 보장한다.

AppConfig@CGLIB 예상 코드

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

• @bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환 (이미 존재하면 반환하도록)
• 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어짐 (이때 최초이자 마지막 1번 호출되는 것)
• 이렇게 오버메소드 되어있기 때문에 싱글톤 보장 가능

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

• @Configuration 을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장

• 만약 @Bean만 적용한다면 ?

  • 순수한 AppConfig가 출력되고, 싱글톤이 깨지게된다. (여러번 호출된다)
  • 그럼 인스턴스는 모두 같은 것이 호출될까 ?
    • 인스턴스도 모두 다 다르다.

• 정리

  • @bean만 사용해도 스프링 빈으로 등록은 되지만, 싱글톤을 보장하지는 않는다.
  • 스프링 설정 정보는 항상 @Configuration을 사용하자