# 싱글톤 컨테이너
## 웹 애플리케이션과 싱글톤
- 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. (웹이 아닌 애플리케이션 개발도 얼마든지 개발할 수 있다.)
- 보통 웹 애플리케이션은 여러 고객이 동시에 요청을 한다. (고객 요청 시 마다 DI 컨테이너(AppConfig)에서 new 하여 객체를 생성하기 때문에 문제 발생.)
- 스프링 없는 순수 DI 컨테이너
package hello.core.singleton;
import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;
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
assertThat(memberService1).isNotSameAs(memberService2);
}
}
- 이전에 작업한 스프링 없는 순수한 DI 컨테이너(AppConfig)의 경우 요청 시 마다 객체를 생성.
- 이대로 진행하면 고객 트래픽 마다 객체가 생성, 소멸되어 메모리의 낭비가심하다.
- 해결 방법은 싱글톤 패턴. (해당 객체가 1개만 생성되고 공유)
## 싱글톤 패턴
- 싱글톤 패턴 : 클래스의 인스턴스가 1개만 생성되는 것을 보장하는 디자인 패턴.
- private 생성자를 이용 외부에서임의로 new 할 수 없도록 하여, 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
package hello.core.singleton;
public class SingletonService {
// static 영역에 객체를 1개만 생성.
private static final SingletonService instance = new SingletonService();
// public으로 하여 객체 인스턴스가 필요 시 해당 static 메서드로만 조회하도록 함.
public static SingletonService getInstance() {
return instance;
}
// private 생성자 : 외부에서 new 키워드를 사용한 객체 생성 불가하도록 방지.
private SingletonService() {
}
public void logic() {
System.out.println("싱글톤 객체 로직 호출함.");
}
}
1. static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
2. 해당 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 해당 메서드를 호출하면 항상 같은 인스턴스를 반환.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아, 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.
package hello.core.singleton;
import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;
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
assertThat(memberService1).isNotSameAs(memberService2);
}
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용.")
void singtonServiceTest() {
SingletonService singletonService1 = SingletonService.getInstance();
SingletonService singletonService2 = SingletonService.getInstance();
System.out.println("singletonService1 = " + singletonService1);
System.out.println("singletonService2 = " + singletonService2);
// Same : == 비교
// equal : 자바 equals 메서드 비교
assertThat(singletonService1).isSameAs(singletonService2);
}
}
- 싱글톤 패턴 적용 시 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유하여 효율적으로 사용할 수 있다.
- 하지만 싱글톤 패턴 사용의 문제점도 존재한다.
싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
의존관계상 클라이언트가 구체 클래스에 의존한다. (DIP를 위반)
클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
테스트하기 어렵다.
내부 속성을 변경하거나 초기화 하기 어렵다.
private 생성자로 자식 클래스를 만들기 어렵다.
유연성이 떨어진다.
안티패턴으로 불리기도 한다.
## 스프링 컨테이너 (=싱글톤 컨테이너)
- 스프링 컨테이너(=싱글톤 컨테이너)는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다.
- 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
- 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다.
- 싱글톤 레지스트리 : 싱글톤 객체를 생성하고 관리하는 기능.
- 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.
- 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다. (DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다)
package hello.core.singleton;
import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;
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
assertThat(memberService1).isNotSameAs(memberService2);
}
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용.")
void singtonServiceTest() {
SingletonService singletonService1 = SingletonService.getInstance();
SingletonService singletonService2 = SingletonService.getInstance();
System.out.println("singletonService1 = " + singletonService1);
System.out.println("singletonService2 = " + singletonService2);
// Same : == 비교
// equal : 자바 equals 메서드 비교
assertThat(singletonService1).isSameAs(singletonService2);
}
@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);
// memberService1 != memberService2
assertThat(memberService1).isSameAs(memberService2);
}
}
- 스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아닌, 이미 만들어진 객체를 공유하여 효율적으로 재사용 가능.
## 싱글톤 방식 주의점
- 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안되고, 무상태(stateless)로 설계해야 한다.
특정 클라이언트에 의존적인 필드가 있으면 안된다.
특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
가급적 읽기만 가능해야 한다.
필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
- 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다.
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.DisplayName;
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.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);
}
static class testConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}
- 위 코드에서 ThreadA가 사용자A 코드를 호출, ThreadB가 사용자B 코드를 호출한다고 가정.
- StatefulService 의 price 필드는 '공유 필드'인데, 특정 클라이언트가 값을 변경, 사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나옴. 공유필드는 조심해야 한다. (멀티 스레드 문제)
- 스프링 빈은 항상 무상태(stateless)로 설계해야 한다.
- 아래와 같이 코드 변경.
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;
}
/*public int getPrice() {
return price;
}*/
}
package hello.core.singleton;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
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.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);
// Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class testConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}
## @Configuration 과 싱글톤
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 MemberService 호출 -> new MemoryMemberRepository() 호출.
// @Bean OrderService 호출 -> new MemoryMemberRepository() 또 호출.
@Bean
public MemberService memberService() {
return new MemberServiceImpl(memberRepository());
}
@Bean
public MemberRepository memberRepository() {
return new MemoryMemberRepository(); // 추후 DB 변경 시 여기만 바뀌면 됨.
}
@Bean
public OrderService orderService() {
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public DiscountPolicy discountPolicy() {
//return new FixDiscountPolicy(); // 정액 할인_추후 할인 정책 변경 시 여기만 바뀌면 됨.
return new RateDiscountPolicy(); // 정률 할인
}
}
- AppConfig에서 memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다. 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
- orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다. 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
package hello.core.member;
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
public MemberServiceImpl(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
@Override
public void join(Member member) {
memberRepository.save(member);
}
@Override
public Member findMember(Long memberId) {
return memberRepository.findById(memberId);
}
// 테스트 용
public MemberRepository getMemberRepository() {
return memberRepository;
}
}
package hello.core.order;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Member;
import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
@Override
public Order createOrder(Long memberId, String itemName, int itemPrice) {
Member member = memberRepository.findById(memberId);
int discountPrice = discountPolicy.discount(member, itemPrice);
return new Order(memberId, itemName, itemPrice, discountPrice);
}
// 테스트 용
public MemberRepository getMemberRepository() {
return memberRepository;
}
}
package hello.core.singleton;
import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
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;
import static org.assertj.core.api.Assertions.assertThat;
public class ConfigurationSingletonTest {
@Test
void configurationTest() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
// impl에 작성한 테스트 코드 테스트 위해 구체 타입으로 꺼냄. -> 좋은 방식은 아님.
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 -> memberRepository = " + memberRepository1);
System.out.println("orderService -> memberRepository = " + memberRepository2);
System.out.println("memberRepository = " + memberRepository);
assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
}
}
- 위 테스트 코드를 확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
- 아래와 같이 soutm 사용하여 호출 테스트.
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 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(); // 추후 DB 변경 시 여기만 바뀌면 됨.
}
@Bean
public OrderService orderService() {
System.out.println("call AppConfig.orderService");
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public DiscountPolicy discountPolicy() {
//return new FixDiscountPolicy(); // 정액 할인_추후 할인 정책 변경 시 여기만 바뀌면 됨.
return new RateDiscountPolicy(); // 정률 할인
}
}
## @Configuration과 바이트코드 조작의 마법
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 MemberService 호출 -> new MemoryMemberRepository() 호출.
// @Bean OrderService 호출 -> new MemoryMemberRepository() 또 호출.
// 호출 (순서는 보장하지 않음)
// 아래와 같이 호출되어야 할 것 같은데..
// call AppConfig.memberService
// call AppConfig.memberRepository
// call AppConfig.memberRepository
// call AppConfig.orderService
// call AppConfig.memberRepository
// 실상은 아래와 같이 호출.
// call AppConfig.memberService
// call AppConfig.memberRepository
// call AppConfig.orderService
@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(); // 추후 DB 변경 시 여기만 바뀌면 됨.
}
@Bean
public OrderService orderService() {
System.out.println("call AppConfig.orderService");
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public DiscountPolicy discountPolicy() {
//return new FixDiscountPolicy(); // 정액 할인_추후 할인 정책 변경 시 여기만 바뀌면 됨.
return new RateDiscountPolicy(); // 정률 할인
}
}
@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@CGLIB 예상 코드
@Bean
public MemberRepository memberRepository() {
if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
return 스프링 컨테이너에서 찾아서 반환;
} else { //스프링 컨테이너에 없으면
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
return 반환
}
}
- @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들져서 덕분에 싱글톤이 보장되는 것.
@Configuration 을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약 @Bean만 적용하면?
//@Configuration 삭제
public class AppConfig {
}
AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.
AppConfig 출력 결과가아래와 같아짐.
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
call AppConfig.memberRepository
- 그래서 당연히 인스턴스가 같은지 테스트 하는 코드도 실패, 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있다.
- 정리
@Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다.
memberRepository() 처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.
스프링 설정 정보는 항상 @Configuration 사용!!!