싱글톤 컨테이너

유병익·2022년 10월 17일
Spring
0

스프링 핵심 원리

목록 보기
5/9
post-thumbnail

1. 웹 애플리케이션 & 싱글톤

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

  • Test Code
    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);
				 //memberService1 != memberService2
				 assertThat(memberService1).isNotSameAs(memberService2);
		 }
}
  • 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청마다 객체를 새로 생성
  • 메모리 낭비가 심하다.

💡 해당 객체가 딱 1개만 생성되고, 공유하도록 설계 → 싱글톤 패턴

2. 싱글톤 패턴

클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴

💡 private 생성자를 사용 → 외부에서 임의로 new 키워드를 사용 X
  • Example Code
    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("싱글톤 객체 로직 호출");
		 }
}
  • Test
    @Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
public 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 키워드 X
  • 호출할 때 마다 같은 객체 인스턴스 반환

싱글톤 패턴을 적용하면 요청마다 객체를 생성 X

이미 만들어진 객체를 공유 → 효율적으로 사용

💡 하지만 싱글톤 패턴은 여러 문제점이 있음

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

3. 싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결 + 객체 인스턴스를 싱글톤으로 관리
스프링 빈 → 싱글톤으로 관리되는 빈

3.1 싱글톤 컨테이너

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

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

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

  • 스프링 컨테이너를 사용하는 Test Code

    @Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
		 ApplicationContext 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);
}
  • 싱글톤 컨테이너 적용 후

👍 스프링 컨테이너 덕분에 이미 만들어진 객체를 공유해서 효율적으로 재사용 가능

💡 스프링의 기본 빈 등록 방식은 싱글톤

But, 싱글톤 방식만 지원하는 것은 아님

요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공

3.1 싱글톤 방식의 주의점

싱글톤 객체는 Stateful하게 설계 X , Stateless로 설계해야 함

  • 특정 클라이언트에 의존적인 필드 X
  • 특정 클라이언트가 값을 변경할 수 있는 필드 X
  • 가급적 읽기만 가능해야 한다.
  • 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
  • Stateful 문제 Example Code
    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;
		 }
}
  • Test
    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();
				 }
		 }

}

👍 StatefulService 의 price필드는 공유되는 필드 → 특정 클라이언트가 값을 변경

👍 공유필드는 조심해야 한다!! 스프링 빈은 항상 Stateless 로 설계하자.

4. @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 가 생성되면서 싱글톤이 깨지는 것처럼 보임

  • Test Code

    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 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);
				 
			   //모두 같은 인스턴스를 참고하고 있다.
				 System.out.println("memberService -> memberRepository = " +	memberService.getMemberRepository());
				 System.out.println("orderService -> memberRepository = " +	orderService.getMemberRepository());
				 System.out.println("memberRepository = " + memberRepository);
				 //모두 같은 인스턴스를 참고하고 있다.
				 
				assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
				 
				assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
		 }
}

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

4.1 How?

  • 스프링 컨테이너는 싱글톤 레지스트리 → 스프링 빈이 싱글톤이 되도록 보장해주어야 함
  • AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록 → AppConfig 도 스프링 빈이 된다.
  • 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

  • CGLIB라는 바이트코드 조작 라이브러리 사용 → AppConfig 클래스를 상속받은 임의의 다른 클래스 생성 → 그 다른 클래스를 스프링 빈으로 등록
  • @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
  • 덕분에 싱글톤 보장

4.2 요약

⚡ @Configuration이 아닌@Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤 보장 X

의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤 보장 X

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

profile
유병익
Backend 개발자가 되고 싶은
이전 포스트

스프링 컨테이너와 스프링 빈

다음 포스트

컴포넌트 스캔

0개의 댓글