(스프링 기본) 5. 싱글톤 컨테이너

이 글은 김영한 님의 스프링 핵심 원리 - 기본편 강좌 수강 후 정리한 글입니다.

https://www.inflearn.com/course/스프링-핵심-원리-기본편/dashboard

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

스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...

www.inflearn.com

웹 애플리케이션과 싱글톤

스프링은 태생부터 기업용 온라인 서비스를 지원하기 위해 탄생하였다.

대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 물론 웹이 아닌 일반 애플리케이션 개발도 충분히 가능하다.

보통 웹 애플리케이션은 위 그림처럼 여러 고객이 동시에 요청을 한다. 만약 세 명의 클라이언트가 동시에 memberService를 요청하면 요청마다 new 키워드를 통해 새로운 객체를 생성하고 이를 반환한다.

● 스프링 없는 순수한 DI 컨테이너 테스트

package hello.core.singleton;

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

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

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

        assertThat(memberService1).isNotSameAs(memberService2);
    }
}

우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.
예를 들어 고객 트래픽이 초당 100이 나온다면 초당 100개 객체가 생성되고 소멸된다는 의미이다.

이렇게 되면 메모리 낭비가 심하다. 이런 문제를 해결하기 위해 해당 객체가 딱 1개만 생성되고, 공유하도록 설계한다.

그래서 싱글톤 패턴이 필요한 것이다.

싱글톤 패턴

클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.

아래 코드는 main이 아닌 test위치에 생성한다.

package hello.core.singleton;

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 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아서 혹시라도 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

package hello.core.singleton;

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

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

public class SingletonTest {
	@Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest(){
        //private으로 생성자를 막아두었다. 컴파일 오류가 발생한다.
        //new SingletonService();

        //1. 조회: 호출할 때 마다 같은 객체를 반환
        SingletonService singletonService1 = SingletonService.getInstance();
        //2. 조회: 호출할 때 마다 같은 객체를 반환
        SingletonService singletonService2 = SingletonService.getInstance();
        //참조값이 같은 것을 확인
        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);
        // singletonService1 == singletonService2 확인
        assertThat(singletonService1).isSameAs(singletonService2);
        singletonService1.logic();
    }
}

위에서 말한 대로 생성자를 private로 해놨긴 때문에 new 키워드를 사용할 수가 없다.

싱글톤 패턴을 적용하면 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유하는 것이기 때문에 효율적으로 사용할 수 있다.

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

싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
의존관계상 클라이언트가 구체 클래스에 의존하게 되면서 DIP를 위반하게 된다.
클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
테스트하기 어렵다.
내부 속성을 변경하거나 초기화하기 어렵다.
private 생성자로 되어있어 자식 클래스를 만들기 어렵다.

결론적으로 위와 같은 이유들로 유연성이 떨어진다.

실제로 싱글톤 패턴은 많이 사용되는 패턴이지만, 비효율적이고 비생산적이기 때문에 안티 패턴이다.

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로
관리한다.
지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

● 싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.

스프링 컨테이너는 싱글톤 컨테이너 역할을 한다.

싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다.

스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.

또한 DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest(){
    //private으로 생성자를 막아두었다. 컴파일 오류가 발생한다.
    //new SingletonService();

    //1. 조회: 호출할 때 마다 같은 객체를 반환
    SingletonService singletonService1 = SingletonService.getInstance();
    //2. 조회: 호출할 때 마다 같은 객체를 반환
    SingletonService singletonService2 = SingletonService.getInstance();
    //참조값이 같은 것을 확인
    System.out.println("singletonService1 = " + singletonService1);
    System.out.println("singletonService2 = " + singletonService2);
    // singletonService1 == singletonService2 확인
    assertThat(singletonService1).isSameAs(singletonService2);
    singletonService1.logic();
}

● 싱글톤 컨테이너 적용 후

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

※ 스프링 빈의 기본 방식은 위의 예시처럼 싱글톤이지만, 요청에 따라 새로운 객체를 생성해서 반환하는 것도 가능하다.

싱글톤 방식의 주의점

싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안 되고, 무상태(stateless)로 설계해야 한다.
즉, 특정 클라이언트에 의존적인 필드가 있으면 안 되며, 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다.
또한 가급적 읽기만 가능해야 하고 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다!

● 상태를 유지하는 경우 발생하는 문제점 예시

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

package hello.core.singleton;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
public class StatefulServiceTest {
	@Test
	void statefulServiceSingleton() {
		ApplicationContext ac = new
		AnnotationConfigApplicationContext(TestConfig.class);
		StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
		StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);
		//ThreadA: A사용자 10000원 주문
		statefulService1.order("userA", 10000);
		//ThreadB: B사용자 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를 호출한다고 가정하자. A가 10000원을 주문했으므로 실행 후 기대하는 결과는 10000원이지만 실제로 출력된 결과는 20000원이다.

이는 StatefulService의 price가 공유되는 필드이기 때문에, 클라이언트가 접근해서 값을 변경할 수 있기 때문이다.

이런 큰 문제가 발생하기 때문에 스프링 빈은 항상 무상태(stateless)로 설계해야 한다.

@Configuration과 싱글톤

@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }
    
    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }
    
    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
    
    ...
    
}

