Spring / Single-ton Pattern, Single-ton Container

싱글톤 컨테이너 - 웹 애플리케이션과 싱글톤

 

예를들어, 여러 클라이언트가 동시에 memberService를 요청한다고 할 때,  요청할 때마다 새로운 객체가 생성되고 사용이 끝나면 소멸된다.

 

▶︎ 메모리 낭비가 심함.

 

TestCode

public class SingletonTest {

    @Test
    @DisplayName("스프링 없는 순수한 DI Container")
    void pureContainer()
    {
        AppConfig appConfig = new AppConfig();

        MemberService memberService1 = appConfig.memberService();

        MemberService memberService2 = appConfig.memberService();

        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        assertThat(memberService1).isNotSameAs(memberService2);

    }
}

 

Solution ▷ 해당 객체를 딱 1개만 생성하고, 클라이언트가 공유하도록 설계하면 된다

이를 싱글톤 패턴이라고 한다.

 

 

---

싱글톤 패턴

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

 

package hello.core.singleton;

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance()
    {
        return instance;
    }

    // 생성자를 private로 선언해서 외부에서 new keyword를 사용한 객체 생성을 막음
    private SingletonService(){}

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

1. static영역에 객체 instance를 미리 하나 생성해서 올려둔다.

2. 생성자는 private로 외부생성을 막아두고 

 

3. getinstance() 메소드를 통해 static영역에 생성해둔 객체를 리턴하게 한다.

 

 

TestCode

해당 객체를 getinstance()를 통해서만 만들 수 있게 설정했고, getinstance()는 static level에 있는 미리 만들어둔 객체를 리턴하기 때문에 서로 다른 인스턴스가 리턴되는 것을 막아준다.

 

MemoryMemberRepository를 싱글톤 패턴으로 바꿔보자.

이 전 포스팅에서 서로 다른 Service (OrderService, MemberService) 에서 서로 다른 MemoryMemberRepository를 사용했는데, 

싱글톤 패턴으로 설계를 하면 이 문제를 해결할 수 있다.

 

다음과 같이 static 영역에 instance를 하나 만들어두고 getinstance() 메소드로 해당 instance만 리턴하도록 설정해주었고,

마지막으로 생성자를 private로 설정하여 외부에서 new를 이용한 객체 생성을 방지했다.

 

 

OrderServiceTest

OrderServiceTest 단계에서 각 서비스의 MemoryMemberRepository의 객체 주소를 프린트하는 TestCode를 만들어본 결과 두 서비스가 같은 MemoryMemberRepository를 공유하도록 설정이 된 것을 확인할 수 있었다.

 

 

싱글톤 패턴 문제점

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

2. 의존관계상 클라이언틀가 구체 클래스에 의존하기 때문에( 위와 같은 case에서는 구체의 getinstance()에 의존함 ) DIP를 위반한다.

3. 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높음

4. 테스트가 어렵다.

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

6. private 생성자로 자식 클래스를 만들기 어렵다.

7. 결론적으로 유연성이 떨어짐.

8. 그래서 안티패턴이라고 불리기도 함.

 

 

---

싱글톤 컨테이너

 

싱글톤 컨테이너는 싱글톤 패턴의 문제점을 해결하고, 객체 인스턴스를 싱글톤으로 관리한다.

앞서 배운 스프링 컨테이너는 싱글톤 컨테이너로, 스프링 빈이 싱글톤으로 관리된다.

- 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

 

따라서 스프링 컨테이너를 사용하면 싱글톤 패턴 코드를 구현하지 않아도 되고, 

DIP, OCP, Test, private 생성자로부터 자유로워진다는 장점이 있다.

 

 

Testcode

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer()
{
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    MemberService memberService1 = ac.getBean(MemberService.class);
    MemberService memberService2 = ac.getBean(MemberService.class);

    System.out.println("memberService1 = " + memberService1);
    System.out.println("memberService2 = " + memberService2);

    assertThat(memberService1).isSameAs(memberService2);
}

