public class SingletonTest {
@Test
@DisplayName("스프링 없는 순수한 DI 컨테이너")
void pureContainer() {
AppConfig appConfig = new AppConfig();
// 1. 조회: 호출할 때마다 객체를 생성
MemberService memberService1 = appConfig.memberService();
// 2. 조회: 호출할 때마다 객체를 생성
MemberService memberService2 = appConfig.memberService();
// 참조값이 다른 것을 확인
Assertions.assertThat(memberService1).isNotSameAs(memberService2);
}
}
클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴
new
키워드를 사용하지 못하도록 막아야 한다.싱글톤 패턴을 적용한 예제 코드
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() {
}
}
private static final SingletonService instance = new SingletonService();
자기 자신을 static 으로 내부에 선언해 객체 생성 → 클래스 레벨에서 인스턴스를 하나만 가지게 된다.
private 생성자
private SingletonService() {
}
new
키워드를 막아두었다.조회 함수
public static SingletonService getInstance() {
return instance;
}
SingletonService
static 영역에 new
로 생성한 객체의 참조를 instance에 넣는다.static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
이 객체 인스턴스가 필요하면 오직 getInstance()
메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private 으로 막아서 혹시라도 외부에서 new
키워드로 객체 인스턴스가 생성되는 것을 막는다.
싱글톤 패턴을 사용하는 테스트 코드
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
SingletonService singletonService1 = SingletonService.getInstance();
SingletonService singletonService2 = SingletonService.getInstance();
assertThat(singletonService1).isSameAs(singletonService2);
}
isSameAs
: 주소 비교. 메모리 상에서 같은 객체를 참조하는지 확인 ( ==
)isEqualTo
: 값 비교. 객체가 서로 같은 값을 가지고 있는지 확인 ( equals()
)→ 스프링 컨테이너를 사용하면, 기본적으로 모든 객체를 싱글톤으로 만들어 관리해준다.
싱글톤 패턴을 적용하면 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유 해서 효율적으로 사용할 수 있다. 하지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있다.
싱글톤 패턴 문제점
스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리 한다.
지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.:"
싱글톤 컨테이너
스프링 컨테이너를 사용하는 테스트 코드
@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
// 1. 조회: 호출할 때마다 객체를 생성
MemberService memberService1 = applicationContext.getBean("memberService", MemberService.class);
// 2. 조회: 호출할 때마다 객체를 생성
MemberService memberService2 = applicationContext.getBean("memberService", MemberService.class);
// 참조값이 같은 것을 확인
assertThat(memberService1).isSameAs(memberService2);
}
스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유 해서 효율적으로 재사용할 수 있다.
참고: 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공한다. 자세한 내용은 뒤에 빈 스코프에서 설명하겠다.
싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.
ThreadLocal
등을 사용해야 한다.상태를 유지할 경우 발생하는 문제점 예시
class StatefulServiceTest {
@Test
void statefulServiceSingleton() {
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = applicationContext.getBean("statefulService", StatefulService.class);
StatefulService statefulService2 = applicationContext.getBean("statefulService", StatefulService.class);
// Thread A: userA가 10000원을 주문
statefulService1.order("userA", 10000);
// Thread B: userB가 20000원을 주문
statefulService1.order("userB", 20000);
// Thread A: userA가 주문 금액을 조회
int priceA = statefulService1.getPrice();
// ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
System.out.println("priceA = " + priceA);
// Thread B: userB가 주문 금액을 조회
int priceB = statefulService2.getPrice();
System.out.println("priceB = " + priceB);
assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}
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()
를 호출한다.new MemoryMemberRepository()
를 호출한다.orderService
빈을 만드는 코드도 동일하게 memberRepository()
를 호출한다.new MemoryMemberRepository()
를 호출한다.결과적으로 각각 다른 2개의 MemoryMemberRepository
가 생성되면서 싱글톤이 깨지는 것처럼 보인다.
스프링 컨테이너는 이 문제를 어떻게 해결할까?
검증 용도의 테스트 코드 추가
테스트를 위해 MemberRepository
를 조회할 수 있는 기능을 잠깐 추가했다.
기능 검증을 위해 잠깐 사용하는 것이니 인터페이스에 조회기능까지 추가하지는 않았다.
public class ConfigurationSingletonTest {
@Test
void configurationTest() {
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
MemberServiceImpl memberService = applicationContext.getBean("memberService", MemberServiceImpl.class);
OrderServiceImpl orderService = applicationContext.getBean("orderService", OrderServiceImpl.class);
MemberRepository memberRepository = applicationContext.getBean("memberRepository", MemberRepository.class);
//모두 같은 인스턴스를 참고하고 있다.
assertThat(memberService.getMemberRepository()).isSameAs(orderService.getMemberRepository());
assertThat(memberRepository).isSameAs(orderService.getMemberRepository());
}
}
memberRepository
인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.AppConfig
의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository
호출해서 다른 인스턴스가 생성되어야 하는데?AppConfig에 호출 로그 남기기
@Configuration
public class AppConfig {
@Bean
public MemberService memberService() {
//1번
System.out.println("call AppConfig.memberService"); return new MemberServiceImpl(memberRepository());
}
@Bean
public OrderService orderService() {
//1번
System.out.println("call AppConfig.orderService"); return new OrderServiceImpl(
memberRepository(),
discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
//2번? 3번?
System.out.println("call AppConfig.memberRepository"); return new MemoryMemberRepository();
}
@Bean
public DiscountPolicy discountPolicy() {
return new RateDiscountPolicy();
}
}
스프링 컨테이너가 각각 @Bean
을 호출해서 스프링 빈을 생성한다. 그래서 memberRepository()
는 다음과 같이 총 3번이 호출되어야 하는 것 아닐까?
스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean
이 붙어있는 memberRepository()
호출
memberService()
로직에서 memberRepository()
호출
orderService()
로직에서 memberRepository()
호출
그런데 출력 결과는 모두 1번만 호출된다.
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.
그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다. 저 자바 코드를 보면 분명 3번 호출되어야 하는 것이 맞다.
그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.
모든 비밀은 @Configuration
을 적용한 AppConfig
에 있다.
@Test
void configurationDeep() {
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
// AppConfig도 스프링 빈으로 등록된다.
AppConfig appConfig = applicationContext.getBean("appConfig", AppConfig.class);
System.out.println("appConfig.getClass() = " + appConfig.getClass());
// 출력: appConfig.getClass() = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$1b53d1be
}
appConfig.getClass() = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$1b53d1be
순수한 클래스라면 다음과 같이 출력되어야 한다.
class hello.core.AppConfig
그런데 예상과는 다르게 클래스 명에 xxxCGLIB가 붙으면서 상당히 복잡해진 것을 볼 수 있다.
이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다!
그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다. 아마도 다음과 같이 작성되어 있을 것이다.
AppConfig@CGLIB 예상코드
@Bean
public MemberRepository memberRepository() {
if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
return 스프링 컨테이너에서 찾아서 반환;
} else { //스프링 컨테이너에 없으면
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록 return 반환
}
}
→ 덕분에 싱글톤이 보장되는 것이다.
@Configuration 을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약 @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()
를 호출하면서 발생한 코드다.
@Bean
만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다.memberRepository()
처럼 의존관계 주입이 필요해 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.@Configuration
을 사용하자.