[스프링 핵심 원리 - 기본] 싱클톤 컨테이너

김영한님의 스프링 핵심원리 기본을 듣고 정리한 글입니다. 

 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

 

<웹 애플리케이션과 싱글톤>

 

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

대부분의 스프링 어플리케이션은 웹 어플리케이션으로 보통 여러 고객이 동시에 요청을 한다. 

 

스프링을 사용하지 않은 순수한 DI 컨테이너

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

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

 

실행 결과

 

우리가 만들었던 DI 컨테이너는 AppConfig를 필요로 할때마다 새로운 객체를 생성한다. 

고객 트래픽이 초당 100이 나오면 초당 100개의 객체가 생성한다 => 메모리 낭비

객체를 하나만 생성해 공유하도록 한다 => 싱글톤

 

 

 

<싱글톤 패턴>

 

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

 

static 영역에 객체 instance를 생성한다. => jvm 실행 시 바로 생성된다.

객체 인스턴스가 필요하면 오직 getInstance() 를 통해서만 조회가 가능하다.

한 개의 인스턴스만 존재해야하므로 생성자를 private으로 막는다.

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance() {
        return instance;
    }
    // 외부에서의 선언을 막는다. 
    private SingletonService() {}

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

 

테스트 코드

@Test
@DisplayName("싱클톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
    SingletonService singletonService1 = SingletonService.getInstance();
    SingletonService singletonService2 = SingletonService.getInstance();
    System.out.println("singletonService1 = " + singletonService1);
    System.out.println("singletonService2 = " + singletonService2);

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

}

실행 결과 

싱글톤의 문제점

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

- 의존 관계상 클라이언트가 구체 클래스에 의존한다 -> DIP 위반, OOP 위반 가능성 높다.

- 테스트가 어렵다.

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

- private를 사용하여 자식 클래스를 만들기 어렵고 유연성이 떨어진다.

 

 

 

<싱글톤 컨테이너>

 

스프링 컨테이너는 객체 인스턴스를 싱글톤으로 관리한다. 

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

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

 

 

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {

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

}

출력 결과

memberService1 = hello.springBasic.member.MemberServiceImpl@173ed316
memberService2 = hello.springBasic.member.MemberServiceImpl@173ed316

스프링 컨테이너가 싱글톤으로 관리하는 것을 확인할 수 있다. 

 

 

<싱글톤 방식의 주의점>

 

싱글톤 패턴이든, 스프링 같은 컨테이너를 사용하든 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 상태를 유지하게 설계하면 안된다. => 무상태로 설계해야한다. 

- 특정 클라이언트에 의존적인 필드가 있으면 안된다.

- 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다. 

- 가급적 읽기만 가능해야한다. 

- 가급적이면 필드 대신에 지역 변수, 파라미터 등을 사용해야한다. 

 

 

이렇게 무상태성으로 프로그래밍 하지 않았을 경우 

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

}

userA의 price를 가져오고 싶었으나 userB의 정보가 중간에 추가되어 userB의 price인 20000이 출력된다. 

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService bean = ac.getBean(StatefulService.class);
        StatefulService bean2 = ac.getBean(StatefulService.class);

        bean.order("userA", 10000);
        bean.order("userB", 20000);
        int price = bean.getPrice();
        System.out.println("price = " + price);

        Assertions.assertThat(bean.getPrice()).isEqualTo(20000);

    }

    static class TestConfig {

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

}

무상태성으로 프로그래밍 하는 법

지역 변수를 사용하지 않고 메서드에서 값을 리턴해버린다. (파라미터의 사용)

public class StatefulService {

//    private int price; //상태 유지 필드

    public int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
//        this.price = price; // 여기서 문제가 생김
        return price;
    }

//    public int getPrice() {
//        return price;
//    }

}

 

 

<@Configuration과 싱글톤>

 

AppConfig class에서 memberService와 orderService에서 MemoryMemberRepository를 불러서 싱글톤이 깨지지 않을까?

@Configuration
public class AppConfig {


    // @Bean -> memberService -> new MemoryMemberRepository()
    // @Bean -> orderService -> new MemoryMemberRepository()
    // 싱글톤이 깨지는 것?
    @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
    public DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
}

테스트를 해보니 싱글톤을 유지하고 있다. 

MemberRepository memberRepository = memberService.getMemberRepository();
MemberRepository memberRepository1 = orderService.getMemberRepository();

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

=> 스프링이 싱글톤을 보장해주고 있다.

 

 

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

 

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

AppConfig가 순수한 클래스라면 class hello.springBasic.AppConfig 와 같이 출력되어야한다. 

그런데 예상과 달리 클래스 명에 xxxCGLIB가 붙어있다. 

이는 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 임의의 다른 클래스를 만들고 그 다른 클래스를 스프링 빈으로 등록했다.  

 AppConfig@CGLIB 예상코드

memberRepository를 부를 때 만약 이미 memoryMemberRepository가 스프링 컨테이너에 등록되어 있으면 반환하는 코드가 있을 것. 없다면 기존 로직을 호출하여 memoryMemberRepository를 생성하여 스프링 컨테이너에 등록한다. 

 

 

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

memberRepository 또한 세 번 출력된다. 

=> 싱글톤이 깨진다.

 

@Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 못한다. 그러니 항상 스프링 설정 정보는 @Configuration을 사용하자.