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

이글은 스프링핵심원리-기본편-인프런 강의를 학습 후 
나중에 다시 복습하기 위해 정리한 글입니다.
문제시 비공개로 처리하겠습니다. 

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

 

목차

1. 웹 애플리케이션과 싱글톤
2. 싱글톤 패턴
3. 싱글톤 컨테이너
4. @Configuration과 실글톤

---

1. 웹 애플리케이션과 싱글톤

싱글톤 패턴 ?

→ 간단하게는 .. 객체 인스턴스가 현재 나의 어떤 JVM안에 하나만 존재해야 하는 패턴

웹 애플리케이션과 싱글톤

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

@Configuration
public class AppConfig {

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

사실 @Configuration이 싱글톤 패턴으로 설계돼서 그렇지,

순수한 자바 환경에선 new MemberServiceImpl() 을 하면 위의 그림처럼

→ 계속 객체 인스턴스를 생성한다.

 

• 테스트

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 = hello.core.member.MemberServiceImpl@22ff4249
        // memberService2 = hello.core.member.MemberServiceImpl@2d1ef81a

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

우리가 전에 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다 객체를 새로 생성한다.

고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다!

→ 메모리 낭비가 심하다.

해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다.

→ 싱글톤 패턴

---

2. 싱글톤 패턴

싱글톤 패턴

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

 

그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.

→ private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막야야 한다.

public class SingletonService {

		// static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
    private static final SingletonService instance = new SingletonService();

    // 이 함수를 통해서만 SingletonService 를 사용할 수 있다.
    public static SingletonService getInstance(){
        return instance;
    }

    // 다른 곳에서 new 하지 못하게 private 생성자
    private SingletonService(){

    }

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

• test

public class SingletonTest {

...

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

        System.out.println(singletonService1); 
				//hello.singleton.SingletonService@43bc63a3
        System.out.println(singletonService2); 
				//hello.singleton.SingletonService@43bc63a3 

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

    /**
     *  isSameAs        ->      ==            -> 참조 값 비교
     *  isEqualTo       ->      equals()      -> 값 비교
     */

}

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

싱글톤 패턴을 적용하면 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라,

이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.

하지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있다.

싱글톤 패턴 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다 → DIP를 위반한다.
• 클라이언트가 구체 클래스에 의존해서 → OCP 원칙을 위반할 가능성이 높다.
• 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어진다.
• 안티패턴으로 불리기도 한다.

---

3. 싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서 ,

객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다.

지금까지 우리가 학습한 스프링 빈이 싱글톤으로 관리되는 빈이다.

싱글톤 컨테이너

• 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다. → 참 편리하지 않을 수 없다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다.
• 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

→ DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다.

→ 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.

 

• test

@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);
	//hello.core.member.MemberServiceImpl@178213b
        System.out.println("memberService2 = "+memberService2);
	//hello.core.member.MemberServiceImpl@178213b
        Assertions.assertThat(memberService1).isSameAs(memberService2);
    }

테스트 하다가 잠깐 헷갈려서 다시 언급하지만 ...

위 과정이 싱글톤으로 적용시킨 테스트 이다.

스프링 컨테이너를 통해서 등록되는 스프링 빈들이 싱글톤으로 관리가 되는 것이다.

AppConfig appConfig = new AppConfig();
MemberService memberService1 = appConfig.memberService();
MemberService memberService2 = appConfig.memberService();

위 코드는 당연히 스프링의 영향을 받지 못한다.

→ 당연히 싱글톤이 아니다. (싱글톤으로 코드를 관리해 주지 않는다면 ...)

 

• 싱글톤 적용 후

스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라,

이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다.

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

싱글톤 방식의 주의점

실무에서 가장 많이 발생되는 문제이기 때문에 주의를 요할 필요가 있다. !!!

 

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든

객체 인스턴스를 하나만 사용해서 공유하는 싱글톤 방식은

여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에

싱글톤 객체는 상태를 유지(stateful) 하게 설계하면 안된다.

 

즉, 무상태(stateless)로 설계해야 한다.

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

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

• 예시

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

public 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);
        //ThreadA : B 사용자 , 20000원 주문
        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();
        }
    }
}

기본적으로 웹 서비스의 각 요청에 대해 쓰레드가 하나씩 부여된다.

위의 코드에서 ThreadA 는 10000원을 주문했지만

StatefulService 는 기본적으로 싱글톤이기 때문에 price 필드가 공유가되어

그 사이 ThreadB가 20000원을 주문하면

ThreadA는 20000원이 지불되게 된 것이다...

 

실무에서 이런 경우를 종종 보는데, 이로인해 정말 해결하기 어려운 큰 문제들이 터진다.

→ 진짜 공유필드는 조심해야 한다!

→ 스프링 빈은 항상 무상태(stateless)로 설계하자.

 

아 여담 이지만

TestConfig class 에 @Configuration이 안붙었는데

ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

이 과정(스프링 컨테이너에 등록) 을 통해 TestConfig가 스프링 빈으로 자동으로 등록이 된다.

 

