04. Spring Basic - 싱글톤

1. Singleton 과 웹 애플리케이션

---

웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

Spring x

• AppConfig는 요청을 할 때 마다 객체를 새로 생성
• 고객 트래픽이 초당 100이 나온다면 100개 객체가 생성되고 소멸한다 -> 메모리 낭비
• 해결방안 : 객체를 단 1개만 생성하고 이를 공유하도록 설계 -> 싱글톤 패턴

싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴
• 객체 인스턴스를 2개 이상 생성하지 못하도록 private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 함.

싱글톤 패턴을 적용한 예제 코드

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 영역에 객체 instance 를 미리 생성
• 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회 가능
• 생성자를 private으로 막아서 외부에서 new 키워드를 통해 객체가 생성되는 것을 차단

---

싱글턴 패턴을 적용하면 객체를 공유해서 효율적으로 사용할 수 있지만, 싱글톤 패턴은 다음과 같은 많은 문제점들을 가지고 있다.

싱글톤 패턴 문제점

• 싱글톤 패턴 구현하는 코드 자체가 많다.
• 의존관계상 클라이언트가 구체 클래스에 의존 -> DIP 위반
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높음
• 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 유연성이 떨어진다.

2. Singleton 컨테이너

---

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤으로 관리한다. 이를 담당하는게 바로 스프링 빈이다.

싱글톤 컨테이너

• 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성, 관리하는 기능을 싱글톤 레지스트리라 한다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

싱글톤 방식의 주의점

• 싱글톤 패턴이든, 컨테이너든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나를 공유하기 때문에 상태를 유지(stateful)하게 설계하면 안된다.
• 무상태(stateless)로 설계해야 한다.
  • 특정 클라이언트에 의존적인 필드가 있으면 안된다.
  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
  • 가급적 읽기만 가능해야 한다
  • 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

문제 예시

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;
	 }
}


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();
 		}
	 }
}

3. @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();
	 }
	 ...
}

보기에는 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것 처럼 보인다. 스프링 컨테이너는 이 문제가 해결 될까?

3.1 @Configuration과 바이트코드 조작의 마법

위에 자바 코드를 보면 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
}

• AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록됩니다. 따라서 AppConfig 도 스프링 빈이 됩니다.
• AppConfig 스프링 빈을 조회해서 클래스 정보를 출력하면 bean = class xxxx.xxxx.AppConfig$$EnhancerBySpringCGLIB$$bd4797d70 이 나옵니다.

순수한 클래스 라면 class xxxx.xxxx.AppConfig 가 나와야 합니다

이와 다른 것으로 보아 스프링이 CGLIB 라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

4. Conclusion

---

1. 고객의 요청을 효율적으로 처리하기 위해서는 Singlton 패턴이 필요하다
2. 이를 처리 하기 위해서는 복잡한 코드가 필요하고 또한 OOP를 침해할 수 있다.
3. 이를 해결하기 위해 Spring 에서는 Singleton 을 적용한 컨테이너를 제공한다.
4. 스프링 설정 정보는 항상 @Configuration 을 사용하자

<출처 : 스프링 핵심 원리 - 기본편 by 김영한>