저번 포스팅에서 DI의 필요성을 순수한 자바 코드로 살펴보고 이를 스프링에서 제공하는 DI로 리팩토링하였습니다. 이번 포스팅에서는 스프링에서 제공하는 DI를 사용하였을 경우 얻는 장점 중 하나인 싱글톤(Singleton)에 대해서 알아보겠습니다.
싱글톤 패턴 (Singleton Pattern)
싱글톤이 무엇인지 그리고 중요성을 알아보기 위해 스프링으로 만든 웹 애플리케이션을 다수의 클라이언트가 사용한다고 가정해 보겠습니다. 보통 웹 애플리케이션의 경우 여러 클라이언트가 동시에 요청을 보냅니다.
위 그림처럼 만약 클라이언트 A, B, C가 orderService에 대해 요청을 한다면, DI 컨테이너는 A, B, C에게 각각 다른 orderService 객체를 반환해 줍니다.
@Test
@DisplayName("스프링 없는 순수한 DI 컨테이너")
void pureContainer1() {
AppConfig appConfig = new AppConfig();
OrderService orderService1 = appConfig.orderService();
OrderService orderService2 = appConfig.orderService();
System.out.println("orderService1 = " + orderService1);
System.out.println("orderService2 = " + orderService2);
Assertions.assertThat(orderService1).isNotSameAs(orderService2);
}
두 객체의 참조 값이 다른 걸 보았을 때, 저번 포스팅에서 우리가 만들었던 순수한 DI 컨테이너인 AppConfig는 클라이언트가 orderService 요청을 보낼 때마다 객체를 새로 생성하는 것을 확인할 수 있습니다.
위와 같이 클라이언트가 서비스를 요청할 때마다 객체를 새로 생성한다면 메모리 낭비가 심하다는 문제점이 발생하게 됩니다.
이러한 문제점을 해결하기 위해 해당 객체가 딱 1개만 생성되고, 공유하는 패턴이 싱글톤(Singleton) 패턴입니다. 다시 말해, 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴입니다. 따라서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야합니다.
이를 자바 코드로 구현하면 다음과 같이 구현할 수 있습니다.
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
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
SingletonService singletonService1 = SingletonService.getInstance();
SingletonService singletonService2 = SingletonService.getInstance();
System.out.println("singletonService1 = " + singletonService1);
System.out.println("singletonService2 = " + singletonService2);
Assertions.assertThat(singletonService1).isSameAs(singletonService2);
}
싱글톤을 적용하였을 때, 호출할 때마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있습니다.
싱글톤 패턴 문제점
싱글톤 패턴을 적용하면 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있습니다.
-
싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
-
의존관계상 클라이언트가 구체 클래스에 의존한다. (ex. 구체클래스.getInstance()) → DIP를 위반한다.
-
클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
-
테스트하기 어렵다.
-
내부 속성을 변경하거나 초기화 하기 어렵다.
-
private 생성자로 자식 클래스를 만들기 어렵다.
즉, 싱글톤 패턴을 사용하게 되면 유연성이 떨어지게 됩니다.
싱글톤 컨테이너
스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤으로 관리합니다. 지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈입니다.
-
스프링 컨테이너는 싱글톤 컨테이너 역할을 하기 때문에 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리합니다. 이러한 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있습니다.
-
싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 됩니다.
-
DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있습니다.
싱글톤 방식의 주의점
싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful) 하게 설계하는 것이 아니라 무상태(stateless)로 설계해야 합니다.
그 말인즉슨 다음과 같습니다.
-
특정 클라이언트에 의존적인 필드가 있으면 안 된다.
-
특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다.
-
가급적 읽기만 가능해야 한다.
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);
// Thread A : A 사용자 10000원 주문
statefulService1.order("userA", 10000);
// Thread B : B 사용자 20000원 주문
statefulService2.order("userB", 20000);
// Thread A : A 사용자 주문 금액 조회
int price = statefulService1.getPrice();
System.out.println("price = " + price);
}
@Configuration
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}Thread A가 A 사용자 코드를 호출하고 Thread B가 B 사용자 코드를 호출한다 가정하겠습니다.
StatefulService 클래스의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경할 수 있도록 설계하였습니다.
위와 같은 상황에서 A 사용자의 주문금액의 기대 결과는 10000원이지만 이 코드로 실행했을 때, 실제 결과는 20000원이 나오는 것을 확인할 수 있습니다.
이러한 상황을 막기 위해 아래 코드처럼 공유되는 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터 등을 사용하여 항상 무상태(stateless)로 설계해야 합니다.
public class StatefulService {
public int order(String name, int price) {
System.out.println("name = " + name + " price = " + price);
return price;
}
}
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class)
StatefulService statefulService1 = ac.getBean(StatefulService.class);
StatefulService statefulService2 = ac.getBean(StatefulService.class);
// Thread A : A 사용자 10000원 주문
int userAPrice = statefulService1.order("userA", 10000);
// Thread B : B 사용자 20000원 주문
int userBPrice = statefulService2.order("userB", 20000);
System.out.println("userAPrice = " + userAPrice);
System.out.println("userBPrice = " + userBPrice);
}
@Configuration
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}정리하자면 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식을 사용할 때, 공유 필드는 조심해야 합니다. 스프링 빈은 항상 무상태(stateless)로 설계하도록 노력해야 합니다.
Reference
