본 포스트는 Inflearn 김영한 선생님 강의를 정리한 것 입니다!
스프링 컨테이너는 모든빈을 싱글톤 패턴으로 관리합니다.
이번 포스트에서는 싱글톤 패턴이 무었인지 그리고 왜 빈을 싱글톤으로 관리야하는지 알아보겠습니다.
1. 웹 애플리케이션과 싱글톤
스프링은 기본적으로 웹 애플리케이션을 개발하기위해 만들어진 프레임워크입니다.
웹 애플리케이션은 보통 여러 고객들이 동시에 요청을 합니다.
스프링 없이 순수한 자바 코드로 만들었던 DI 컨테이너를 사용하면 어떤 문제가 있을까요?
AppConfig appConfig = new AppConfig();
/*
public MemberService memberService() {
return new MemberServiceImpl(memberRepository());
}
*/
//1. 조회: 호출할 때 마다 객체를 생성
MemberService memberService1 = appConfig.memberService();
//2. 조회: 호출할 때 마다 객체를 생성
MemberService memberService2 = appConfig.memberService();
AppConfig로 DI 컨테이너를 만들고, 고객의 요청이 올 때마다 MemberService()의 구현체가 새롭게 만들어지게 됩니다.
고객 트래픽이 초당 100이 나오면 초당 100개씩 객체를 만들게 되는 것이지요.
이는 느릴 뿐만 아니라 낭비되는 메모리도 상당하게 됩니다.
이를 해결하기 위해서 MemberService()의 구현체는 딱 하나만 생성되고 그것을 공유하도록 설계해야합니다.
이를 싱글톤 패턴이라고 합니다.
2. 싱글톤 패턴
싱글톤 패턴은 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴입니다.
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으로 객체 인스턴스를 미리하나 만들어 메모리에 올려둡니다.
생성자가 private으로 막혀있으므로, 이 객체 인스턴스가 필요하다면 오직 getInstance()를 통해서만 조회할 수 있습니다.
자 이제 정말 이 객체 인스턴스가 오직 하나만 만들어지는지 확인해 보겠습니다.
@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();
}
실행 결과
singletonService1 = hello.core.singleton.SingletonService@20140db9
singletonService2 = hello.core.singleton.SingletonService@20140db9
싱글톤 객체 로직 호출getInstance()로 받아온 SingletonService의 인스턴스가 같은것을 확인할 수 있습니다.
이처럼 모든 객체들을 싱글톤으로 관리하면 고객 요청이 올때마다 같은 인스턴스를 공유하므로 효율적으로 사용할 수 있습니다.
그러나 싱글톤 패턴은 아래와 같은 문제점을 가지고 있습니다.
- 싱글톤 패턴을 구현하는 코드 자체가 많이
- 의존관계상 클라이언트가 구체 클래스에 의존한다. DIP를 위반한다.
{getInstance()하려면 구체 클래스에 의존해야하므로.} - 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
- 테스트하기 어렵다.
- 내부 속성을 변경하거나 초기화 하기 어렵다.
- private 생성자로 자식 클래스를 만들기 어렵다.
- 결론적으로 유연성이 떨어진다.
(DI를 구현하기 어려움) - 안티패턴으로 불리기도 한다.
3. 싱글톤 컨테이너
스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하고 객체를 싱글톤으로 관리합니다.
덕분에 싱글톤을 위한 지저분한 코드가 필요없고, DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있습니다.
결과적으로 스프링 컨테이너를 사용하면 고객의 요청이 올 때 마다 이미 만들어둔 객체를 공유해 효율적인 프로그램을 만들 수 있습니다.
참고
스프링 빈은 꼭 싱글톤 방식으로만 관리할 수 있는 것은 아닙니다. 뒤에서 다시 설명하겠습니다.
4. 싱글톤 방식의 주의점
싱글톤 객체는 상태를 유지(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;
}
}상태를 유지하는 필드 price를 갖는 Service객체를 하나 만들었습니다.
테스트 케이스를 만들고
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: 사용자A 주문 금액 조회
int price = statefulService1.getPrice();
//ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
System.out.println("price = " + price);
Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}사용자A가 먼저 10000어치 물건을 주문했습니다.
그 이후 사용자A가 주문금액을 조회하면 10000원이 나오는게 정상이 로직입니다.
그러나 웹에서는 수많은 요청이 동시에 들어오고, 각 요청에 배당된 쓰레드는 동시에 일을 처리합니다.
사용자 A가 10000어치 물건을 주문하고, 그 금액을 조회하기 전에 사용자 B가 20000원 어치 물건을 주문한다면, 필드인 price는 10000원에서 20000으로 변경될 것입니다.
이후 사용자 A가 금액을 조회하면 사용자B의 주문금액인 20000원이 출력되는 것입니다.
실무에서 이런 경우가 종종 발생하는데, 이로인해 발생한 에러는 정말 해결하기 어렵다고 합니다.
정말 진짜 공유필드를 만들때는 조심해야합니다.
스프링 빈은 항상 무상태(stateless)로 설계해야합니다.
5. @Configuration과 싱글톤
우리가 계속 써왔던 AppConfig를 자세히 보면 이상한 점이 하나 있습니다.
@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 RateDiscountPolicy();
}
}memberService(), orderService() 두 메소드에서 모두 memberRepository()를 호출하고 있습니다.
memberRepository()는 new MemoryMemberRepository()로 객체를 만드는 메소드이니 결과적으로 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지게 됩니다.
그럼에도 불구하고 스프링 컨테이너는 각 객체를 싱글톤으로 유지하고 있습니다.
어떻게 해결하는걸까요?
여기부터 좀 헷깔릴 수 있습니다잉...
먼저 눈으로 인스턴스를 확인하기 위해 MemberServiceImpl, OrderServiceImpl에 객체를 조회할 수 있는 메소드를 추가해줍니다.
package hello.core.member;
public class MemberServiceImpl implements MemberService{
...
//테스트 용도
public MemberRepository getMemberRepository() {
return memberRepository;
}
...
}public class OrderServiceImpl implements OrderService{
...
//테스트 용도
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.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;
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);
//모두 같은 인스턴스를 참고하고 있다.
assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
}
}먼저 AppConfig코드 대로라면 new MemmoryMemberRepository가 2번 호출되므로 memberService, orderService 안에있는 memberRepository가 서로 다른 인스턴스여야합니다.
그러나 모두 같은 인스턴스임을 확인할 수 있습니다.
실행결과
memberService -> memberRepository = hello.core.member.MemoryMemberRepository@650eab8
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@650eab8
memberRepository = hello.core.member.MemoryMemberRepository@650eab8혹시 그럼 두 번 호출이 안되는 걸까요?
AppConfig에 로그를 찍어 확인해보겠습니다.
@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.orderService");
return new OrderServiceImpl(
memberRepository(),
discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
System.out.println("call AppConfig.memberRepository");
return new MemoryMemberRepository();
}
@Bean
public DiscountPolicy discountPolicy() {
return new RateDiscountPolicy();
}
}스프링 컨터이너가 각 @Bean을 호출해 스프링 빈을 등록합니다. 그러므로 memberRepository()는 총 3회 호출 되는게 정상입니다.
그러나 출력 결과 모든 객체들은 딱 한번씩만 호출되었습니다.
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
memberService -> memberRepository = hello.core.member.MemoryMemberRepository@650eab8
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@650eab8
memberRepository = hello.core.member.MemoryMemberRepository@650eab86. @Configuration과 바이트코드 조작의 마법
AppConfig의 자바코드를 보면 분명 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$$bd479d70
}사실 @Configuration이 붙은 AppConfig또한 스프링 빈으로 등록됩니다.
등록된 AppConfig빈의 클래스 정보를 확인해보면 다음과 같습니다.
bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70순수한 클래스라면 다음처럼 출력돼야합니다.
class hello.core.AppConfig클래스 명에 CGLIB이 붙으며 뭔가 이상해진것을 볼 수 있습니다.
이것은 우리가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것 입니다.
새로 만들어진 그 클래스가 바로 싱글톤을 보장하는 것입니다.
실제로 CGLIB의 내부 기술은 매우 복잡하지만 대충 예상해보면
@Bean
public MemberRepository memberRepository() {
if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
return 스프링 컨테이너에서 찾아서 반환;
} else { //스프링 컨테이너에 없으면
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
return 반환
}
}@Bean이 붙은 메소드마다 이미 스프링 빈이 등록되어있다면 그녀석을 반환하고, 그렇지 않다면 생성해서 빈으로 등록한 뒤 반환하는 코드일것입니다.
그렇다면 이런 CGLIB 라이브러리를 사용하지 않도록 @Configuration을 빼고 @Bean만 적용하면 어떻게 될까요?
//@Configuration 삭제
public class AppConfig {
...
}@configuration을 제거하면 AppConfig가 일반 클래스처럼 생성되는 것을 확인할 수 있습니다.
bean = class hello.core.AppConfig그리고 아까 작성했던 테스트 케이스를 돌려보면
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository
call AppConfig.memberRepositoryMemberRepository가 총 3번 호출된 것을 알 수 있습니다.
memberService -> memberRepository =
hello.core.member.MemoryMemberRepository@6239aba6
orderService -> memberRepository =
hello.core.member.MemoryMemberRepository@3e6104fc
memberRepository = hello.core.member.MemoryMemberRepository@12359a82인스턴스 또한 모두 다른것을 확인할 수 있습니다.
심지어 orderService, memberService안에 있는 memberRepository는 그냥 new로 만들어진 것 이기 때문에 Bean으로 관리되지도 않습니다.
@Bean만 사용해도 스프링 빈으로 등록되지만 싱글톤을 보장하지는 않습니다.
그냥 스프링 설정정보는 항상 @Configuration을 사용하시면 됩니다.
