[SpringBasic] Singleton Container

1. Web Application & Singleton pattern

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

}

• 순수한 DI 컨테이너인 AppCofig는 요청을 할 때마다 객체를 새로 생성하기 때문에 메모리 낭비가 심함

• 이를 해결하기 위해선 해당 객체를 1개만 생성하고 그것을 공유하도록 설계하면 됨 => Singleton Pattern

package hello.core.singleton;

public class SingletonService {

    // 1. static 영역에 객체를 딱 1개만 생성해둠 - 객체를 미리 생성해두는 가장 단순하고 안전한 방법
    private static final SingletonService instance = new SingletonService();

    // 2. public으로 열어서 객체 인스턴스가 필요하면, 이 메서드를 통해서만 조회하도록 함
    public static SingletonService getInstance(){
        return instance; // 이 메서드를 호출하면 항상 같은 인스턴스를 반환함
    }

    // 3. 생성자를 private으로 선언해서, 외부에서 new 키워드로 객체 인스턴스를 생성하는 것을 막음
    private SingletonService(){
    }

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

    @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest(){
        // 조회 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.logic();
    }

• 싱글톤 패턴을 적용하면 고객의 요청이 들어올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 하나의 객체를 공유해서 효율적으로 사용할 수 있음

• 하지만 싱글톤 패턴은 구현하는 코드 자체가 많이 들어간다는 것과, 클라이언트가 구체 클래스에 의존해서 DIP를 위반하는 등 유연성이 떨어지는 패턴임
  -> 이러한 문제점들을 스프링 컨테이너를 통해 모두 해결할 수 있음

2. Singleton Container

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

    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer(){
        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
        assertThat(memberService1).isSameAs(memberService2);
    }

• 스프링 컨테이너 덕분에 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있음

3. Singleton 설계시 주의 : Stateless

• 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(state)하게 설계하면 안됨

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

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

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

• StatefulService의 price 필드는 공유되는 필드인데, 특정 클라이언트가 필드의 값을 변경하여 사용자 A의 주문 금액이 1000원에서 2000원으로 변경되는 문제가 발생함

public class StatefulService {
    public int order(String name, int price){
        System.out.println("name = " + name + " price = " + price);
        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);

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

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

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

• 무상태(stateless)로 설계해야 함
• 특정 클라이언트에 의존적인 필드가 있으면 안되고, 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안됨
• 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 함

4. @Configuration과 싱글톤

...
@Configuration
public class AppConfig {
    @Bean
    public MemberService memberService(){
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemoryMemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

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

    ...
}

• @Bean memberService -> new MemoryMemberRepository()
• @Bean Orderservice -> new MemoryMemberRepository()
• 결과적으로 각각 다른 2개의 MemoryMemberRepository()가 생성되면서 싱글톤이 깨지는 것처럼 보임

...
public class MemberServiceImpl implements MemberService {
    ...
    // 테스트 용도
    public MemberRepository getMemberRepository(){
        return memberRepository;
    }
}

...
public class OrderServiceImpl implements OrderService{
	...
    // 테스트 용도
    public MemberRepository getMemberRepository(){
        return 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("memberRepository = " + memberRepository);

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

}

...
memberService -> memberRepository = hello.core.member.MemoryMemberRepository@616fe72b
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@616fe72b
memberRepository = hello.core.member.MemoryMemberRepository@616fe72b

• 확인 결과 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용됨
• AppConfig 코드를 보면 각각 2번 new MemoryMemberRepository를 호출해서 다른 인스턴스가 생성되어야 할 것 같지만 실제로는 아님

...
@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService(){
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemoryMemberRepository 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.memberService
call AppConfig.memberRepository
call AppConfig.orderService

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

• 스프링 컨테이너는 싱글톤 레지스터이기 때문에 스프링 빈이 싱글톤이 되도록 보장해줘야 함
• 스프링은 클래스의 바이트 코드를 조작하는 라이브러리를 사용함

...
public class ConfigurationSingletonTest {
	...
    @Test
    void configurationDeep(){
        // AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록됨
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        AppConfig bean = ac.getBean(AppConfig.class); // AppConfig도 스프링 빈이 됨

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

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

  bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$88613459

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

  bean = class hello.core.AppConfig

• 클래스 명에 xxxCGLIB가 붙은 이유는 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 클래스를 스프링 빈으로 등록했기 때문임
• 임의로 만들어진 클래스가 싱글톤이 보장되도록 해줌

AppConfig@CGLIB 예상 코드

@Bean
public MemberRepository memberRepository(){

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

• @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어짐
• AppConfig@CGLIB는 AppConfig의 자식 타입이기 때문에, AppConfig 타입으로 조회할 수 있음

@Configuration을 적용하지 않고 @Bean만 적용하면?

• 순수한 AppConfig로 스프링 빈에 등록됨

  bean = class hello.core.AppConfig

• MemberRepository가 총 3번 호출됨

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

  • 1번 : @Bean에 의해 스프링 컨테이너에 등록
  • 2번 : memberRepository() 호출

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

  memberService -> memberRepository = hello.core.member.MemoryMemberRepository@32a68f4f
  orderService -> memberRepository = hello.core.member.MemoryMemberRepository@73194df
  memberRepository = hello.core.member.MemoryMemberRepository@6eb2384f

• @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않음

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

• 따라서 스프링 설정 정보는 항상 @Configuration을 사용해야 함

출처 : 스프링 핵심 원리 - 기본편