위의 코드를 봐보자. memberService 빈을 만드는 코드는 memberRepository()를 호출한다. 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다. orderService 빈을 만드는 코드도 동일하게 memberRepository()를 호출한다.
이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.

이렇게 각각 다른 2개의 MemoryMemberRepository가 생성됨으로써 싱글톤이 깨지는 것처럼 보이는데 스프링 컨테이너는 이런 문제를 어떻게 해결할까?

● 검증 용도의 코드 추가

정말로 싱글톤이 깨졌는지 확인하여보자.

package hello.core.member;

public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;
	
    ...

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

public class OrderServiceImpl implements OrderService{

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

테스트를 위해 각 ServiceImpl에서 MemberRepository를 조회하는 기능을 추가한다. 테스트만을 위한 것이므로 인터페이스에까지 추가하지는 않는다.

● 검증을 위한 테스트 코드

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

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

        assertThat(memberService.getMemberRepository()).isEqualTo(memberRepository);
        assertThat(orderService.getMemberRepository()).isEqualTo(memberRepository);
    }
}

확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용되는 것을 알 수 있다.

AppConfig의 자바 코드 상 MemoryMemberRepository가 두 번 호출되기 때문에 다른 인스턴스가 생성되어야 하는데 그렇지 않다면, 한 번만 호출되는 것은 아닌지 확인해봐야 한다.

● AppConfig에 호출 로그 남김

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
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 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();
    }
}

MemberService, OrderService, MemberRepository이 호출되어 스프링 빈이 생성될 때마다 call 로그를 찍게 만들었다.

다시 테스트를 실행해보면

call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService

위와 같이 단 1번씩만 호출됨을 확인할 수 있다.

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

스프링 컨테이너는 싱글톤 레지스트리이기 때문에 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.

하지만 자바 코드를 보면 분명히 3번 호출되는 것이 맞다.

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

@Configuration을 적용한 AppConfig에 모든 비밀이 담겨 있다.

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

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

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

bean = hello.core.AppConfig$$EnhancerBySpringCGLIB$$9c1df86@4233e892

순수한 클래스라면 class hello.core.AppConfig와 같이 출력되어야 한다. 하지만 실제 결과를 보면 xxxCGLIB가 붙은 것을 확인할 수 있는데, 이는 개발자가 만든 클래스가 아니라 CHLIB라는 바이트코드 조작 라이브러리가 AppConfig 클래스를 상속받은 임의의 클래스를 만들고, 이것을 스프링에 등록한 것이다.

실제 등록되는 스프링 빈은 이름은 appConfig이름을 가져가고, @CGLIB 클래스의 인스턴스가 등록된다.

이렇게 CGLIB 바이트코드 조작 라이브러리를 사용하여 만든 클래스가 스프링 빈이 싱글톤이 되도록 보장해준다.

아마 아래처럼 바이트 코드를 조작하여 작성되어 있을 것이다. (실제는 CGLIB의 내부 기술을 사용하여 훨씬 복잡하다.)

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

@Bean이 붙은 메소드마다 스프링 빈이 존재하는지 확인하여 이미 존재하면 존재하는 빈을 반환하고, 없으면 생성하여 반환하는 코드가 동적으로 생성된다. 이 덕분에 싱글톤이 보장되는 것이다.

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

@Configuration을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약 @Bean만 적용하면 어떻게 될까?

@Configuration을 주석 처리한 후 테스트를 다시 실행해보면

bean = class hello.core.AppConfig

CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다. 이 말은 싱글톤이 보장되지 않는다는 말이다.

call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
call AppConfig.memberRepository

스프링 빈 등록 시 저번과 다르게 memberRepository가 3번 호출된다. memberService와 orderService에 주입되는 memberRepository 객체는 스프링에 등록된 빈 객체가 아닌, 메서드 호출로 새로 생성된 인스턴스가 주입된다.

그렇기 때문에 각각 다 다른 MemoryMemberRepository 인스턴스를 가질 것이다.

'개발 > 스프링 기본' 카테고리의 다른 글

(스프링 기본) 7. 의존관계 자동 주입 (0)	2022.10.31
(스프링 기본) 6. 컴포넌트 스캔 (0)	2022.10.27
(스프링 기본) 4. 스프링 컨테이너와 스프링 빈 (0)	2022.10.05
(스프링 기본) 3. 스프링 핵심 원리 이해 2 - 객체 지향 원리 적용 (0)	2022.10.02
(스프링 기본) 2. 스프링 핵심 원리 이해 1 - 예제 만들기 (0)	2022.09.28