싱글톤 컨테이너

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

 

본 포스팅은 인프런 김영한 님의 스프링 핵심 원리 기본편 을 기반으로 작성되었습니다.

 

웹 애플리케이션과 싱글톤

대부분의 스프링 애플리케이션은 웹 애플리케이션 개발에 사용이 되며, 웹 애플리케이션은 여러 고객이 동시에 요청을 하는 경우가 많다.

클라이언트가 MemberService를 요청하면 요청이 들어올 때마다 새로운 객체를 생성하는데 만일 4000명이 요청을 하면 객체의 개수가 4000개가 된다.

확인 코드

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

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
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }
}

이는 메모리 낭비가 심할 수밖에 없는데 이를 해결하기 위해 싱글톤 패턴이 등장했다.

싱글톤 패턴 :  클래스의 인스턴스가 딱 1개만 생성되고 이를 공유하여 사용하는 것

 

싱글톤 패턴

이제 싱글톤 패턴을 사용하는 테스트 코드를 보자

package hello.core.singleton;

public class SingletonServiceTest {

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

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

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

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

}

기본 선택자를 private으로 new 생성자를 막아두었다.

호출할 때마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

 

싱글톤 패턴의 문제점

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

싱글톤 컨테이너

스프링 컨테이너는 스프링의 많은 단점을 해결하면서 객체 인스턴스를 싱글톤으로 관리한다.

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

   이러하여 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 되며, DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

 

스프링 컨테이너를 사용하는 테스트 코드

    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
//        AppConfig appConfig = new AppConfig();
        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);
    }

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

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

 

싱글톤 방식의 주의점

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

그렇기 때문에 무상태(stateless)로 설계해야 한다. 무상태로 설계하기 위해서는

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

상태를 유지할 경우 발생하는 문제점 예시 (StatefulService.class)

package hello.core.singleton;

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

상태를 유지할 경우 발생하는 문제점 예시 (StatefulServiceTest.class)

package hello.core.singleton;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

import static org.junit.jupiter.api.Assertions.*;

class StatefulServiceTest {

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

        //ThreadA 사용자가 10000원 주문
        statefulService1.order("userA",10000);
        //ThreadB 사용자가 20000원 주문
        statefulService2.order("userB",20000);

        //ThreadA : 사용자A 주문 금액 조회
        int price = statefulService1.getPrice();
        //ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
        System.out.println("price = " + price);

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

    }

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

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

StatefulService의 price필드는 공유되는 필드인데, 특정 클라이언트가 공유되는 필드의 값을 변경한다.

사용자A의 주문금액은 10,000원이 되어야 하는데 싱글톤으로 하나의 객체 인스턴스를 통해 공유되어 20,000원이라는 결과가 나왔다.

그렇기에, 싱글톤을 사용할 때는 해당 객체 인스턴스에 공유 필드가 있어서는 안 된다.

 

@Confinguration과 싱글톤

이전에 작성했었던 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 RateDiscountPolicy();
    }


}

memberService 와 orderService 를 보면 각각 자신의 구현체를 생성해 반환하는데 new MemoryMemberRepository()를 호출한다.

결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 꺠지는 것 처럼 보이는데, 스프링 컨테이너는 이 문제를 어떻게 해결하는지 알아보자

 

MemberServiceImpl.class

//테스트 용도
 public MemberRepository getMemberRepository() {
 	return memberRepository;
 }

OrderServiceImpl.class

    //테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }

ConfigurationSingletonTest.class

public class ConfigurationSingletonTest {

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

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

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

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

<실행결과>

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

AppCOnfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository를 호출해서 다른 인스턴스가 생성되어야 하는데 어떻게 된 일일까? 

AppConfig에 호출 로그를 넣어 확인해보자

 

AppConfig.class

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

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

<실행결과>

우리의 예상과 다르게 1번만 호출된 것을 확인할 수 있다. 이유는 아래에서 확인해보자

 

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

해답은 @configuration을 적용한 AppConfig에 있다.

public class ConfigurationSingletonTest {
    @Test
    void ConfigurationDeep() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        AppConfig bean = ac.getBean(AppConfig.class);

        System.out.println("bean = " + bean.getClass());
    }
}

AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래서 AppConfig도 스프링 빈이 된다. AppConfig스프링 빈을 조회해서 클래스 정보를 출력해보면 아래와 같다.

class hello.core.AppConfig 나올 줄 알았지만 결과를 보면 클래스 명 옆에 xxxCGLIB가 붙으며 복잡해진 것을 볼 수 있다.

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

내부 로직은 @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어질 것이다.

덕분에 싱글톤이 보장되는 것이다.

 

그렇다면 @Configuration을 적용하지 않고, @Bean만 적용하면 어떻게 될까?

AppConfig에서 @Configuration을 주석 처리하고 실행해보면 아래와 같이 출력된다.

출력 결과를 통하여 MemberRepository가 총 3번 출력된 것을 알 수 있다.

1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서,

2번은 각각 memberRepository()를 호출하면서 발생한 코드다.

당연히 인스턴스가 같은지 테스트하는 코드도 실패하고, 각각 다 다른 MemoryMemberRepository인스턴스를 갖게 된다.

 

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

스프링 설정 정보는 항상 @Configuration을 사용하도록 하자.