[Spring/기본편] 4. 싱글톤 컨테이너
웹 애플리케이션과 싱글톤
- 스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다고 합니다.
- 대부분의 스프링 애플리케이션은 웹 애플리케이션입니다. 물론 웹이 아닌 애플리케이션 개발도 얼마든지 개발할 수 있습니다.
- 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 합니다.
객체가 다른 것 확인
@Test
@DisplayName("스프링 없는 순수한 DI 컨테이너")
void pureContainer() {
AppConfig appConfig = new AppConfig();
// 1. 조회 : 호출할 때 마다 객체를 생성
MemberService memberService = appConfig.memberService();
// 2. 조회 : 조회할 때 마다 객체를 생성
MemberService memberService1 = appConfig.memberService();
// 참조값이 다른 것을 확인
System.out.println("memberService1 : " + memberService);
System.out.println("memberService2 : " + memberService1);
// memberService != memberService1
assertThat(memberService).isNotSameAs(memberService1);
}
// 출력
// memberService1 : hello.core.member.MemberServiceImpl@1e6a3214
//memberService2 : hello.core.member.MemberServiceImpl@3e27aa33
- 위의 출력을 보면 실제로 참조값이 다른 것을 확인할 수 있습니다.
- 클라이언트가 적은 경우는 괜찮겠지만, 클라이언트가 많은 경우 고객 요청이 1초에 100개가 나오면 초당 100개가 생성되고 소멸됨으로써 메모리 낭비가 심해집니다.
- 이를 해결하기 위해 객체가 딱 1개만 생성되고, 공유하도록 설계하면 됩니다. 이것이 싱글톤 패턴입니다.
싱글톤 패턴
싱글톤 패턴을 알기 전 디자인 패턴에 대해 잘 모르시는 분이 있을수도 있을 것 같아 조금 설명해보고자 합니다. 디자인 패턴은 과거 개발자분들이 개발하면서 겪은 노하우들을 패턴화 시킨 것 입니다. 싱글톤 같은 경우에는 메모리 낭비를 줄이고자 과거 개발자가 만든 디자인 패턴이라고 보면 됩니다.
싱글톤 패턴은 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴입니다. 그렇기 떄문에 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 합니다. 인스턴스가 2개 생성되는 것을 막기위해 private 생성자를 사용해서 외부에서 임의로 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() {}
public void logic() {
System.out.println("싱글톤 객체 로직 호출");
}
}
- static 영역에 객체 instance를 미리 하나 생성해서 올려둡니다.
- 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있습니다. (항상 같은 인스턴스를 반환합니다.)
- 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private로 막아서 외부에서 New 키워드로 생성되는 것을 막아줍니다.
Test 코드
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
//private으로 생성자를 막아두었다. 컴파일 오류가 발생한다.
// new SingletonService();
// 1. 조회 : 호출할 때 마다 같은 객체를 반환
SingletonService singletonService = SingletonService.getInstance();
// 2. 조회 : 호출할 때 마다 같은 객체를 반환
SingletonService singletonService1 = SingletonService.getInstance();
// 참조값이 같은 것을 확인
System.out.println("singletonService1 : " + singletonService);
System.out.println("singletonService2 : " + singletonService1);
// singletonService1 == singletonService2
assertThat(singletonService).isSameAs(singletonService1);
singletonService1.logic();
}
// 출력
//singletonService1 : hello.core.singleton.SingletonService@795509d9
//singletonService2 : hello.core.singleton.SingletonService@795509d9
//싱글톤 객체 로직 호출
- private로 new 키워드를 막아두었습니다.
- 호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있습니다.
싱글톤 패턴을 적용하면 만들어진 객체를 공유하기 떄문에 효율적으로 사용할 수 있습니다. 하지만 싱글톤 패턴은 수 많은 문제점들을 가지고 있습니다.
싱글톤 패턴 문제점
- 싱글톤 패턴을 구현하는 코드 자체가 많이 들어갑니다.
- 의존관계상 클라이언트가 구체 클래스에 의존합니다. (DIP 의존관계 역전 원칙을 위반합니다.)
- 클라이언트가 구체 클래스에 의존해서 OCP(개발-폐쇄 원칙)를 위반할 가능성이 높습니다.
- 테스트하기 어렵습니다. (DIP, OCP, 테스트에 관해서는 아직 공감하기 어려운 것 같습니다..)
- 내부 속성을 변경하거나 초기화하기 어렵습니다.
- private 생성자로 자식 클래스를 만들기 어렵습니다.
- 결론적으로 유연성이 떨어집니다.
싱글톤 컨테이너
스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리합니다.
지금까지 학습했던 스프링 빈이 바로 싱글톤으로 관리되는 빈입니다.
스프링 컨테이너
- 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리합니다.
- 이전에 설명한 컨테이너 생성 과정을 자세히 보면, 컨테이너는 객체를 하나만 생성해서 관리합니다.
- 스프링 컨테이너는 싱글톤 컨테이너 역할을 합니다. 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 합니다.
- 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 하나만 생성하여 공유할 수 있습니다.
- 싱글톤 패턴을 위한 지저분한 코드가 없어집니다.
- DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있습니다.
Test 코드
@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
// 1. 조회 : 호출할 때 마다 같은 객체를 반환
MemberService memberService = ac.getBean("memberService", MemberService.class);
// 2. 조회 : 호출할 때 마다 같은 객체를 반환
MemberService memberService1 = ac.getBean("memberService", MemberService.class);
// 참조값이 같은 것을 확인
System.out.println("memberService1 : " + memberService);
System.out.println("memberService2 : " + memberService1);
// memberService == memberService1
assertThat(memberService).isSameAs(memberService1);
}
싱글톤 컨테이너 적용 후
스프링 컨테이너 덕분에 고객의 요청이 올때마다 이미 만들어진 객체를 공유해서 효율적으로 재사용 합니다.
싱글톤 방식의 주의점
- 싱글톤 반식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 떄문에 상태를 유지(stateful)하게 설계하면 안됩니다.
- 무상태(stateless)로 설계해야 합니다.
- 특정 클라이언트에 의존적인 필드가 있으면 안됩니다.
- 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안됩니다.
- 가급적 읽기만 가능해야 합니다.
- 필드 대신 자바에서 공유되지 않는 지역변수, 파라미터, 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;
}
}
테스트 코드
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = ac.getBean(StatefulService.class);
StatefulService statefulService2 = ac.getBean(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();
}
}
// 출력
//name = userA price = 10000
//name = userB price = 20000
//price = 20000
실제 쓰레드가 아닌 예시로 코드를 작성해보았습니다. 결과적으로 statefulService1에 price는 10000원을 등록했지만, 20000원으로 바뀌는 현상을 볼 수 있습니다. 실무에서 이런 경우가 종종 있는데 정말 어려운 큰 문제들이 터진다고 합니다. 따라서, 공유 필드는 조심해야한다고 하고 스프링 빈은 항상 무상태(stateless)로 설계하는 습관을 들이면 좋을 것 같습니다.
@Configuration과 싱글톤
그런데 이상한 점이 있습니다. 아래의 AppConfig.class의 코드를 보면 orderService()를 호출할 때마다 MemoryMemberRepository, MemberServiceImpl가 new로 생성되면서 반환이 됩니다. 이러면 객체를 한 번만 생성한 뒤 재사용하는 것이 아니라 계속해서 생성하는 것이 아닐까??라는 생각이 들게 됩니다.
@Configuration // 설정 정보에 하는 어노테이션
public class AppConfig {
@Bean // 각 메서드에 Bean 어노테이션을 추가하면 스프링 컨테이너에 추가됨.
public MemberService memberService() {
return new MemberServiceImpl(getMemberRepository());
}
@Bean
public MemberRepository getMemberRepository() {
return new MemoryMemberRepository();
}
@Bean
public OrderService orderService() {
return new OrderServiceImpl(
getMemberRepository(),
getDigcountPolicy());
}
@Bean
public DiscountPolicy getDigcountPolicy() {
//return new FIxDiscountPolicy();
return new RateDiscountPolicy();
}
}
그래서 스프링 컨테이너는 이 문제를 어떻게 해결하나 직접 테스트 해보기로 합니다.
테스트를 위한 코드 추가
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;
}
}
테스트를 위해 MemberRepository를 조회할 수 있는 기능을 추가했습니다.
테스트 코드
@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);
}
//출력
//memberService -> memberRepository = hello.core.member.MemoryMemberRepository@650eab8
//orderService -> memberRepository = hello.core.member.MemoryMemberRepository@650eab8
//memberRepository = hello.core.member.MemoryMemberRepository@650eab8
실제 확인해보니 다른 인스턴스가 아닌 같은 인스턴스를 재사용하는 것을 볼 수 있습니다. 실험을 통해서 어떻게 된 일인지 확인해보도록 하겠습니다.
AppConfig에 호출 로그를 남기는 방식을 통해 확인해보겠습니다.
@Bean
public MemberService memberService() {
//1번
System.out.println("call AppConfig.memberService");
return new MemberServiceImpl(memberRepository());
}
실제 빈 메서드 마다 안에 출력 로그를 작성하였습니다. 그 후 똑같이 위에 테스트 코드를 실행시켜보았습니다.
출력 결과
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
memberRepository()는 3번 호출되어야 할 것 같지만 실제로 한번만 호출이 되는 것을 볼 수 있습니다. 어떻게 이런 일이 가능한 걸까요??
@Configuration과 바이트코드 조작의 마법
앞서 실험해보았던 memberRepository()가 1번만 호출되는 것은 @Configuraion을 적용한 AppConfig에 있습니다.
테스트 코드
@Test
void configurationDeep() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("bean = " + bean.getClass());
}
// 출력
// bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$b9807240
- 사실 AnnotaionConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 동록됩니다. 그래서 AppConfig도 스프링 빈이 됩니다.
- AppConfig를 스프링 빈으로 조회해서 클래스 정보를 출력해보았습니다.
순수한 자바 클래스라면 class hello.core.AppConfig라고 출력 되야하지만, 뒤에 이상한 값이 붙습니다. 이것은 내가 만든 클래스가 아니라 스프링이 빈을 등록하는 과정속에서 조작을 하기 떄문입니다. 실제 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것 입니다.
위의 그림을 보시면, AppCOnfig@CGLIB라는 다른 클래스가 싱글톤을 보장해주도록 합니다.
AppConfig@CGLIB 예상 코드
@Bean
public MemberRepository memberRepository() {
if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
return 스프링 컨테이너에서 찾아서 반환;
} else { //스프링 컨테이너에 없으면
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
return 반환
}
}
@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성하여 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어질 것이라고 에상됩니다. 덕분에 앞서서 본 memberRepository()가 3번 생성되어야 하지만, 한번만 생성되도록 즉, 싱글톤이 보장되도록 하는 것 입니다.
그렇다면?? @Configuration을 적용하지 않고, @Bean만 적용하면 어떻게 될까요??
실제 @Configuration을 삭제하고 똑같이 테스트 코드를 실행해보니
출력
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
call AppConfig.memberRepository
memberRepository가 총 3번 호출되는 것을 알 수 있습니다.
인스턴스가 같은지 테스트 결과
memberService -> memberRepository = hello.core.member.MemoryMemberRepository@6239aba6
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@3e6104fc
memberRepository = hello.core.member.MemoryMemberRepository@12359a82
당연히 각각 다른 MemoryMemberRepository 인스턴스를 가지고 있었습니다.
정리
- @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 확실하게 보장하지 않습니다.
- memberRepository()처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않습니다.
- 결론적으로 스프링 설정 정보는 항상 @Configuration을 사용하면 됩니다.
출처
스프링 핵심 원리 - 기본편 - 인프런 | 강의
스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...
www.inflearn.com