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

February 25th, 2021

이번 챕터는 싱글톤, 그리고 싱글톤 컨테이너에 대해 알아본다.

웹 애플리케이션과 싱글톤

  • 스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
  • 대부분의 스프링 애플리케이션은 웹 애플리케이션이다.(물론 웹이 아닌 애플리케이션 개발도 가능하다)
  • 웹 애플리케이션은 보통 여러 고객이 동시에 요청한다.
  • TPS가 5000이라고 가정한다면, 1초에 5만개의 객체가 생성된다는 말이며, 즉 메모리 낭비가 심하다는 것을 뜻한다.
    • 이를 위한 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. -> 싱글톤 패턴

싱글톤 패턴

  • 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴.
  • 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
    • private 생성자를 사용하여 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.
package hello.core.singleton;

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance() {
        return instance;
    }

    private SingletonService() {
    }

   public void logic() {
       System.out.println("싱틀톤 객체 로직 호출");
   }
}
  • static 영역에 객체 instance를 미리 하나 생성하여 올려둔다.
  • 객체가 필요할 경우 getInstance()를 통해 접근한다. 외부에서 객체 생성을 못하게 막도록 private로 생성자를 만든다.

싱글톤 패턴의 문제점

  • 코드가 지저분해진다.(생성자, static private, getinstance등 비즈니스 로직에 비해 작성해야 하는 코드가 많음)
  • DIP를 위반한다. =>싱글톤을 사용하면 public으로 공유 인스턴스를 사용할 수 있게 전역적으로 공개하기 때문에, 대부분 해당 인스턴스를 전역적으로 직접 참조하게 사용됨.
  • 클라이언트가 구체 클래스에 의존해 OCP를 위반할 가능성이 높다.
  • 테스트하기 어렵다.
  • 내부 속성을 변경하거나 초기화 하기 어렵다.
  • priavte 생성자로 자식 클래스를 만들기 어렵다.
  • 결론적으로 유연성이 떨어져, 안티패턴으로 불리기도 한다.

싱글톤 컨테이너

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

싱글톤 컨테이너

  • 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
  • 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
  • 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하며 객체를 싱글톤으로 유지할 수 있다.
    • private static, getInstance, 생성자등 작성하지 않음
    • DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

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

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

싱글톤 방식의 문제점

  • 싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 결국 하나의 객체를 사용하여 공유하기 때문에 상태를 유지(stateful) 하게 설계하면 안된다.
  • 무상태(stateless) 로 설계해야 한다.
    • 특정 클라이언트에 의존적인 필드가 있으면 안된다.
    • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
    • 가급적 읽기만 가능해야 한다.
    • 필드 대신, 자바에서 공유되지 않는 지역변수, 파라미터, threadlocal등을 사용해야 한다.
  • 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다.
package hello.core.singleton;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

import static org.assertj.core.api.Assertions.assertThat;

public class StatefulServiceTest {

    @Test
    @DisplayName("")
    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);

        int price = statefulService1.getPrice();

        System.out.println("price = " + price);
        assertThat(price).isEqualTo(10000);

    }

    static class TestConfig {

        @Bean
        public StatefulService statefulService(){
            return new StatefulService();
        }
    }
}
  • 위 코드에서 StatefulService의 price필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
  • 그렇기 때문에 스프링은 꼭 꼭 무상태로 설계해야 한다.

싱글톤 패턴으로 발생할 수 있는 동시성 문제?

자바 애플리케이션이 하나만 있으면 자바가 제공하는 동기화 메커니증(싱크로나이즈 등등)을 사용하면 되지만, 실무에서는 서버를 여러개 사용하기 때문에 자바가 제공하는 동기화 방법 만으로는 문제를 해결할 수 없다. 그래서 주로 유니크 제약조건, 트랜잭션, 락 등을 활용해서 동시성 문제를 해결한다.

@Configuration과 싱글톤

  • @Configuration은 싱글톤을 위해서 존재한다.

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/*
Application에 대한 환경 설정은 모두 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();
    }

}

위 클래스를 설정정보로 지정해 생성한 스프링 컨테이너가 존재할 때, 각각의 bean에 응당하는 객체를 만들었다고 가정해보자. 그럴 때 코드상으로만 보게 되면 MemoryMemberRepository는 총 3번 인스턴스화 되어야 한다. 하지만 테스트 코드를 통해서 해당 객체는 단 한 번만 생성되는 것을 확인 할 수 있다. 왤까??

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

  • 스프링 컨테이너는 싱글톤 레지스트리이다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 하지만, 스프링이 자바코드까지 컨트롤 하기는 어렵기 떄문에, 위 코드에서 call은 세번 print되어야 한다.
  • 하지만 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다. 어떻게? @Configuration을 적용한 AppConfig를 통해서 말이다.

테스트 코드 :

package hello.core.singleton;

import hello.core.AppConfig;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class ConfigurationSingletonTest {

    @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$$b4c79322
    }

}

보통 일반 빈은 bean.getClass()로 출력시 class hello.core.AppConfig까지만 출력된다. 하지만 AppConfig는 뒤에 ~~CGLIB가 붙어있다. 이건 내가 만든 클래스가 아니라 CGLIB라는 바이트코드 조작 라이브러리를 사용해 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한것이다.

이 class hello.core.AppConfig$$EnhancerBySpringCGLIB$$b4c79322클래스가 싱글톤이 보장되도록 해준다.
이 클래스는 아마 아래와 같은 방식으로 작성되어 있을 것이다.

@Bean
    public MemberRepository memberRepository() {
		if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
			return 스프링 컨테이너에서 찾아서 반환
		} else { //스프링 컨테이너에 없으면
			기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록 return 반환
		}
    }

  • @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 없으면 생성하여 스프링 빈으로 등록한다.

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

@Configuration을 사용하는 이유?

  • 스프링 설정 정보를 가져오기 위한 목적으로 사용됨
  • 싱글톤 환경을 보장해줌
  • 컴포넌트 스캔의 대상이 됨

앞선 내용은 김영한 강사님의 스프링 핵심 원리 기본편 강의를 들으며 정리한 내용입니다.

oksusutea's blog

꾸준히 기록하려고 만든 블로그