스프링에서의 싱글톤 컨테이너

 

📌 싱글톤 패턴

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

• 싱글톤 패턴을 이용한 객체 생성 코드

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

테스트 코드로 알 게 된 점

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

SingletonService 에서 만들어둔 객체를 공유하며 사용한다.

즉 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.

싱글톤 패턴의 문제점

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

📌 싱글톤 컨테이너

싱글톤 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리한다.

스프링 컨테이너는 싱글톤 컨테이너 역할을 하는데, 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다.

스프링 컨테이너의 기능 덕분에 싱글톤 패턴의 단점(싱글톤 패턴 구현 코드 작성, DIP, OCP 위반 등)을 해결하며 객체를 싱글톤으로 유지할 수 있다.

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

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

싱글톤 컨테이너 덕분에 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라 이미 만들어진 객체를 공유해서 효율적으로 재사용이 가능하다.

싱글톤 방식의 주의점

객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지하게 설계되면 안된다.

즉 무상태로 설계가 되어야한다.

무상태란
특정 클라이언트에 의존적인 필드가 있으면 안된다.
특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
가급적 읽기만 가능해야한다.
필드 대신 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal등을 사용해야한다.

 

• 상태를 유지하는 코드

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

 

이렇게 작성될 경우 추후 사용자A가 10000원을 결제하고 사용자B가 20000원을 결제한 후 사용자A가 본인의 결제 내역을 조회했을 때 사용자B의 결제 내역이 보이는 큰 문제가 발생한다.

이러한 문제가 발생하는 이유는 StatefulService 의 price 필드는 공유가 되는 필드이기 때문에 값이 변경되면 모든 클라이언트의 값이 변경되기 때문에 발생한다.

따라서 공유 필드는 항상 조심해야하며 스프링 빈은 항상 무상태로 설계하는 것이 중요하다.

📌 @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() 를 호출한다.

이때 memberRepository() 를 호출하면 new MemberyMemberReppository() 를 호출한다.

orderService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다.

이때도 memberRepository() 를 호출하면 new MemberyMemberReppository() 를 호출한다.

즉 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것처럼 보인다.

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

new MemberyMemberReppository() 를 여러번 호출해도 하나의 인스턴스만 생성되는 이유

 

결론적으로는 @Configuration 을 적용했기 때문이다.

먼저 AppConfig 클래스 타입을 살펴보면

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

으로 출력되는 것을 확인할 수 있다.

일반적인 순수 클래스라면 class hello.core.AppConfig 를 출력해야하지만 CGLIB 가 붙고 있다.

즉 내가 만든 AppConfig 클래스가 아닌 스프링이 CGLIB 라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속 받은 임의의 자식 클래스를 만들고 그 자식 클래스를 스프링 빈으로 등록한 것이다.

 

AppConfig를 상속받은 자식 클래스가 바로 싱글톤이 보장되도록 해준다. 또한 자식 클래스이므로 AppConfig 타입으로 조회가 가능하다.

• AppConfig@CGLIB 의 예상 코드

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

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

만약 @Configuration을 적용하지 않는다면?

 

AppConfig 클래스 타입을 조회해보았을 때

bean = class hello.core.AppConfig

다음과 같이 순수한 AppConfig로 스프링 빈에 등록된다.

하지만 싱글톤 보장이 어렵다.

 

참고
인프런:  스프링 핵심 원리 - 기본편 (김영한)