티스토리 뷰
[SpringBoot] 스프링 핵심 원리 섹션 5 | 싱글톤 컨테이너 | 싱글톤 패턴 및 주의 사항 | @Configuration |
YouJungJang 2023. 11. 28. 17:24본 포스팅은 인프런 김영한 강사님의 스프링 부트 핵심 원리 강의 섹션 5를 수강하고 배운 점을 정리했습니다.
스프링 핵심 원리 - 기본편 - 인프런 | 강의
스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., 스프링 핵심 원리를 이해하고, 성장하는 백엔드 개발자가 되어보세요! 📢
www.inflearn.com
1. 웹 애플리케이션과 싱글톤
[1] 스프링 없는 순수한 DI 컨테이너 테스트
- 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.
- 아래와 같이 고객 한 명이 memberService를 요청할 때마다 새로운 memberService 객체를 생성한다고 하면 어떨까?
테스트를 만들어서 직접 확인해 보자.
hello.core.Test.Singleton.SingletonTest
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의 객체가 서로 다른 것임을 알 수 있다.
즉, 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.
고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! ➡️ 메모리 낭비가 심하다.
💡해결방안: 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하자 -> 싱글톤 패턴
싱글톤 패턴 Singleton Pattern
클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴
직접 싱글톤 패턴을 구현해 보자.
hello.core.singleton.SingletonService
package singleton;
public class SingletonService {
//1. static : class 레벨에 딱 하나만 생성해둔다.
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("싱글톤 객체 로직 호출");
}
}
싱글톤 패턴 테스트 코드
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest(){
SingletonService singletonService1 = SingletonService.getInstance();
SingletonService singletonService2 = SingletonService.getInstance();
//참조값이 같은 것을 확인
System.out.println("memberService1 = "+singletonService1);
System.out.println("memberService2 = "+singletonService2);
}
출력:
아까와 다르게 싱글톤 패턴을 적용하면 고객의 요청이 올 때마다 객체를 생성하는 것이 아닌, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.
하지만 싱글톤 패턴을 위와 같이 직접 구현하는 것은 수많은 문제점들을 가진다.
⚠️싱글톤 패턴의 문제점
- 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
- 의존관계상 클라이언트가 구체 클래스에 의존한다. DIP를 위반한다.
- 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
- 테스트하기 어렵다.
- 내부 속성을 변경하거나 초기화하기 어렵다.
- private 생성자로 자식 클래스를 만들기 어렵다.
- 결론적으로 유연성이 떨어진다.
- 안티패턴으로 불리기도 한다
➡️직접 싱글톤 패턴을 구현하기보다는 '스프링빈'이 관리해 주는 싱글톤 컨테이너를 구현하자.
싱글톤 컨테이너 Singleton Container
✅ 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
✅ 싱글톤 레지스트리: 싱글톤 객체를 생성하고 관리하는 기능
🔎싱글톤 패턴과 비교한 싱글톤 컨테이너의 장점
- 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
- DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다
스프링 컨테이너를 사용하는 테스트 코드
@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);
}
출력
출력 결과는 싱글톤 패턴 테스트와 마찬가지로 같은 객체를 가져오는 것을 확인할 수 있다.
💡TIP | isSameAs와 is EqualTo는 다르다
- isSameAs : 주소 비교
- isEqualTo : 값 비교
Integer integerA = 1;
Integer integerB = 1;
assertThat(integerA).isEqualTo(integerB); // 1
assertThat(integerA).isSameAs(integerB); // 2
Integer integerC = 128;
Integer integerD = 128;
assertThat(integerC).isEqualTo(integerD); // 3
assertThat(integerC).isSameAs(integerD); // 4위 코드를 실행하면 1~3 통과, 4는 오류가 발생한다. 왜일까?
정수의 범위가 -128~127이라면, IntegerCache로부터 Integer 객체들을 리턴한다. 그 외의 범위에서만 Integer 객체들을 만들어 준다.
따라서 integerA와 integerB는 IntegerCache의 같은 Integer 객체의 주소를 가지므로 Same이다.
그러나 integerC와 integerD의 값은 128이므로, 서로 다른 Integer 객체를 가지므로 Not Same이다.
[Java] isSameAs, isEqualTo 정리
안녕하세요. 자바 코드를 테스트하면서 assetj의 isSameAs와 isEqualTo의 차이가 궁금해서 찾아보다가, 깊은 내용이 있음을 알게 되어 정리합니다. 참고로 테스트하실 때 밑에 있는 assertj로 사용하셔야
passionate.tistory.com
스프링 컨테이너 덕분에 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서
효율적으로 재사용할 수 있다.
+참고: 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때마다 새로운
객체를 생성해서 반환하는 기능도 제공한다.
싱글톤 방식의 주의점
이렇게 객체를 공유하고 재사용할 때 발생할 수 있는 문제점은 무엇일까?
두 사용자가 각각 서로 다른 주문 금액으로 주문하고 조회하는 테스트 코드를 통해 살펴보자.
상태를 유지하는 클래스 StatefulService
package 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 singleton;
import org.junit.jupiter.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;
import static org.junit.jupiter.api.Assertions.*;
class StatefulServiceTest {
@Test
void statefulServiceSingleton(){
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = ac.getBean(StatefulService.class);
StatefulService statefulService2 = ac.getBean(StatefulService.class);
//Thread A: A 사용자가 10000원 주문
statefulService1.order("userA", 10000);
//Thread B: B 사용자가 20000원 주문
statefulService2.order("userB", 20000);
//Thread A: A 사용자가 주문 금액 조회 -> 얼마가 나와야 할까?
int price = statefulService1.getPrice();
System.out.println("A price = " + price);
org.assertj.core.api.Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig{
@Bean
public StatefulService statefulService(){
return new StatefulService();
}
}
}
출력
테스트 코드에서 A 사용자는 분명 10000원을 주문했는데 A 사용자가 금액을 조회하기 직전에 같은 객체에 B 사용자가 20000원의 주문 금액을 넣는 바람에 예상과 다른 결괏값이 나왔다.
싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤
방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful) 하
게 설계하면 안 된다. -> 무상태(stateless)로 설계해야 한다.
무상태(Stateless)로 설계하는 방법
✅특정 클라이언트에 의존적인 필드가 있으면 안 된다.
✅ 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안 된다!
✅ 가급적 읽기만 가능해야 한다.
✅ 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
💡TIP | 테스트를 간단하게 추가하는 단축키: 윈도우 기준 Ctrl + Shift + t
@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();
}
...
}memberService 빈을 만들 때 memberRepository()를 호출한다 ➡️ new MemoryMemberRepository()를 호출
orderService 빈을 만들 때 memberRepository()를 호출한다 ➡️ new MemoryMemberRepository()를 호출
결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것처럼 보인다. 스프링
컨테이너는 이 문제를 어떻게 해결할까?
직접 확인해 보자
1. 검증용 테스트 코드 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;
}
}
2. 테스트 작성
@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("@Bean -> memberRepository = "+memberRepository);
assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
}
여기서 원래 기대하는 출력은 모든 memberRepository 출력값의 인스턴스가 같아야 한다.
하지만 나는 @Configuration 애노테이션을 AppConfig에 작성했음에도 불구하고 memberRepository가 세 번 호출되어 세 인스턴스가 모두 다른 것이 출력된다.
(@Configuration 애노테이션을 주석 처리해도 결과는 같음)
뭐지..
🛠️ 해결 방법
오류 원인은 AppConfig 파일에서 MemoryMemberRepository 가 static으로 선언되었기 때문이었다. static을 지워주니 정상적인 출력값을 내었다.
해결 완료:
정상적으로 memberRepository 한번 호출 & 모든 MemoryMemberRepository 객체 인스턴스가 같다.
@Configuration과 바이트코드 조작의 마법
순수한 자바 코드라면 분명 3번 호출되어야 하지만 스프링은 클래스의 바이트 코드를 조작하는 라이브러리를 사용하므로 한 번 호출이 가능한 것!
@Test
void configurationDeep(){
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("bean = " + bean.getClass());
}AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래서 AppConfig 도 스프링 빈이 된다.
AppConfig 스프링 빈을 조회해서 클래스 정보를 출력하면
bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70
순수한 자바 코드라면 아래와 같이 출력되어야 한다.
class hello.core.AppConfig
이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.
@Configuration을 적용하지 않고, @Bean 만 적용하면 어떻게 될까?
1. AppConfig 스프링빈 클래스 정보 조회 결과
bean = class hello.core.AppConfig이 출력 결과를 통해서 AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있
다.
2. AppConfig의 call memberRepository 출력 결과 : 3번 호출된다.
call AppConfig.memberService
call AppConfig.memberRepository // @Bean에 의해 스프링 컨테이너에 등록하기 위해서
call AppConfig.orderService
call AppConfig.memberRepository // memberRepository()를 호출하면서 발생1
call AppConfig.memberRepository // memberRepository()를 호출하면서 발생2정리
✅@Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다. memberRepository()처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.
✅ 스프링 설정 정보는 항상 @Configuration을 사용하자.