😶 웹 애플리케이션과 싱글톤
"싱글톤 컨테이너" 에 대해 알아보자. 객체가 현재 나의 JVM 안에 객체 인스턴스가 딱 하나만 있어야 되는 패턴을 말한다.
웹 애플리케이션은 보통 아래와 같이 여러 고객이 동시에 요청한다.
클라이언트 A, B, C가 memberService를 스프링에게 요청한다. 그럼 DI 컨테이너(AppConfig)에서 MemberServiceImpl을 객체로 생성해서 거기에 memberRepository를 주입하고 클라이언트한테 반환한다.
고객이 3번 요청을 하면 객체가 3개 생성되는 것이다. 계속 요청이 올 때마다 계속 뭔가를 만들어야 하는 상황인 것이다. 이 상황 자체가 문제인 것이다.
진짜 고객 요청이 올 때마다 이렇게 되나? 한번 코드로 살펴보자.
// SingletonTest.java
package hello.core.singleton;
import hello.core.AppConfig;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
public class SingletonTest {
@Test
@DisplayName("스프링 없는 순수한 DI 컨테이너")
void pureContainer() {
AppConfig appConfig = new AppConfig();
// 1. 조회 : 호출할 때마다 객체를 생성
MemberService memberService1 = appConfig.memberService();
// 2. 조회 : 호출할 때마다 객체를 생성
MemberService memberService2 = appConfig.memberService();
// 참조값이 다른 것을 확인
System.out.println("memberService1 = " + memberService1);
System.out.println("memberService2 = " + memberService2);
// memberService1 != memberService2
Assertions.assertThat(memberService1).isNotSameAs(memberService2);
}
}
테스트를 실행해보면, 1번, 2번 각각 다른 객체가 생성되는 것을 볼 수 있다. 이렇게 되면 JVM 메모리에 계속 객체가 생성되어서 올라갈 것이다. 매우 비효율적이다...
이러한 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 계속 생성한다. 고객 트래픽이 예를 들어, 초당 5000이 나오면 초당 5000개의 객체가 생성되고 소멸되므로 메모리가 엄청나게 낭비되는 재앙이 발생한다.
이 문제를 해결할 수 있는 아주 좋은 해결방안이 있는데, 바로 해당 객체를 딱 1개만 생성하고, 공유되도록 설계하면 된다. 아까 코드로 예를 들면, MemberServiceImpl를 딱 하나만 생성해놓고 공유해서 쓰면 된다는 것이다.
😎 싱글톤 패턴
이제 싱글톤 패턴을 이용해 앞선 문제를 해결해보자. 싱글톤 패턴은 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다. 이거 어떻게 구현하냐? 그냥 객체 인스턴스를 2개 이상 생성하지 못하도록 막으면 된다.
바로 코드로 확인해보자.
package hello.core.singleton;
public class SingletonService {
// 1. static 영역에 객체를 딱 1개만 생성해둔다.
private static final SingletonService instance = new SingletonService();
// 2. public으로 열어서 객체 인스턴스가 필요하면
// 이 static 메서드를 통해서만 조회하도록 허용한다.
// (instance의 참조를 꺼낼 수 있는 유일한 방법)
public static SingletonService getInstance() {
return instance;
}
// 3. 생성자를 private으로 선언해서 외부에서 객체 생성을 할 수 없게 만든다.
private SingletonService() {}
public void logic() {
System.out.println("싱글톤 객체 로직 호출");
}
}보다시피, static 영역에 객체 인스턴스를 하나 생성해서 올려두고 해당 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있도록 설계했다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다. 딱 1개의 객체 인스턴스만 존재하도록, 생성자를 private으로 막아서 혹시라도 외부에서 객체 인스턴스가 생성되는 것을 막아줬다.
테스트 코드를 만들어서 실제로 확인해보자.
// SingletonTest.java에 코드 추가
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
// 조회: 호출할 때마다 같은 객체를 반환하는가?
SingletonService singletonService1 = SingletonService.getInstance();
SingletonService singletonService2 = SingletonService.getInstance();
// 참조값이 같은지 확인
System.out.println("singletonService1 = " + singletonService1);
System.out.println("singletonService2 = " + singletonService2);
// singletonService1 == singletonService2
assertThat(singletonService1).isSameAs(singletonService2);
singletonService1.logic();
}
보다시피, 호출할 때마다 같은 객체 인스턴스를 반환하는 것을 볼 수 있다. 그럼 이제 AppConfig를 싱글톤 패턴으로 바꾼 다음, getInstance() 메서드를 써서 다 반환하도록 하면 되나? 그런데 그렇게 할 필요가 없다. 왜냐? 스프링 컨테이너를 쓰면 기본적으로 객체를 다 싱글톤으로 만들어서 관리해주기 때문이다...
이제 고객 요청이 1000개가 와서 초당 1000개의 요청 처리해야 하는 상황에서도 객체를 그냥 재활용하면 된다.
하지만, 싱글톤 패턴은 아래와 같은 수많은 문제점을 가지고 있다.
-
싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
-
의존관계상 클라이언트가 구체 클래스에 의존한다. (OCP, DIP 위반)
-
테스트하기 어렵다.
-
내부 속성을 변경하거나 초기화 하기 어렵다.
-
private생성자로 자식 클래스를 만들기 어렵다. -
안티패턴으로 불리기도 한다.
이렇게 많은 문제점들이 있지만, 스프링은 이 싱글톤 패턴의 문제점들을 전부 해결하고 객체를 싱글톤으로 관리해준다.
🤪 싱글톤 컨테이너
스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다. 지금까지 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다. 이전에 설명한 컨테이너 생성 과정을 잘 생각해보면, 컨테이너는 객체를 하나만 생성해서 관리한다.
보다시피, 컨테이너가 만들어지고 @Bean이 붙어 있는 부분들을 전부 호출해서 빈 객체로 미리 등록하고 관리한다. 만약에 조회하면, 관리되고 있는 저 빈(객체)을 조회해주는 것이다.
이렇게 싱글톤 객체를 생성하고 관리하는 기능을 "Singleton Registry" 라고 한다. 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다. 지저분한 코드가 들어가지 않아도 되고, DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있는 것이다.
테스트 코드를 살펴보자.
// SingletonTest.java에 코드 추가
@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
ApplicationContext 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);
}
보다시피 조회할 때마다 memberService1, memberService2 모두 스프링이 처음 컨테이너에서 등록한 빈을 계속 반환해주고 있다. 진짜네...
이제 싱글톤 컨테이너의 동작 과정을 그림을 통해 복습해보자.
클라이언트 A, B, C가 올 때마다 동일한 memberService를 반환해준다. 스프링 컨테이너 덕분에 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있는 것이다. 근데 이렇게 객체 하나를 여러 명이 사용하면 그 객체는 더러워지는거 아닌가…?
이처럼 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때마다 새로운 객체를 생성해서 반환하는 기능도 제공한다.
⚠️ 싱글톤 방식의 주의점 (중요)
싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에...
“싱글톤 객체는 상태를 유지하게 설계하면 안 된다!”
최대한 무상태로 설계해야 한다는 말이다. 특정 클라이언트에 의존적인 필드가 있으면 안 된다. 그래서 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 되고, 가급적 읽기만 가능해야 한다. 그래서 일반적인 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다. 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다. 실무에서 상당히 자주 발생하는 예시를 살펴보자.
<StatefulService.java>
// StatefulService.java
package hello.core.singleton;
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;
}
}
<StatefulServiceTest.java>
// StatefulServiceTest.java
package hello.core.singleton;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import static org.junit.jupiter.api.Assertions.*;
class StatefulServiceTest {
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = ac.getBean(StatefulService.class);
StatefulService statefulService2 = ac.getBean(StatefulService.class);
System.out.println("statefulService1 = " + statefulService1);
System.out.println("statefulService2 = " + statefulService2);
// Thread A : 사용자 A가 10000원 주문
statefulService1.order("userA", 10000);
// Thread B : 사용자 A가 20000원 주문
statefulService2.order("userB", 20000);
// Thread A : 사용자 A가 주문 금액 조회
int price = statefulService1.getPrice();
System.out.println("price = " + price);
Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}사용자 A가 주문하고 금액을 조회하는 사이에 사용자 B가 중간에 끼어 들어와서 주문을 해버린 상황이다. 이때 사용자 A가 주문 금액을 조회하면 얼마가 나올까? 당연히 2만원이 나온다. StatefulService의 price 필드는 싱글톤이라서 공유되는데, 그 공유되는 필드를 특정 클라이언트가 변경해 버려서 문제가 발생한 것이다.
이처럼 공유 필드는 정말 조심해야 한다. 다시 한번 강조하지만 스프링 빈은 항상 무상태(Stateless)로 설계해야 한다. 아래 수정된 코드를 보자.
// StatefulService.java
package hello.core.singleton;
public class StatefulService {
private int price;
public int order(String name, int price) {
System.out.println("name = " + name + " price = " + price);
// this.price = price; // 여기가 문제!
return price; // 이렇게 수정한다.
}
}// StatefulServiceTest.java
package hello.core.singleton;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import static org.junit.jupiter.api.Assertions.*;
class StatefulServiceTest {
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = ac.getBean(StatefulService.class);
StatefulService statefulService2 = ac.getBean(StatefulService.class);
System.out.println("statefulService1 = " + statefulService1);
System.out.println("statefulService2 = " + statefulService2);
// Thread A : 사용자 A가 10000원 주문
int userAPrice = statefulService1.order("userA", 10000);
// Thread B : 사용자 A가 20000원 주문
int userBPrice = statefulService2.order("userB", 20000);
// Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}↔️ @Configuration과 싱글톤
이번에는 @Configuration의 비밀에 대해 알아보자. @Configuration은 사실 싱글톤을 위해 존재한다. AppConfig를 보면서 얘기해보자.
// AppConfig.java
@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();
}
...
}
AppConfig를 보면 이상한 점이 있다. 만약 스프링이 memberService를 호출하면, MemoryMemberRepository()를 주입받은 MemberServiceImpl이 생성되는 것이다. orderService 빈도 똑같이 OrderServiceImpl을 생성하는데 여기 memberRepository가 또 호출되어 MemoryMemberRepository 인스턴스가 또 생성될 것이다.
지금 MemoryMemberRepository가 2번 호출됐기 때문에 싱글톤이 깨진 거 아닌가? 객체 인스턴스가 무조건 1개만 생성되어야 하는데?
// ConfigurationSingletonTest.java
package hello.core.singleton;
import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class ConfigurationSingletonTest {
@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);
MemberRepository memberRepository1 = memberService.getMemberRepository();
MemberRepository memberRepository2 = orderService.getMemberRepository();
// 3개는 똑같다
System.out.println("memberService -> memberRepository = " + memberRepository1);
System.out.println("orderService -> memberRepository = " + memberRepository2);
System.out.println("memberRepository = " + memberRepository);
Assertions.assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
Assertions.assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
}
}확인해보면 memberRepository 인스턴스는 공유되어 사용되는 것을 볼 수 있다. 근데 AppConfig의 자바 코드를 보면 분명히 2번 new MemoryMemberRepository()를 호출해서 다른 인스턴스가 생성되어야 할 것 같았다.
호출 로그를 통해 확인해보자.
// AppConfig.java
package hello.core;
import hello.core.discount.DiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class AppConfig {
// MemberService 역할
@Bean
public MemberService memberService() {
System.out.println("call AppConfig.memberService");
return new MemberServiceImpl(memberRepository());
}
// MemberRepository 역할
@Bean
public MemberRepository memberRepository() {
System.out.println("call AppConfig.memberRepository");
return new MemoryMemberRepository();
}
// OrderService 역할
@Bean
public OrderService orderService() {
System.out.println("call AppConfig.orderService");
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
// DiscountPolicy 역할
@Bean
public DiscountPolicy discountPolicy() {
return new RateDiscountPolicy();
}
}스프링 컨테이너가 각각 스프링 빈을 생성한다. 그럼 위 코드에서는 memberRepository()는 3번 호출되는 것 아닌가?
- 스프링 컨테이너가 스프링 빈에 등록하기 위해
@Bean이 붙어 있는memberRepository()호출 memberService()로직에서memberRepository()호출orderService()로직에서memberRepository()호출
근데 보다시피, 모두 1번만 호출되는 것을 볼 수 있다. 무슨 영문인지는 잘 모르겠지만, 스프링이 정말 무슨 수를 써서라도 싱글톤을 보장해주고 있다는 안도감이 든다.
🪄 @Configuration과 바이트코드 조작의 마법
자바 코드만 본다면 분명히 3번 호출되어야 맞아 보이는데...
이런 이상한 현상의 이유는, @Configuration을 적용한 AppConfig에 실마리가 숨겨져 있다. AppConfig에 테스트 하나를 추가해보자.
// AppConfig.java
@Test
void configurationDeep() {
ApplicationContext ac = new
AnnotationConfigApplicationContext(AppConfig.class);
// AppConfig도 스프링 빈으로 등록된다.
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("bean = " + bean.getClass());
// 출력: bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70
}클래스 정보에 이상한 게 붙는다... 순수한 클래스라면 class hello.core.AppConfig와 같이 출력되어야 한다. 그런데 예상과는 다르게 클래스 명에 xxxCGLIB가 붙으면서 상당히 복잡해진 것을 볼 수 있다.
스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다. 하, 이건 또 뭔 소리냐, 아래 그림을 보자.
AppConfig가 AppConfig@CGLIB가 AppConfig를 상속받아서 다른 클래스를 하나 만들었다는 거다. 그리고 스프링이 조작한 AppConfig@CGLIB 클래스를 스프링 빈으로 등록해버리는 거다. 그래서 스프링 컨테이너에는 분명히 이름은 AppConfig인데, 인스턴스 객체가 AppConfig@CGLIB인 녀석이 들어가 있는 것이다.
이 임의의 다른 클래스가 바로 싱글톤을 보장해주는 것이다. 아마도 아래와 같이 바이트 코드를 조작해서 작성되어 있을 것이다. (실제로는 CGLIB의 내부 기술을 사용하는데 매우 복잡하다.)
<AppConfig@CGLIB 예상 코드>
@Bean
public MemberRepository memberRepository() {
if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
return 스프링 컨테이너에서 찾아서 반환;
} else { //스프링 컨테이너에 없으면
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
return 반환
}
}@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다. 이 덕분에 싱글톤이 보장되는 것이다.
@Configuration을 붙이면 바이트 코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약 @Bean만 적용하면 어떻게 될까? @Configuration을 삭제하고 실행해보자.
출력 결과는 class.hello.core.AppConfig, 즉 내가 만들었던 그 순수한 AppConfig가 호출되는 것을 볼 수 있다. 그리고 이제서야 memberRepository()가 총 3번 호출되는 것을 볼 수 있다. 싱글톤이 깨진 것이다.
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
call AppConfig.memberRepository한 번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서, 두 번은 각각 memberRepository()를 호출하면서 발생한 코드다.
이제 configurationTest를 돌려보자.
memberService -> memberRepository = hello.core.member.MemoryMemberRepository@6239aba6
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@3e6104fc
memberRepository = hello.core.member.MemoryMemberRepository@12359a82당연히 각각의 인스턴스 참조값도 다르다. 스프링 설정 정보에 항상 @Configuration 애노테이션을 붙여서 싱글톤을 보장하도록 하자.