위와 같이 스프링 컨테이너를 사용하면 호출할 때 마다 같은 인스턴스를 리턴한다.

 

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

 

❗️ 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공한다. 

 

 

---

싱글톤 방식의 주의점

 

예시를 우선 살펴보자

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

 

TestCode

class StatefulServiceTest {

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

    @Test
    void statefulServiceSingleton()
    {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = applicationContext.getBean(StatefulService.class);
        StatefulService statefulService2 = applicationContext.getBean(StatefulService.class);

        //Thread A : A사용자 1000원 주문
        statefulService1.order("userA",1000);

        //Thread B : B사용자 2000원 주문
        statefulService2.order("userB",2000);

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


    }
}

 

price 

/ expected : 1000

/ result : 2000

 

ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.

• StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
  사용자A의 주문금액은 1000원이 되어야 하는데, 2000원이라는 결과가 나왔다.
• 실무에서 이런 경우, 정말 해결하기 어려운 큰 문제들이 터진다.
  공유 필드는 조심해야 한다.  따라서 스프링 빈은 항상 무상태(stateless)로 설계하자.

주의점

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

 

1. 무상태(stateless)로 설계해야 한다.
2. 특정 클라이언트에 의존적인 필드가 있으면 안됨.
3. 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안됨.
4. 가급적 읽기만 가능해야 한다.
5. 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
6. 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다.

---

싱글톤 컨테이너에서의 MemoryMemberRepository

@Configuration
public class AppConfig {
    @Bean
    public MemberService memberService() {
        return new MemberServiceImp(getMemberRepository());
    }

    @Bean
    public MemberRepository getMemberRepository() {
        return new MemoryMemberRepository();
    }
    @Bean
    public OrderService orderService()
    {
        return new OrderServiceImp(getMemberRepository(), getPolicy());
    }

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

싱글톤 컨테이너에서는 OrderService와 MemberService에서의 MemoryMemberRepository가 싱글톤을 유지할 수 있을까?

코드만 봤을때는 각각 new로 새로운 인스턴스를 리턴해서 싱글톤이 깨질 것 처럼 보이지만,

 

테스트를 해보면

 

확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

싱글톤이 안 깨진다.. 왜?

 

두 번 호출이 안되는 건가??? 호출로그를 남겨서 살펴보자.

 

 

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.MemberServiceImp;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImp;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {
    @Bean
    public MemberService memberService() {
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImp(getMemberRepository());
    }

    @Bean
    public MemberRepository getMemberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }
    @Bean
    public OrderService orderService()
    {
        System.out.println("call AppConfig.orderService");
        return new OrderServiceImp(getMemberRepository(), getPolicy());
    }

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

 

결과

1. 스프링 컨테이너가 @Bean을 호출해서 스프링 빈을 생성할 때 한 번

2. orderService()로직에서 한 번

3. memberService()로직에서 한 번

 

getMemberRepository가 총 세 번 호출되어야 할 것 같지만 딱 한 번 호출했다.

 

그래서 AppConfig에 어노테이션 @Configuration을 빼고 테스트코드를 실행해보았더니,

getmemberRepository()가 총 3번 호출된데다가, 싱글톤도 깨져버렸다.

아마도 @Configuration이 이 동작들을 제어하는 것 같다.

---

@Configuration의 바이트코드 조작

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

@Test
void configurationDeep()
{
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    AppConfig bean = ac.getBean(AppConfig.class);
    System.out.println("bean = " + bean.getClass());
    // -> bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$ad8aea39
}

순수한 클래스라면 class hello.core.AppConfig로 출력되어야 하지만,

클래스명에 xxxCGLIB가 붙으면서 복잡해진 것을 볼 수 있다.

 

이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것.

 

그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다. 아마도 다음과 같이 바이트 코드를 조작해서 작성되어 있을 것이다.(실제로는 CGLIB의 내부 기술을 사용하는데 매우 복잡하다.)

 

 

<정리>

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

싱글톤을 보장하기 위해서 스프링 설정정보는 항상 @Configuration을 사용하자!

---

<참고자료>

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

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