Spring -[싱글톤 컨테이너] #5

김영한 - 스프링 핵심 원리 기본편을 듣고 정리한 내용입니다.

 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

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

📝목차

5. 싱글톤 컨테이너

• 웹 애플리케이션과 싱글톤
• 싱글톤 패턴
• 싱글톤 컨테이너
• 싱글톤 방식의 주의점
• @Configuration과 싱글톤
• @Configuration과 바이코드 조작의 마법

---

📌웹 애플리케이션과 싱글톤

• 스프링은 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
• 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. (웹 아닌 애플리케이션도 개발 가능)
• 웹 애플리케이션은 여러 고객이 동시에 요청한다.

💡스프링 없는 순순한 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);
        
 		//memberService1 != memberService2
 		assertThat(memberService1).isNotSameAs(memberService2);
 	}
}

• 우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 객체를 새로 생성한다.
• 고객 트래픽이 초당 100 -> 100개의 객체가 생성되고 소멸 (메모리 낭비가 심함)
• 해결방안: 해당 객체가 1개만 생성되고 공유하도록 설계 (싱글톤 패턴)

📌싱글톤 패턴

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

💡싱글 패턴을 적용한 예제 코드

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

💡싱글 패턴을 사용한 테스트 코드

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

• priavte으로 new 키워드를 막아두었다.
• 호출할 때 마다 객체 인스턴스를 반환

싱글톤 패턴 구현방법: 객체를 미리 생성해두는 방법 선택

 

💡싱글 패턴 문제점

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

📌싱글톤 컨테이너

 

💡싱글톤 컨테이너

• 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
  • 컨테이너는 객체를 하나만 생성해서 관리
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 싱글톤 객체를 생성하고 관리하는 기능 => 싱글톤 레지스트리
• 객체를 싱글톤으로 유지가능 -> 스프링 컨테이너의 기능들 덕분에
  • 싱글톤 패턴을 위한 불필요한 코드가 들어가지 않아도 된다.
  • DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다.

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

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

💡싱글톤 컨테이너 적용 후

• 고객의 요청이 올 때 마다 객체 생성x -> 이미 만들어진 객체를 공유

참고: 스프링의 기본 등록 방식은 싱글톤, 그러나 요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공

📌싱글톤 방식의 주의점

• 싱글톤 객체는 상태를 유지하게 설계하면 안된다.
• 무상태로 설계해야 한다.
  • 특정 클라이언트에 의존적인 필드가 있으면 안됨
  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안됨
  • 가급적 읽기만 가능해야함
  • 필드 대신에 자바에서 공유되지 않은 지역변수, 파라미터, 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();
 		}
 	}
}

• 쓰레드 사용x
• ThreadA가 사용자a 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하면
• StatefulService의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 사용자A의 주문금액은 10000원이 되어야하는데, 20000원이라는 결과가 나옴
• 스프링 빈은 항상 무상태로 설계하자.

📌@Configuration과 싱글톤

💡AppConfig 코드

@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() 호출

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

• 스프링 컨테이너는 싱글톤 레지스트리이다. 

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

• AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래서 AppConfig도 스프링 빈이 된다.
• AppConfig 스프링 빈 조회 -> 클래스 정보 출력

bean = class.hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70

• 이런 코드가 나오는 이유는 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다

💡AppConfig@CGLIB 예상 코드

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

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

AppConfig@CGLIB는 AppConfig의 자식타입이므로, AppConfig 타입으로 조회 할 수 있다.

💡@Configuration을 적용하지 않고, @Bean만 적용하면?

//@Configuration 삭제
public class AppConfig {

}

bean = class hello.core.AppConfig

AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.

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

• MemberRepository가 3번 호출됨. 1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서이고, 2번은 각각 memberRepository()를 호출하면서 발생한 코드다.

💡인스턴스가 같은지 테스트 결과

memberService -> memberRepository =
hello.core.member.MemoryMemberRepository@6239aba6
orderService -> memberRepository =
hello.core.member.MemoryMemberRepository@3e6104fc
memberRepository = hello.core.member.MemoryMemberRepository@12359a82

• 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있다.

💡정리

• @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다.
  • memberRepository() 처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.
• 스프링 설정 정보는 항상 @Configuration을 사용하자.