싱글톤 패턴, 싱글톤 컨테이너 (Singleton)

웹 애플리케이션과 싱글톤

스프링은 기업에서 많이 사용된다.

대부분의 스프링 애플리케이션은 웹 애플리케이션이다.

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

여러 고객이 위와 같이 동시에 요청을 하게 되는데, 스프링 없는 순수한 DI 컨테이너인 AppConfig은 요청을 할 때마다 객체를 새로 생성한다.

이렇게 되면 그만큼 많은 객체가 생성되고 소멸되므로 메모리 낭비가 심하다!

이를 해결하기 위해 싱글톤 패턴을 사용해서 해당 객체가 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("싱글톤 객체 로직 호출");
        }
}

1. static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.

2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.

 

이렇게 하면 객체를 공유해서 사용할 수 있지만, 구현 코드 자체가 너무 많이 들어가고 OCP를 위반할 가능성이 높다.

또한, 내부 속성을 변경하거나 초기화하기 어려운 등의 문제가 많다.

 

이를 해결하기 위해선 어떻게 해야할까?

→ 싱글톤 컨테이너

---

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다.

앞서 알아본 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

 

스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 자동으로 객체 인스턴스를 싱글톤으로 관리한다.

스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

스프링 컨테이너 덕분에 고객의 요청이 올 때마다 객체를 생성하는 게 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용하게 된다.

 

---

싱글톤 방식의 주의점

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(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();
            }
            }
}

실제 쓰레드는 사용하지 않았음.

price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.

무상태가 아니기 때문에 문제가 발생하게 된다.

스프링 빈은 항상 무상태로 설계하자!!!

 

---

@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()를 호출하고, orderService 빈을 만드는 코드에서도 memberRepository()를 호출한다.

이는 다른 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 거처럼 보인다.

과연, 스프링 컨테이너는 어떻게 해결할까?

 

정답은 @Configuration에 있다.

스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

빈을 조회하기 전에 해당 코드를 통해서 스프링 컨테이너를 사용한다.

AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록된다.

그래서 AppConfig 도 스프링 빈이 된다.

 

그러면 AppConfig를 조회해서 출력해보면 class hello.core.AppConfig와 같이 출력되어야 할 것이다.

그러나, 실제로는  class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70 와 같이 출력된다.

 

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

스프링은 해당 CGLIB을 통해서 싱글톤이 보장되도록 해준다.

[ AppConfig@CGLIB는 AppConfig의 자식 타입이므로, AppConfig 타입으로 조회 할 수 있다. ]

 

@Configuration 을 적용하지 않고, @Bean 만 적용하면 어떻게 될까?

예상과 같이, 싱글톤이 깨지고, AppConfig에서 memberRepository는 각각 다른 인스턴스가 생성되어서 제공된다.

 

---

정리

@Bean 만 사용해도 스프링 빈으로 등록은 되지만, 싱글톤은 보장하지 않는다.

때문에, 스프링 설정 정보를 기입하는 클래스는 @Configuration 을 항상 사용하자.

싱글톤 패턴을 사용할 때는 무상태로 설계하는 것을 잊지 말자!

다른 클라이언트가 값을 변경할 수 있는 필드를 만들지 말고, 자바에서 공유되지 않는 지역 변수, 파라미터, ThreadLocal 등을 사용하자.

다음 시간에는, 컴포넌트 스캔에 대해서 알아보겠다.