Backend/Spring
[Spring] 스프링 핵심 원리_싱글톤 컨테이너
초보개발자..
2022. 2. 22. 15:36
웹 애플리케이션 싱글톤
- 스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
- 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 물론 웹이 아닌 애플리케이션 개발도 얼마든지 개발할 수 있다.
- 웹 애플리케이션은 보통 여러 고객이 동시에 요청한다.
고객이 요청할 때마다 새롭게 생성해서 객체를 반환합니다.
스프링이 없는 순수한 DI컨테이너 테스트
package hello.core.singleton;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import hello.core.AppConfig;
import hello.core.member.MemberService;
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 = hello.core.member.MemberServiceImpl@6c80d78a
//memberService2 = hello.core.member.MemberServiceImpl@62150f9e
Assertions.assertThat(memberService1).isNotSameAs(memberService2);
}
}- 우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청할 때마다 객체를 새로 생성한다.
- 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! -> 메모리 낭비가 심하다
- 해결 방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다!.-> 싱글톤 패턴
- 고객이 요청 올 때마다 객체를 생성하면 큰 서비스를 하는 회사인 경우 고객의 요청이 초당 5만 회가 들어오는 경우가 있는데 너무 메모리 낭비가 심합니다.!
싱글톤 패턴
- 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
- 그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 합니다.
- private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 합니다.
싱글톤 패턴을 적용한 예제 코드
package hello.core.singleton;
import org.springframework.boot.SpringApplication;
public class SingletonService {
//1. static 영역에 객체를 딱 1개만 생성해둔다
private static final SingletonService instance =new SingletonService();
//2. public 으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 허용한다.
public static SingletonService getInstance() {
return instance;
}
//3.프라이빗 생성자를 사용하여 생성을 막아주는 역할을 합니다.
private SingletonService() {
}
public void logic() {
System.out.println("싱글톤 객체 로직 호출");
}
}1.static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
2. 이 객체 인스턴스가 필요하면 오직 getInstance()메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아서 혹시라도 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막아줘야 합니다.
싱글톤 패턴을 사용하는 테스트코드
package hello.core.singleton;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import hello.core.AppConfig;
import hello.core.member.MemberService;
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 = hello.core.member.MemberServiceImpl@6c80d78a
//memberService2 = hello.core.member.MemberServiceImpl@62150f9e
Assertions.assertThat(memberService1).isNotSameAs(memberService2);
}
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
//private으로 생성자를 막아 두었다. 컴파일 오류발생
//new SingtonService();
SingletonService singletonService1= SingletonService.getInstance();
SingletonService singletonService2=SingletonService.getInstance();
System.out.println("singletonService1 = " + singletonService1);
System.out.println("singletonService2 = " + singletonService2);
//결과값 같은 객체 인스턴스가 반환되는 것을 볼 수 있습니다.
// singletonService1 = hello.core.singleton.SingletonService@1ebd319f
// singletonService2 = hello.core.singleton.SingletonService@1ebd319f
Assertions.assertThat(singletonService1).isSameAs(singletonService2);
}
}private으로 new 키워드를 막아둔 상태.
호출할 때마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.
싱글톤 패턴을 적용하면 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다. 하지만 싱글톤 패턴은 다음과 같은 수많은 문제점들을 가지고 있다.
싱글톤 패턴 문제점
- 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.(위의 싱글톤 코드의 경우 logic만 사용하고 싶어도 instance를 생성하고 getInstance()를 생성하고 많은 코드가 들어갑니다.)
- 의존관계상 클라이언트가 구체 클래스에 의존한다. DIP 위반
- 클라이언트가 구체 클래스에 의존해서 OCP원칙을 위반할 가능성이 높다.
- 테스트하기 어렵다(유연하게 테스트하기 어렵다)
- 내부 속성을 변경하거나 초기화하기 어렵다
- private 생성자로 자식 클래스를 만들기 어렵다
- 결론적으로 유연성이 떨어진다
- 안티 패턴으로 불리기도 한다.
싱글톤 컨테이너
스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다.
싱글톤 컨테이너
- 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
- 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
- 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.
- 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
- DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.
스프링 컨테이너를 사용하는 테스트 코드
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 hello.core.AppConfig;
import hello.core.member.MemberService;
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 = hello.core.member.MemberServiceImpl@6c80d78a
//memberService2 = hello.core.member.MemberServiceImpl@62150f9e
Assertions.assertThat(memberService1).isNotSameAs(memberService2);
}
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
//private으로 생성자를 막아 두었다. 컴파일 오류발생
//new SingtonService();
SingletonService singletonService1= SingletonService.getInstance();
SingletonService singletonService2=SingletonService.getInstance();
System.out.println("singletonService1 = " + singletonService1);
System.out.println("singletonService2 = " + singletonService2);
//결과값 같은 객체 인스턴스가 반환되는 것을 볼 수 있습니다.
// singletonService1 = hello.core.singleton.SingletonService@1ebd319f
// singletonService2 = hello.core.singleton.SingletonService@1ebd319f
Assertions.assertThat(singletonService1).isSameAs(singletonService2);
}
@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
// AppConfig appConfig=new AppConfig();
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);
//결과값
//memberService1 = hello.core.member.MemberServiceImpl@7096b474
//memberService2 = hello.core.member.MemberServiceImpl@7096b474
Assertions.assertThat(memberService1).isSameAs(memberService2);
}
}싱글톤 컨테이너 적용 후
스프링 컨테이너 덕분에 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다.
싱글톤 방식의 주의점
- 싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지하게 설계하면 안 된다.
- 무상태로 설계해야 한다.
- 특정 클라이언트에 의존적인 필드가 있으면 안 된다.
- 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다!
- 가급적 읽기만 가능해야 한다.
- 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, 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.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("userA", 20000);
//ThreadA 사용자 a주문 금액 조회
int price = statefulService1.getPrice();
System.out.println("price = " +price);
//가격은 2만원이 나옴 같은 객체를 사용하기 때문에..
Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig{
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}- ThreadA가 사용자 A 코드를 호출하고 ThreadB가 사용자 B 코드를 호출한다고 가정.
- StatefulService의 price 필드는 공유되는 필드인데 특정 클라이언트가 값을 변경
- 사용자 A의 주문금액은 10000원이 되어야 하는데 , 사용자 B가 변경하여 20000원이라는 결과가 나왔다.
- 공유 필드는 조심해야 한다. 스프링 빈은 항상 무상태로 설계!!
@Configuration과 싱글톤
Appconfig 코드
package hello.core;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;
@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();
}
@Bean
public OrderService orderService() {
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public DiscountPolicy discountPolicy() {
// return new FixDiscountPolicy();
return new RateDiscountPolicy();
}
}- memberService 빈을 만드는 코드를 보면 memberRepository()를 호출한다.
- 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.
- orderService 빈을 만드는 코드도 동일하게 memberRepository를 호출한다.
- 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.
결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보인다.
스프링 컨테이너는 어떻게 이 문제를 해결할까?
직접 테스트..!
검증 용도의 코드 추가
package hello.core.member;
public class MemberServiceImpl implements MemberService{
private final MemberRepository memberRepository;
//테스트용도
public MemberRepository getMemberRepository() {
return memberRepository;
}
}
package hello.core.order;
import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.Member;
import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
public class OrderServiceImpl implements OrderService{
private DiscountPolicy discountPolicy;
private MemberRepository memberRepository;
//테스트용도
public MemberRepository getMemberRepository() {
return memberRepository;
}
}마지막 테스트 용도인 MemberRepository를 조회할 수 있는 기능을 추가.
테스트 코드
package hello.core.singleton;
import static org.assertj.core.api.Assertions.assertThat;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
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();
System.out.println("memberService-> memberRepository = "+memberRepository1);
System.out.println("orderService-> memberRepository = "+memberRepository2);
System.out.println("memberRepository = "+memberRepository);
//결과값
// memberService-> memberRepository = hello.core.member.MemoryMemberRepository@c4ed84
// orderService-> memberRepository = hello.core.member.MemoryMemberRepository@c4ed84
// memberRepository = hello.core.member.MemoryMemberRepository@c4ed84
assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
}
}
확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemeroyRepository 호출해서 다른 인스턴스가 생성되어야 하는데?
@Configuration과 바이트코드 조작의 마법
스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다.
스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.
모든 비밀은 @Configuration을 적용한 Appconfig에 있다.
테스트 코드
package hello.core.singleton;
import static org.assertj.core.api.Assertions.assertThat;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
public class ConfigurationSingletonTest {
@Test
void configurationDeep() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("Bean = "+bean.getClass());
//결과값
//Bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$6323e4d0
}
}사실 AnnotationConfigApplicationContext에 파라미터로 넘긴 값을 스프링 빈으로 등록된다. 그래서 AppConfig도 스프링 빈이 된다.
AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보자
결괏값!
Bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$6323e4d0
순수한 클래스라면 다음과 같이 출력되어야 한다.
class hello.core.Appconfig
그런데 예상과는 다르게 클래스 명에 xxxCGLIB가 붙으면서 상당히 복잡해진 것을 볼 수 있다. 이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 빈으로 등록한 것이다.!
그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다. 아마도 다음과 같이 바이트 코드를 조작해서 작성되어 있을 것이다.
- @Bean이 붙은 메소드마다 아마 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다
- 덕분에 싱글톤이 보장되는 것이다.