[스프링 핵심 원리] Singleton Pattern of Spring Container

Intro

본 카테고리는 Inflearn 김영한 강사님의 스프링 핵심 원리 강의를 수강하며 이해하고 학습한 내용을 정리한 내용으로 구성되어 있다.

본 포스팅에서는 Spring Container의 Singleton Pattern에 대해 다룬다.

Why Signleton Pattern?

---

대부분의 상용 web application은, 다수의 사용자가 동시에 요청을 하게 된다.

각 사용자가 service를 요청할 때마다, 새로운 service 객체를 만들어서 반환하게 된다.

Spring이 없는 순수한 DI container는 이런 방식을 사용하기에 메모리의 낭비가 심해진다.

그러므로 해당 객체는 딱 1개만 생성되고, 이를 공유하는 체제로 하면 이를 해결할 수 있다.

-> 이런 소프트웨어 디자인 패턴을 싱글톤 패턴이라 한다.

Example of Singleton Pattern Service

---

public class SingletonService {
    //1. static 영역에 객체를 딱 1개만 생성해둔다.
    private static final SingletonService instance = new SingletonService();

    //2. public으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 허용한 다.
    public static SingletonService getInstance() {
        return instance;
    }

    //3. 생성자를 private으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {
    }

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

위와 같이 객체를 딱 1개만 static으로 생성해두고, public method인 get\* 함수로만 객체에 접근할 수 있도록 한다.
그리고 private constructor를 통해 다른 지역에서 new를 통한 객체 생성하는 것을 방지한다.

하지만 이런 싱글톤 패턴도 단점이 있다.

싱글톤 패턴 문제점

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

Singleton Container

---

Spring의 Singleton Container는 싱글톤 패턴의 문제점을 보완하면서, 객체를 싱글톤으로 유지할 수 있는 기능을 제공해준다.
싱글톤 패턴을 위해 구체적인 코드를 작성하며 DIP, OCP를 위반하지 않고, private 생성자로부터 자유롭다.

그런 Singleton Container를 사용하는 예제를 보자.

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

    // 1. 조회: 호출할 때 마다 같은 객체를 반환
    MemberService memberService1 = ac.getBean("memberService", MemberService.class);
    // 2. 조회: 호출할 때 마다 같은 객체를 반환
    MemberService memberService2 = ac.getBean("memberService", MemberService.class);
     // 참조값이 같음
    System.out.println("memberService1 = " + memberService1);
    System.out.println("memberService2 = " + memberService2);

    // memberService1 == memberService2
    assertThat(memberService1).isSameAs(memberService2);
}

Testcode 실행 결과, 두 객체의 참조값이 같음을 확인할 수 있다.

spring container를 사용하면 싱글톤 패턴 코드 없이도 bean을 싱글톤으로 관리해준다!

Stateless/Stateful Singleton Pattern

---

싱글톤 패턴인 java 프로그램이든, spring의 싱글톤 컨테이너를 사용하든, 객체 하나만을 공유하여 사용하는 이 싱글톤 패턴을 사용할 때는 주의가 필요하다.

많은 user가 동시에, 혹은 짧은 시간 내에 접근하여 사용하기에 stateful하게 설계하면 안 된다는 것이다.
즉, stateless하게 설계해야 한다.

예제와 함께 살펴보자.

package hello.core.singleton;

public class StatefulService {
    private int price;

    public void order(String name, int price) {
        System.out.println("name = " + name);
        System.out.println("price = " + price);

        this.price = price; // 여기가 문제!
    }

    public int getPrice() {
        return price;
    }
}

price라는 멤버변수를 공유하고 있다.

class StatefulServiceTest {
    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext 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(price).isEqualTo(statefulService1.getPrice());
    }

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

사용자A가 주문을 한 후, 값을 조회하려 했을 때 그 사이에 사용자B가 새로운 주문을 넣은 상태이다.
이럴 경우, 사용자A가 값을 조회하려 할 때 사용자B의 주문가격이 사용자A에게 나타나게 된다.

코드를 다음과 같이 수정하여 해결할 수 있다.

public int order(String name, int price) {
        System.out.println("name = " + name);
        System.out.println("price = " + price);

//        this.price = price; // 여기가 문제!
        return price;
    }

class StatefulServiceTest {
    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext 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 주문 금액 조회
//        int price = statefulService1.getPrice() ;
        System.out.println("userAPrice = " + userAPrice);
        System.out.println("userBPrice = " + userBPrice);
}

In Conclusion..

---

많은 사용자가 접근하는 어플리케이션 서비스의 경우, 객체를 하나로 유지하여 관리해야 하는 경우가 대부분이다.

이 때 적용할 수 있는 것이 싱글톤 패턴이다.

싱글톤 패턴을 사용할 때, 많은 문제가 있을 수 있으므로 그 단점을 보완하며 싱글톤 패턴을 유지하는 spring container를 사용하자.

단, 다음과 stateful하지 않게 설계를 하여 사용하도록 하자!

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

---

감사합니다.