[작성일: 2023. 08. 06]
웹 애플리케이션과 싱글톤
public class SingletonTest {
@Test
@DisplayName("스프링 없는 순수한 DI 컨테이너")
void pureContainer() {
AppConfig appConfig = new AppConfig();
// 1. 조회 : 호출을 할 때마다 객체를 생성
MemberService memberService1 = appConfig.memberService();
MemberService memberService2 = appConfig.memberService();
// 참조값이 다른 것을 확인
System.out.println("memberService1 = " + memberService1);
System.out.println("memberService2 = " + memberService2);
// memberService1 != memberService2
Assertions.assertThat(memberService1).isNotSameAs(memberService2);
}
}
스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다. 테스트를 통해 참조 값이 다른 것을 확인할 수 있으며 해당 방식은 메모리 낭비가 심하다. 해결 방법은 해당 객체가 딱 1개만 생성되고 공유하도록 싱글톤 패턴을 사용해서 설계하면 된다.
싱글톤 패턴
싱글톤 패턴은 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다. 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("싱글톤 객체 로직 호출");
}
}
public class SingletonTest {
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
SingletonService instance1 = SingletonService.getInstance();
SingletonService instance2 = SingletonService.getInstance();
System.out.println("instance1 = " + instance1);
System.out.println("instance2 = " + instance2);
assertThat(instance1).isSameAs(instance2);
// isSameAs : ==
// isEqualTo : equals
}
}
싱글톤 패턴의 문제점
- 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
- 의존관계상 클라이언트가 구체 클래스에 의존하게 되어 DIP를 위반한다.
- 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
- 내부 속성을 변경하거나 초기화 하기 어렵다.
- private 생성자로 자식 클래스를 만들기 어렵다.
- 유연성이 떨어지며 테스트하기가 어렵다.
싱글톤 컨테이너
스프링 컨테이너는 싱글톤 패턴의 문제를 해결하면서 객체 인스턴스를 싱글톤으로 관리해 준다.
스프링 컨테이너는 싱글톤 컨테이너 역할을 하며 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다.
!! 스프링 컨테이너는 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 되며 DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.
public class SingletonTest {
@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);
// memberService1 == memberService2
assertThat(memberService1).isSameAs(memberService2);
}
}
싱글톤 방식 주의점
싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안 되므로 무상태(stateless)로 설계해야 한다.
- 특정 클라이언트에 의존적인 필드가 있으면 안 된다.
- 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다.
- (가급적이면) 읽기만 가능해야 한다.
- 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal등을 사용해야 한다.
스프링 빈의 필드에 공유 값을 설정하면 큰 장애가 발생할 수 있으니 조심하자.
상태를 유지할 경우 발생하는 문제점
public class StatefulService {
private int price; // 상태를 유지하는 필드 10000 -> 20000
public void order(String name, int price) {
System.out.println("name = " + name + " price = " + price);
this.price = price; // 이 부분이 문제!
}
public int getPrice() {
return price;
}
}
class StatefulServiceTest {
@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);
assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}
StatefulService의 price 필드는 공유되는 필드이며 특정 클라이언트가 값을 변경한다. 사용자 A의 주문 금액은 10000원이 되어야 하는데 20000원의라는 결과가 나온다.
실무에서 이런 경우가 종종 발생하며, 정말 해결하기 어려운 큰 문제들이 터지므로 스프링 빈은 항상 무상태(stateless)로 설계해야 한다.
public class StatefulService {
// private int price; // 상태를 유지하는 필드 10000 -> 20000
public int order(String name, int price) {
System.out.println("name = " + name + " price = " + price);
// this.price = price;
return price;
}
// public int getPrice() {
// return price;
// }
}
class StatefulServiceTest {
@Test
void statefulServiceSingleton() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = ac.getBean(StatefulService.class);
StatefulService statefulService2 = ac.getBean(StatefulService.class);
// ThreadA : A 사용자가 10000원 주문
int userAPrice = statefulService1.order("userA", 10000);
// ThreadB : B 사용자가 20000원 주문
int userBPrice = statefulService2.order("userB", 20000);
// ThreadA : 사용자 A가 주문 금액을 조회하면...?
// int price = statefulService1.getPrice();
System.out.println("price = " + userAPrice);
// assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
위의 코드처럼 지역변수를 사용하도록 수정하면 제대로 된 금액이 호출된다.
@Configuration과 싱글톤
이전에 작성한 AppConfig를 보면 memberService와 orderService 둘 다 new MemoryMemberRepository를 호출한다. 결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보이는데, 스프링 컨테이너는 이 문제를 어떻게 해결할까?
우선 memberServiceImpl, orderServiceImpl에 테스트용 getter를 생성해준다.
public class ConfigurationSingletonTest {
@Test
void configurationTest() {
AnnotationConfigApplicationContext 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();
System.out.println("memberService -> memberRepository1 = " + memberRepository1);
System.out.println("orderService -> memberRepository2 = " + memberRepository2);
System.out.println("memberRepository = " + memberRepository);
assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
}
}
테스트 결과를 보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
@Configuration과 바이트코드 조작
스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.
@Test
void configurationDeep() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("bean = " + bean.getClass());
}
AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록 되기 때문에 AppConfig도 스프링 빈이 된다. 순수한 클래스라면 class hello.core.AppConfig가 출력되어야 하는데 예상과는 다르게 xxxCGLIB가 붙었다.
내가 만든 클래스가 아닌 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해 AppConfig 클래스를 상속받은 임의의 다른 클래스로 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다. 임의로 만들어진 클래스가 싱글톤이 보장되도록 해준다.
@Bean이 붙은 메서드마다 스프링 빈이 이미 존재한다면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다. 그 덕분에 싱글톤이 보장될 수 있다.
!! AppConfig@CGLIB는 AppConfig의 자식 타입이므로 AppConfig 타입으로 조회가 가능하다.
!! @Configuration 없이 @Bean만 사용해도 스프링 빈으로 등록은 되지만, 싱글톤을 보장하지 않는다.
🐣 출처: 인프런 김영한님 강의
이 글은 인프런의 김영한님 스프링 강의를 보고 작성한 글입니다.
강의를 들으면서 정리한 글이므로 틀린 내용이나 오타가 있을 수 있습니다.