.png&blockId=7628ec0c-1357-4c37-a1e9-32a282f6efaa)
.png&blockId=be06ed4d-0152-4f0f-b4b4-821bd1fb30d9)
.png&blockId=39a86e12-3cf4-40df-8d5e-9891c5adc274)
_%25E1%2584%2587%25E1%2585%25A9%25E1%2586%25A8%25E1%2584%2589%25E1%2585%25A1%25E1%2584%2587%25E1%2585%25A9%25E1%2586%25AB.png&blockId=891e6648-1148-4e7c-bfcd-0463dc71545c)
.png&blockId=5e737e69-4f36-437b-95e0-7db747173000)
.png&blockId=5294c22e-8cee-4109-963f-c8cfe8c852cf)
싱글톤 패턴
웹 어플리케이션은 보통 여러 고객이 동시에 사용한다. 그렇기 때문에, new라는 생성자를 통해 같은 속성의 객체가 여러개 생성되는 경우가 발생한다.
•
고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! → 메모리 낭비가 심함
해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. ⇒ 싱글톤 패턴
•
클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴
•
객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 함
⇒ private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.
싱글톤을 구현하는 많은 방법이 있지만, 아래 예제는 객체를 미리 생성해두는 가장 단순한 방법 사용(어짜피 Spring이 싱글톤 패턴으로 관리해주기 때문)
싱글톤 패턴 적용
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;
}
// 생성자를 private로 만듦으로써 외부에서 new를 이용하여 객체를 생성하는 것을 막는다.
private SingleTonService() {
}
public void logic() {
System.out.println("싱글톤 객체 로직 호출");
}
}
Java
복사
싱글톤 패턴 TestCode
@Test
@DisplayName("싱글톤 패턴을 사용한 객체 사용")
void singletonServiceTest() {
//private으로 생성자를 막아두었다. 컴파일 오류가 발생한다.
//new SingletonService();
//1. 조회: 호출할 때 마다 같은 객체를 반환
SingleTonService instance1 = SingleTonService.getInstance();
//2. 조회: 호출할 때 마다 같은 객체를 반환
SingleTonService instance2 = SingleTonService.getInstance();
//3. 참조값이 같은 것을 확인
System.out.println("instance1 = " + instance1);
System.out.println("instance2 = " + instance2);
assertThat(instance1).isSameAs(instance2);
}
Java
복사
결과
1.
static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
2.
이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3.
딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아서 혹시라도 외부에서 new
키워드로 객체 인스턴스가 생성되는 것을 막는다.
Assertion.assertThat.isSameAs vs Assertion.assertThat.isEqualTo
isSameAs : '=='으로 인스턴스가 동일한지 체크
IsEqualTo : 'equals()'로 인스턴스가 아닌 인스턴스 내부의 값을 비교
싱글톤의 문제점
•
싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
•
의존관계상 클라이언트가 구체 클래스에 의존한다 ⇒ DIP를 위반한다.
•
클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
•
테스트하기 어렵다.
•
내부 속성을 변경하거나 초기화 하기 어렵다.
•
private 생성자로 자식 클래스를 만들기 어렵다.
결론적으로 유연성이 떨어져 안티패턴으로 불리기도 한다.
⇒ 하지만 스프링 컨테이너가 싱글톤으로 관리하면서 위에 있는 모든 문제점을 해결해준다.
싱글톤 컨테이너
스프링 컨테이너는 스프링 빈을 통해 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다
⇒ 스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용 가능
•
스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
◦
•
스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
•
싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
•
DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다.
1. 스프링 컨테이너를 사용하는 테스트 코드
@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);
// memberService1 == memberService2
assertThat(memberService1).isSameAs(memberService2);
}
Java
복사
그럼 새로운 객체를 생성할 필요가 있을 때는??
⇒ 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때 마다 새로운 객체를 생성해서 반환하는 기능도 제공
(빈 스코프 참고)
싱글톤 패턴 주의점
싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.
무상태(stateless)로 설계해야 한다!
•
특정 클라이언트에 의존적인 필드가 있으면 안된다.
•
특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다!
•
가급적 읽기만 가능해야 한다.
•
필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.
⇒ 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다!!!
1. 장애 발생 예시 - StateFull 설계
StateFull 설계
package hello.core.singleton;
public class StateFullService {
private int price; // 상태를 유지하는 필드(StateFull)
public void order(String name, int price) {
System.out.println("name = " + name + " price = " + price);
this.price = price; //여기가 문제!!
}
public int getPrice() {
return price;
}
}
Java
복사
StateFull 설계 TestCode
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StateFullService stateFullService1 = ac.getBean(StateFullService.class);
StateFullService stateFullService2 = ac.getBean(StateFullService.class);
// ThreadA : A사용자가 10000원 주문 신청
stateFullService1.order("userA", 10000);
//ThreadB : B사용자가 20000원 주문 신청
stateFullService2.order("userB", 20000);
//ThreadA : A 사용자가 주문 금액 조회
int price = stateFullService1.getPrice();
System.out.println("price = " + price);
Assertions.assertThat(stateFullService1.getPrice()).isEqualTo(20000);
}
Java
복사
결과
•
보통 멀티 쓰레드 환경에서 잘 나타나는 오류
→ 위 예제는 단순히 설명하기 위해 실제 쓰레드 사용 X
•
StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경
•
사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.
2. 장애 발생 수정 - StateLess 설계
StateLess한 설계
package hello.core.singleton;
public class StateFullService {
private int price; // 상태를 유지하는 필드(StateFull)
public int order(String name, int price) {
System.out.println("name = " + name + " price = " + price);
return price;
}
}
Java
복사
StateLess한 설계
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StateFullService stateFullService1 = ac.getBean(StateFullService.class);
StateFullService stateFullService2 = ac.getBean(StateFullService.class);
// ThreadA : A사용자가 10000원 주문 신청
int userAPrice = stateFullService1.order("userA", 10000);
//ThreadB : B사용자가 20000원 주문 신청
int userBPrice = stateFullService2.order("userB", 20000);
//ThreadA : A 사용자가 주문 금액 조회
System.out.println("price = " + userAPrice);
Assertions.assertThat(userAPrice).isEqualTo(10000);
}
Java
복사
결과
•
실무에서 이런 경우를 종종 보는데, 이로인해 정말 해결하기 어려운 큰 문제들이 터진다.(몇년에 한번씩 꼭 만난다.)
진짜 공유필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자.
@Configuration 마법 & 싱글톤
아무리 스프링이 싱글톤을 관리해준다 하더라도, JAVA 코드를 어떻게 할 수는 없다. 하지만, 아래와 같은 코드를 해석해 본다면, MemoryMemberRepository() 가 여러번 호출되는데 스프링은 JAVA 코드를 어찌하지 못한다면서 어떻게 싱글톤으로 관리할 수 있는것일까?
@Configuration
public class AppConfig {
@Bean
public MemberService memberService(){
return new MemberServiceImpl(memberRepository());
}
@Bean
public OrderService orderService(){
return new OrederServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
return new MemoryMemberRepository();
}
}
Java
복사
1.
memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다.
→ 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.
2.
orderService 빈을 만드는 코드도 memberRepository()를 호출한다.
→ 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.
결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것 처럼 보인다.
⇒ 스프링 컨테이너는 이를 @Configuration 어노테이션을 이용해 해결한다.
테스트
검증 용도의 코드 추가
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
//테스트 용도
public MemberRepository getMemberRepository() {
return memberRepository;
}
}
Java
복사
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
//테스트 용도
public MemberRepository getMemberRepository() {
return memberRepository;
}}
Java
복사
TestCode
@Test
void configurationTest() {
ApplicationContext ac = new
AnnotationConfigApplicationContext(AppConfig.class);
MemberServiceImpl memberService = ac.getBean("memberService",
MemberServiceImpl.class);
OrederServiceImpl orderService = ac.getBean("orderService",
OrederServiceImpl.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);
}
Java
복사
결과
•
memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository 호출해서 다른 인스턴스가 생성되어야 하는데?
⇒ @Configuration으로 싱글톤을 유지해주기 때문에 같은 인스턴스가 공유된다. → 아래 @Configuration 마법 참고
@Configuration 마법 참고 @Configuration 마법
@Configuration 마법 & 싱글톤에서 말했듯이 스프링 컨테이너는 싱글톤 레지스트리로써, 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 하지만, 스프링이 JAVA 코드까지 어떻게 할 수 없기 때문에, 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.⇒ 모든 비밀은 @Configuration 어노테이션을 적용한 AppConfig.class에 있다.
TestCode
@Test
void configurationDeep() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("bean = " + bean.getClass());
}
Java
복사
•
AnnotationConfigApplicationContext 에 파라미터로 전달된 값도 스프링 빈으로 등록된다.
•
AppConfig.class를 스프링 빈 조회를 통해 클래스 정보를 출력해보자
결과
•
순수한 클래스라면 hello.core.AppConfig 가 출력되어야 하지만, 예상과는 다르게 클래스 명에 xxxCGLIB가 붙으면서 상당히 복잡해진 것을 볼 수 있다.
내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것
@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
AppConfig@CGLIB가 AppConfig를 상속
AppConfig@CGLIB 예상 Pseudo 코드
@Bean
public MemberRepository memberRepository() {
if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
return 스프링 컨테이너에서 찾아서 반환;
} else { //스프링 컨테이너에 없으면
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록 return 반환
}
}
Java
복사
만약 @Configuration 없이 @Bean만 사용한다면?
검증 용도의 코드 수정
// @configuration 삭제
@Configuration
public class AppConfig {
.
.
.
}
Java
복사
TestCode
@Test
void configurationDeep() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("bean = " + bean.getClass());
}
Java
복사
결과
AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.
•
즉, @Configuration 어노테이션이 없이 @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장하지 않는다.
•
memberRepository() 처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.
크게 고민할 것 없이 스프링에서 싱글톤을 관리해주기 때문에 스프링 설정 정보에서는 @Configuration을 사용하자