Singleton
-
싱글톤이란?
- Web application은 일반적으로 다수의 사용자가 하나의 Server에 동시의 많은 요청을 하게됩니다. Singleton으로 디자인하지 않은 Web application의 java는 사용자의 요청마다 하나의 객체를 생성하게 되고 10,000건의 요청은 10,000개의 객체를 상속받은 객체라면 그 이상의 객체를 생성하게 됩니다.
- 이러한 방식으로 디자인된 application은 엄청난 메모리 낭비를 하게됩니다.
- 싱글톤 디자인을 사용하게 되면 java server에서 여러개의 요청이 들어와도 class Instance가 1개만 생성되는 것을 보장하게됩니다.
-
java로 싱글톤 패턴을 구현해보기static final을 사용하여 java server에서는 오직 한개의 instance만을 가질 수 있게 설계하였고 getInstance() 메서드를 통해 instance를 다른 서비스 로직에서도 하나의 instance를 공유할 수 있도록 만들었습니다.
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); }
테스트 코드를 통해 출력되는 객체의 주소값을 확인하면 같은 객체를 참조하고 있다는걸 알수 있습니다.
우리는 싱글톤 패턴 디자인을 잘 구현해낸거 같지만 이 디자인은 문제가 있습니다.
- 싱글톤 패턴의 문제점
- 싱글톤 패턴 구현 코드자체가 길다. (instance 객체 선언 코드, 생성자 제한)
- DIP를 위반한다.
- OCP를 위반할 가능성이 높다.
- 테스트를 하기 어렵다.
- 생성자로 자식 class를 만들기 어렵다.
- 내부 로직 변경 및 초기화가 어렵다.
- 위 이유들로 유연성이 떨어진다.
- 안티패턴으로 불리기도 한다.
이런 문제들이 많은데 어떻게 우리는 Web application에 디자인 패턴으로 싱글톤 패턴을 사용하고 있을까요? 그건 바로 Spring의 싱글톤 컨테이너를 사용하면 위 문제들을 모두 Spring이 해결해주기 때문입니다.
Singleton Container
싱글톤 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 싱글톤 패턴의 목표를 그대로 실행할 수 있게 해줍니다. 지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되고 있는 빈들입니다.
-
Singleton Container란
- 스프링 컨테이너는 싱글턴 패턴을 코드로 직접 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리해줍니다.
- 스프링 컨테이너는 싱글톤 컨테이너 역할을 해줍니다. 또한 이렇게 싱글톤으로 객체를 생성하고 관리하는 기능을 싱글톤 레지스트라 부릅니다.
- 스프링 컨테이너로 싱글턴 패턴의 모든 단점을 해결하고 객체는 싱글톤으로 유지할 수 있습니다.
@Test @DisplayName("스프링 컨테이너와 싱글톤") void springContainer(){ //AppConfig appConfig = new AppConfig(); AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class); // 조회 : 호출할때마다 객체를 생성 MemberService memberService1 = ac.getBean("memberService", MemberService.class); // 조회 : 호출할때마다 객체를 생성 MemberService memberService2 = ac.getBean("memberService", MemberService.class); //참조값이 다른 것을 확인 System.out.println("memberService1 = " + memberService1); System.out.println("memberService2 = " + memberService2); Assertions.assertThat(memberService1).isSameAs(memberService2); }
위 테스트 코드를 실행하면 주소값이 동일한 결과값을 확인할 수 있습니다.
하지만 싱글톤 방식으로 프로젝트를 만들때 주의하셔야할 점이 있습니다.
싱글톤 방식의 주의점
-
싱글톤 방식의 주의점
- 객체 인스턴스를 하나만 생성해서 공유하는 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 객체는 상태를 유지하게 설계하면 안된다!
- 무상태(stateless)로 설계해야한다.
- 특정 클라이언트에 의존적인 필드가 있으면 안된다.
- 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
- 읽기만을 가능하게 설계하는게 좋다.
- 필드 대신에 java에서 공유하지 않는 값들인 지역변수, 파라미터, 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; } }
위 코드처럼 상태를 변경할 수 있는 stateful 객체 인스턴스를 만들었습니다.
@Test
void statefulServiceSingleton(){
AnnotationConfigApplicationContext 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();
System.out.println("price = " + price);
Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}위 테스트를 진행하면 A라는 사용자는 10000원의 상품을 주문했고 B라는 사용자는 20000원의 상품을 주문했습니다. 하지만 우리의 java server는 싱글톤 패턴이기때문에 하나의 instance를 공유하고 그 instance의 price라는 필드는 값이 변경이 됩니다. 그렇기 때문에
위와 같이 A라는 사용자의 10000원의 가격은 20000원으로 변경되는 장애가 발생하게 됩니다.
@Configuration과 싱글톤
여기서 궁금한 점이 하나 생길수 있는데요. 그건 바로 AppConfig 파일을 보면서 확인해보겠습니다.
@Configuration
public class AppConfig {
//@Bean memberService -> new MemoryMemberRepository()
//@Bean orderService -> new MemoryMemberRepository()
@Bean
public MemberService memberService(){
System.out.println("call AppConfig.memberService");
//생성자 주입
return new MemberServiceImpl(memberRepository());
}
@Bean
public MemberRepository memberRepository() {
System.out.println("call AppConfig.memberRepository");
return new MemoryMemberRepository();
}
@Bean
public OrderService orderService(){
System.out.println("call AppConfig.orderService");
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public DiscountPolicy discountPolicy(){
return new RateDiscountPolicy();
}
}위 코드에서 memberService와 orderService에서 2번의 MemeoryMemeberRepository()의 호출이 생기고 memberRepository 자체에서 또 한번 해서 총 3번의 MemeoryMemeberRepository의 호출이 발생합니다. 그러면 스프링 컨테이너에서 이 인스턴스를 어떻게 관리해야할까요? 3번의 호출의 인스턴스를 모두 만들어줘야할까요? 아니면 하나의 인스턴스로 공유시켜야할까요? 싱글톤 패턴을 따르면 하나로 공유시켜야합니다. 이 방법을 가능하게 해주는 Spring의 기능이 바로 @Configuration에서 바이트코드 조작하는 라이브러리 CGLIB기술을 사용하기 때문입니다.
@Configuration의 바이트코드 조작
@Bean
public MemberRepository memberRepository() {
if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
return 스프링 컨테이너에서 찾아서 반환;
} else { //스프링 컨테이너에 없으면
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
return 반환
}
}위 코드같은 조작으로 컨테이터의 인스턴스를 등록할지 안할지를 정해서 인스턴스를 관리해주고 싱글톤을 보장한다.
