인프런 김영한님의 강의 '스프링 핵심 원리 - 기본편'의 강의 내용을 참고하여 작성한 글입니다.
웹 어플리케이션과 싱글톤
- spring은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
- 대부분의 spring 어플리케이션은 웹 어플리케이션이다. 물론 웹이 아닌 어플리케이션 개발도 얼마든지 개발할 수 있다.
- 웹 어플리케이션은 보통 여러 고객이 동시에 요청을 한다.
스프링 없는 순수한 DI 컨테이너 테스트
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);
Assertions.assertThat(memberService1).isNotSameAs(memberService2);
}
}- 우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다 객체를 새로 생성한다.
- 고객 트래픽이 초당 100이 나오면 초당 100개의 객체가 생성되고 소멸된다! -> 메모리 낭비가 심하다.
- 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. -> 싱글톤 패턴
싱글톤 패턴
- 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
- 그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
- private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.
싱글톤 패턴을 적용한 예제 코드를 보자. main이 아닌 test 위치에 생성
package hello.core.singleton;
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 키워드로 객체 인스턴스가 생성되는 것을 막는다.
싱글톤 패턴을 사용하는 테스트 코드를 보자.(위에서 작성한 SingletonTest.java에 작성)
@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);
// singletonService1 == singletonService2
Assertions.assertThat(singletonService1).isSameAs(singletonService2);
singletonService1.logic();
}- private으로 new 키워드를 막아두었다.
- 호출할 때마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.
참고: 싱글톤 패턴을 구현하는 방법은 여러가지가 있다. 여기서는 객체를 미리 생성해두는 가장 단순하고 안전한 방법을 선택했다.
싱글톤 패턴 문제점
싱글톤 패턴을 적용하면 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있따. 하지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있다.
- 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
- 의존관계상 클라이언트가 구체 클래스에 의존한다. -> DIP를 위반한다.
- 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
- 테스트하기 어렵다.
- 내부 속성을 변경하거나 초기화 하기 어렵다.
- private 생성자로 자식 클래스를 만들기 어렵다.
- 결론적으로 유연성이 떨어진다.
- 안티패턴으로 불리기도 한다.
- 안티패턴이란 개발단계에서 자주 사용하는 패턴이지만 실제로는 비효율적이거나 비생산적인 패턴을 의미한다.
싱글톤 컨테이너
스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤으로 관리한다.
지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.
싱글톤 컨테이너
- 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
- 이전에 설명한 컨테이너 생성 과정을 다시 생각해보면 컨테이너는 객체를 하나만 생성해서 관리한다.
- 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
- 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.
- 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
- 생성자를 private으로 선언한다거나
getInstance()같은 메서드들을 만들 필요가 없다.
- 생성자를 private으로 선언한다거나
- DIP, OCP, private 생성자, test로 부터 자유롭게 싱글톤을 사용할 수 있다.
- 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
스프링 컨테이너를 사용하는 테스트 코드(SingletonTest.java에 작성)
@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
// 1. 조회: 호출할 때마다 같은 객체를 반환
MemberService memberService1 = ac.getBean("memberService", MemberService.class);
// 2. 조회: 호출할 때마다 같은 객체를 반환
MemberService memberService2 = ac.getBean("memberService", MemberService.class);
// 참조값이 같은 것을 확인
System.out.println("memberService1 = " + memberService1);
System.out.println("memberService2 = " + memberService2);
Assertions.assertThat(memberService1).isSameAs(memberService2);
}싱글톤 컨테이너 적용 후
- 스프링 컨테이너 덕분에 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용 할 수 있다.
참고: 스프링의 기본 빈 등록 방식은 싱글톤이지만, 당연하게도 싱글톤 방식만 가능한 것은 아니다. 필요에 따라서 요청할 때마다 새로운 객체를 생성하고자 한다면 얼마든지 구현할 수 있다. 자세한 내용은 추후에 빈 스코프 포스트에서 설명하겠다.
싱글톤 방식의 주의점
- 싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태유지(stateful) 방식으로 설계하면 안된다!
- 무상태(stateless)방식으로 설계해야한다.
- 특정 클라이언트에 의존적인 필드가 있으면 안된다.
- 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
- 따라서 가급적 읽기만 가능하도록 설계해야한다.
- 필드 대신 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
- 스프링 빈의 필드에 공유 값을 설정하면 예상치 못한(오류를 잡기 힘든) 장애가 발생할 수 있다.
상태를 유지할 경우 발생하는 문제점 예시 - Stateful한 서비스 설계
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;
}
}
상태를 유지할 경우 발생하는 문제점 예시 - 테스트 코드
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;
public class StatefulServiceTest {
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);
// ThreadA: A사용자 10000원 주문
statefulService1.order("userA", 10000);
// ThreadB: B사용자 20000원 주문
statefulService2.order("userB", 20000);
// ThreadA: userA 주문 금액 조회
int price = statefulService1.getPrice();
// ThreadA: userA는 10000원을 기대했지만 기대와는 다르게 20000원이 출력
System.out.println("price = " + price);
Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}- statful 상황에 집중하기 위해 실제 쓰레드는 사용하지 않았다.
- ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다.
StatefulService의price필드는 공유되는 필드인데, 특정 클라이언트(A 또는 B)가 값을 변경한다. -> 여기서 문제가 발생!!- 사용자A의 주문금액은 10000원인데 20000원이라는 결과가 나왔다.
- 이런 문제점 때문에 공유필드는 정말 조심해야한다. -> 스프링 빈은 항상 무상태(stateless)로 설계하자!!!
@Configuration과 싱글톤
그런데,, 이상한 점이 있다. 다음 AppConfig 코드를 보자
package hello.core;
import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
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 {
@Bean
public MemberService memberService() {
return new MemberServiceImpl(memberRepository());
}
@Bean
public OrderService orderService() {
return new OrderServiceImpl(
memberRepository(),
discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
return new MemoryMemberRepository();
}
@Bean
public DiscountPolicy discountPolicy() {
// return new FixDiscountPolicy();
return new RateDiscountPolicy();
}
}- memberService 빈을 만드는 코드를 보면
memberRepository()를 호출한다.- 이 메서드를 호출하면
new MemoryMemberRepository()를 호출한다.
- 이 메서드를 호출하면
- orderService 빈을 만드는 코드도 동일하게
memberRepository()를 호출한다.- 이때도
new MemoryMemberRepository()를 호출한다.
- 이때도
결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보인다. 스프링 컨테이너는 이 문제를 어떻게 해결하는지 직접 테스트 코드로 알아보자
검증용 테스트 코드 (MemberServiceImpl과 OrderServiceImpl에 조회 기능 추가)
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;
}
}테스트 코드
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);
// 모두 같은 인스턴스를 참조하는 것을 알 수 있다.
System.out.println("memberService -> memberRepository = " + memberService.getMemberRepository());
System.out.println("orderService -> memberRepository = " + orderService.getMemberRepository());
System.out.println("memberRepository -> memberRepository = " + memberRepository);
Assertions.assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
Assertions.assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
}
}- 위의 코드에서 확인했듯이 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
- AppConfig의 자바 코드를 보면 분명히 각각 2번
new MemoryMemberRepository를 호출해서 다른 인스턴스가 생성되어야 하는데,,,? 혹시 두 번 호출이 안되는 것인지 테스트를 통해 알아보자.
AppConfig에 호출 로그 남김
package hello.core;
import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
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 {
@Bean
public MemberService memberService() {
System.out.println("call AppConfig.memberService");
return new MemberServiceImpl(memberRepository());
}
@Bean
public OrderService orderService() {
System.out.println("call AppConfig.orderSerivce");
return new OrderServiceImpl(
memberRepository(),
discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
System.out.println("call AppConfig.memberRepository");
return new MemoryMemberRepository();
}
@Bean
public DiscountPolicy discountPolicy() {
// return new FixDiscountPolicy();
return new RateDiscountPolicy();
}
}- 호출 로그를 남겨서 memberService, orderService, memoryRepository가 각각 몇 번 호출되는지 알아보았다.
- 예상 시나리오
- 스프링 컨테이너가 각각
@Bean을 호출해서 스프링 빈을 생성한다. 그래서memoryRepository()는 다음과 같은 로직으로 총 3번 호출될 것이라고 예상된다.
1. 스프링 컨테이너가 스프링 빈에 등록하기 위해@Bean이 붙어있는memberRepository()호출
- memberService() 로직에서
memberRepository()호출 - orderService() 로직에서
memberRepository()호출
- 스프링 컨테이너가 각각
그런데 출력결과는 각각 1번만 호출된다.
@Configuration과 바이트코드 조작의 마법
스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그런데 스프링이 자바 코드까지 자신의 방식대로 동작하도록 할 수는 없다. 자바 언어의 규칙대로라면 분명히 3번 호출되어야 하는 것이 지당하다. 그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.
모든 비밀은 @Configuration을 적용한 AppConfig에 있다!!
다음 코드를 보자
@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$$721f06a6
}- 사실
AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래서AppConfig도 스프링 빈이 된다. AppConfig스프링 빈을 조회해서 클래스 정보를 출력해보자.- 만약 순수한 클래스라면 다음과 같이 출력되어야 한다.
class.hello.core.AppConfig
그런데 예상과는 다르게 클래스 명에 'EnhancerBySpringCGLIB'가 붙으면서 상당히 복잡해진 것을 볼 수 있다. 이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다!!
그림
이 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다. 아마도 다음과 같이 바이트 코드를 조작해서 작성되어있을 것이다.(실제로는 CGLIB의 내부 기술은 매우 복잡하다...)
AppConfig@CGLIB 예상 코드
@Bean
public MemberRepository memberRepository () {
if(memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면) {
return 스프링 컨테이너에서 찾은 memoryMemberRepository;
}
else {
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
return 방금 만든 MemoryMemberRepository;
}
}- @Bean이 붙은 메서드마다 이미 컨테이너에 등록되어 있다면 등록된 객체를 반환하고 아니면 기존 로직을 활용해서 새로 만든 뒤 반환하는 형식으로 코드가 작성되어 있을 것이다.
- 덕분에 싱글톤이 보장되는 것이다.
참고: AppConfig@CGLIB는 AppConfig의 자식 타입이므로, AppConfig타입으로 조회가 가능하다.
@Configuration을 적용하지 않고, @Bean만 적용하면 어떻게 될까?
@Configuration을 붙이면 바이트코드를 조작하는 CGLIB기술을 사용해서 싱글톤을 보장하지만, 만약 @Bean만 적용하면 어떻게 될까?
- 기존 AppConfig.java에서
@Configuration어노테이션만 제거 후 실행해보자.
결과
- 앞서 AppConfig의 클래스 정보에 CGLIB가 출력되었지만 지금은 그냥 AppConfig만 출력된다. 따라서 CGLIB 기술이 적용되지 않은 순수한 AppConfig가 스프링 빈으로 등록되었음을 알 수 있다.
- memberServiceImpl와 orderServiceImpl의 memberRepository, memberRepository의 참조값이 전부 다르다. 따라서 당연히 참조값이 같다고 작성한 test코드도 실패한다.
- 또한 memberService와 orderService가 호출될 때마다
memberRepository()로그에 찍히는 것을 볼 수 있다. (중요)확인이 끝났으면 AppConfig.java에 다시@Configuration어노테이션을 달아놓자.
정리
@Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다.- 크게 고민할 것이 없다. 스프링의 강력한
@Configuration어노테이션을 항상 사용하자.
사우루스 팡팡!