그럼 @Configuration 이게 붙은거랑 안붙은거랑은 무슨 차이 일까?

---

4. @Configuration과 싱글톤

기존 AppConfig 코드를 보면

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

코드를 보면

memberService() 와 orderService() 에서 memberRepository()를 두 번 호출하는 것을 볼 수 있다.

거기서 new MemoryMemberRepository()를 하는데

아무리 AppConfig.class 가 스프링 컨테이너에 등록이 되어 스프링 빈들이 싱글톤으로 관리 된다 하지만,,,

자바 코드로 봤을 땐 두 번 new 해서 객체를 인스턴스화 시키는데

 

스프링 컨테이너는 무슨 용빼는 재주가 있는 것도 아니고 이 문제를 어떻게 해결하는 것 일까??

 

일단, memberService 와 orderService가 같은 MemoryMemberRepository 객체를 사용하는지

테스트 해보자

public class ConfigurationSingleton {

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

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

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

/*
memberService -> MemberRepository = hello.core.member.MemoryMemberRepository@613a8ee1
orderService  -> MemberRepository = hello.core.member.MemoryMemberRepository@613a8ee1
memberRepository = hello.core.member.MemoryMemberRepository@613a8ee1
*/

결과를 보면 알 수 있듯이

AppConfig - memberService, orderService 에서 new MemoryMemberRepository()를 두번 하지만

같은 hello.core.member.MemoryMemberRepository@613a8ee1 를 사용한다.

 

그럼 혹시 두 번 호출이 안되는 것일까?? ⇒ 확인해 보자.

스프링 컨테이너는 각각 @Bean을 호출해서 스프링 빈을 생성한다.

단순하게만 생각해 봤을 땐 memberRepository() 가 세 번 호출되야 하는거 아닌가???

일단 확인을 위해 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());
    }

방금 전 테스트 코드를 실행해 보면

call AppConfig.memberService
17:49:17.467 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memberRepository'
call AppConfig.memberRepository
17:49:17.470 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'orderService'
call AppConfig.orderService
17:49:17.472 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'discountPolicy'
memberService -> MemberRepository = hello.core.member.MemoryMemberRepository@613a8ee1
orderService  -> MemberRepository = hello.core.member.MemoryMemberRepository@613a8ee1
memberRepository = hello.core.member.MemoryMemberRepository@613a8ee1

결론 : 한 번만 호출된다.

왜 why ?

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

스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.

그러나 스프링이 자바 코드까지 어떻게 하기는 어렵다.

분명 위의 예제 코드 및 테스트에서 3번 호출되야 하는 것이 맞다.

 

그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

모든 비밀은 @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$$EnhancerBySpringCGLIB$$121335e9
    }

이미 알고있는 부분이지만,

사실 AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록된다.

→ AppConfig도 스프링 빈이 된다.

 

결과를 보면 클래스 정보가 일반적으로 나오는 정보랑은 다른 것을 알 수 있다.

• @Configuration이 붙은 클래스

class hello.core.AppConfig$$EnhancerBySpringCGLIB$$121335e9

• 순수한 클래스

class hello.core.AppConfig

바이트코드 조작

스프링은 @Configuration이 붙은 클래스를 순수히 스프링 빈으로 등록하는 것이 아니고,

스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서

AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고

그 임의 클래스의 인스턴스를 스프링 빈으로 등록한 것이다. !!

AppConfig는 실제 스프링 컨테이너에

이름 : appConfig

값 : AppConfig@CGLIB... 스프링 빈으로 등록된 것을 알 수 있다.

 

AppConfig@CGLIB 예상 코드

• @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다. -> 덕분에 싱글톤이 보장되는 것이다.

 

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

AppConfig bean = ac.getBean(AppConfig.class);

위 코드에서 AppConfig를 상속받은 AppConfig@CGLIB어쩌구 가 bean에 들어간 것임

@Configuration을 빼면 어떻게 될까?

싱글톤 빈을 확실하게 보장해주는 @Configuration을 적용하지 않고

@Bean만 적용해 본다면?

//@Configuration
public class AppConfig {
	...
}

// 결과 
20:42:02.226 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'appConfig'
20:42:02.231 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memberService'
call AppConfig.memberService
call AppConfig.memberRepository
20:42:02.238 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memberRepository'
call AppConfig.memberRepository
20:42:02.238 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'orderService'
call AppConfig.orderService
call AppConfig.memberRepository
20:42:02.242 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'discountPolicy'

bean = class hello.core.AppConfig

위 결과를 보다시피

AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 볼 수 있다.

또한 memberRepository() 가 3번 호출 된 것을 볼 수 있다.

당연히 할당 된 인스턴스도 모두 다른 것을 알 수 있다.

memberService -> MemberRepository = hello.core.member.MemoryMemberRepository@6ce86ce1
orderService  -> MemberRepository = hello.core.member.MemoryMemberRepository@54e7df6a
memberRepository = hello.core.member.MemoryMemberRepository@3fed2870

정리

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

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

→ 크게 고민할 것이 없다. 스프링 설정 정보는 항상 @Configuration 을 사용하자.