[Spring] 스프링 싱글톤 컨테이너 (웹 애플리케이션과 싱글톤)

본 내용은 온라인 강의 사이트 인프런의 김영한 님의 강의 내용이 포함되어 있습니다.
'스프링 핵심 원리 - 기본편'

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

 

Intro

웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

다음과 같이 애플리케이션의 전체 동작 방식이 AppConfig 클래스에 구성되어있다고 가정한다.

@Configuration
public class AppConfig {

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

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

 

순수 DI 컨테이너를 통한 요청

다음과 같이 여러 클라이언트가 요청했을 경우 DI 컨테이너에서는 서로 다른 memberService 인스턴스를 생성하게 된다.

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

// 출력
memberService1 = hello.core.member.MemberServiceImpl@1e66f1f5
memberService2 = hello.core.member.MemberServiceImpl@4e50c791

이처럼 스프링을 사용하지 않는 경우 AppConfig는 요청할 때마다 새로운 객체를 반환한다.

• 고객의 요청이 많으면 많을수록 수많은 객체가 생성되고 소멸된다.
• 이는 메모리 낭비가 심하기 때문에 해결 방안이 필요하다.
• 해당 객체가 1개만 생성되고 공유할 수 있도록 설계해야 한다.

 

싱글톤 패턴(Singleton Pattern)

싱글톤 패턴은 인스턴스가 1개만 생성되는 것을 보장하는 디자인 패턴이다.

private 생성자를 사용하여 외부로부터 임의로 new 키워드를 사용하지 못하도록 막을 수 있다.

public class SingletonService {

    // 1. static 영역에 객체를 1개만 생성한다.
    private static final SingletonService instance = new SingletonService();

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

    // 3. 생성자를 private로 선언하여 외부에서 new 키워드를 사용하지 못하도록 막는다.
    private SingletonService() {
    }

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

이로써 외부 클래스에서는 getInstance() 메서드를 통해서만 호출할 수 있으며 다른 곳에서는 객체를 생성할 수 없게 된다.

 

getInstance() 메서드는 생성된 객체를 호출하는 것으로 항상 같은 객체를 호출하게 된다.

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

        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);

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

// 출력
singletonService1 = hello.core.singleton.SingletonService@13b6aecc
singletonService2 = hello.core.singleton.SingletonService@13b6aecc

참고로 싱글톤 패턴을 구현하는 방법은 여러 가지가 있다.

위 코드의 방법은 객체를 미리 생성해두는 방법이다.

 

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

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

 

스프링 프레임워크는 스프링 컨테이너를 통해 싱글톤의 모든 단점들을 해결하면서도 싱글톤의 역할을 할 수 있도록 해준다.

 

싱글톤 컨테이너(스프링 컨테이너)

스프링 컨테이너는 싱글톤 패턴의 문제점을 모두 해결하면서, 객체 인스턴스를 싱글톤으로 관리한다. 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

스프링 컨테이너를 싱글톤 컨테이너라고도 한다.

 

싱글톤 컨테이너

• 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리한다.
  • 스프링 컨테이너는 생성 시 빈 객체를 하나씩 생성하고 등록하여 관리하기 때문이다.
• 즉, 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다.(싱글톤 레지스트리)
  • 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있게 된다.
  • 싱글톤 패턴을 위한 코드가 필요로 하지 않고, DIP OCP 테스트, private 생성자로부터 자유로워진다.

public class SingletonTest {
    @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);
    }
}

// 출력
memberService1 = hello.core.member.MemberServiceImpl@1a9c38eb
memberService2 = hello.core.member.MemberServiceImpl@1a9c38eb

최상단 AppConfig 클래스에는 싱글톤을 구현하기 위한 어떠한 코드도 존재하지 않는다.

하지만, 스프링 컨테이너를 통해 객체를 여러 번 호출하더라도 항상 같은 객체를 호출하게 된다.

 

따라서, 스프링 컨테이너로 인해 클라이언트의 요청이 올 때마다 객체를 생성하는 것이 아닌, 이미 생성된 객체를 공유하여 효율적으로 재사용할 수 있게 된다.

 

싱글톤 방식의 주의할 점

싱글톤 패턴을 구현해서 사용하는 것과 스프링 컨테이너를 사용하는 것은 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식이다.

이러한 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안되고, 무상태(stateless)로 설계해야 한다.

 

무상태(statelsess)

• 특정 클라이언트에 의존적인 필드가 있으면 안된다.
• 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
• 가급적 읽기만 가능해야 한다.
• 필드 대신에 자바에서 공유되지 않는 지역 변수, 파라미터, 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;
    }
}

 

사용자 A와 사용자 B가 동시에 주문을 한다는 것을 가정하여 다음과 같이 검증을 할 때, 문제가 발생하게 된다.

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가 10,000원 주문
        statefulService1.order("userA", 10000);
        // ThreadB: 사용자 B가 20,000원 주문
        statefulService2.order("userB", 20000);

        // ThreadA: 사용자 A의 주문 금액 조회(기대하는 금액: 10000원)
        int price = statefulService1.getPrice();
        System.out.println("price = " + price);

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

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

// 출력
name = userA price = 10000
name = userB price = 20000
price = 20000

실제로 스레드를 사용한 것은 아니지만, 스레드의 실행 과정으로 표현하여 주문을 진행한다고 가정한다.

• ThreadA는 사용자 A의 코드를 호출하고, ThreadB는 사용자 B의 코드를 호출하게 된다.
• StatefulService 클래스의 price는 필드에 공유되는 필드로 클라이언트의 요청에 따라 값을 변경하게 된다.
• 따라서 사용자 A의 주문 금액은 10000원이 되어야 하지만, 20000원이라는 결과가 나오게 되는 것이다.
• 따라서 싱글톤을 다룰 때에는 항상 조심해야 하며, 스프링 빈은 무상태(stateless)로 설계해야 한다.

이러한 특성으로 인해 실무에서도 종종 발생하는 문제라고 한다.

 

싱글톤 방식의 문제점 해결 방안

위 코드의 문제점을 해결하지 못하는 것은 아니다.

문제점을 해결하기 위해서는 필드 대신에, 자바에서 공유되지 않는 지역 변수, 파라미터, ThreadLocal 등을 사용해야 한다.

public class StatefulService {

    // private int price; // 상태를 유지하는 필드를 사용하지 않음

	// 반환 타입이 int인 메서드로 변경
    public int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        // this.price = price; // 문제를 일으키는 곳 제거 후 리턴
        return 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가 10,000원 주문
        int userAPrice = statefulService1.order("userA", 10000);
        // ThreadB: 사용자 B가 20,000원 주문
        int userBPrice = statefulService2.order("userB", 20000);

        // ThreadA: 사용자 A의 주문 금액 조회(기대하는 금액: 10000원)
        // int price = statefulService1.getPrice();
        System.out.println("price = " + priceAPrice);

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

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

// 출력
name = userA price = 10000
name = userB price = 20000
price = 10000