Spring 핵심 원리 #8- 싱글톤 컨테이너

#웹 애플리케이션과 싱글톤

- 스프링은 태생이 기업용 온라인 서비스를 지원하기 위해 만들어졌으며, 대부분의 스프링 어플리케이션은 웹 어플리케이션이다. 웹 어플리케이션에서는 보통 여러 고객이 동시에 요청을 한다.

 

 

void pureContainer(){
	AppConfig appConfig= new AppConfig();
    
    //1. 조회: 호출할 때마다 객체를 생성
    MemberService memberService1= appConfig.memberService();
    
    //2. 조회: 호출할 때마다 객체를 생성
    MemberService memberService2= appConfig.memberService();
    
    //두 객체는 다른 객체이며, 매번 새로운 객체가 생성된다
    assertThat(memberService1).isNotSameAs(memberService2);
    
    }

 

- 스프링 없는 순수한 DI 컨테이너(ApplicationContext 사용 X)인 AppConfig은 요청을 할 때마다 객체를 새로 생성한다.

- 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 새로 생성되고 소멸되는데, 이는 메모리 낭비가 심하다.

   : 따라서 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. 이를 싱글톤 패턴이라고 한다.

 

 

#Singleton 패턴

- 싱글톤 패턴은 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.

- 그래서 private 생성자를 사용해 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

 

#싱글톤 패턴을 적용한 코드

public class SingletonService{
	
    //1. static 영역에 객체를 딱 1개만 생성해둔다.(외부에선 객체 생성 X)
    private static final SingletonService instance = new SingletonService();
    
    //2.getter를 public으로 열어서 필요하면 이 static 메서드를 통해서만 조회하도록 한다.
    public static SingletonService getInstance(){
    	return instance;
    }
    
    //3. 생성자를 private으로 선언해 외부에서 new 키워드를 사용한 객체 생성을 막는다.
    private SingletonService(){
    }
    
  
    }

- Static 변수는 class가 여러번 생성되어도 클래스 내부 Static 변수는 딱 한 번만 생성된다. 다른 파일에서 접근할 수 없고, 해당 파일에서만 scope에 맞게 접근 가능하다.

- 생성자를 private으로 선언함으로써 외부에서 new 키워드로 새로운 객체 인스턴스는 생성되지 않는다.

 

public void singletonServiceTest(){
	//new SingletonService(); - 이는 컴파일 오류가 발생한다.
    
    SingletonService singletonService1= SingletonService.getInstance();
    SingletonService singletonService2= SingletonService.getInstance();
    
    assertThat(singletonService1).isSameAs(singletonService2);
}

 

- 싱글톤 패턴을 적용하면 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해 효율적으로 사용할 수 있지만 아래와 같은 수많은 문제점들을 가지고 있다.

 

 

 

#싱글톤 컨테이너

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

- 컨테이너는 각 빈의 객체를 하나만 생성해서 관리한다 이 기능을 싱글톤 레지스트리라고 한다.

- 스프링 컨테이너의 이러한 기능 덕분에 싱글톤 패턴의 문제점을 해결하며, 객체를 싱글톤으로 유지할 수 있디.

- 추가적인 코드가 필요없고, DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

 

void springContainer() {
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
	
    //1. 조회: 호출할 때 마다 같은 객체를 반환
    MemberService memberService1 = ac.getBean("memberService", MemberService.class);
	
    //2. 조회: 호출할 때 마다 같은 객체를 반환
    MemberService memberService2 = ac.getBean("memberService", MemberService.class);

    //memberService1 == memberService2
    assertThat(memberService1).isSameAs(memberService2); 
    }

 

#싱글톤 방식의 주의점

- 싱글톤 패턴 or 싱글톤 컨테이너(스프링) 을 사용할때는 싱글톤 방식은 여러 클라이언트가 하나의 객체 인스턴스를 공유하기 때문에 해당 싱글톤 객체는 상태를 유지하게 설계하면 안된다.

- 무상태(Stateless)하게 설계해야 한다.

  : 특정 클라이언트에 의존적이거나 클라이언트가 임의로 값을 변경할 수 있는 필드가 있으면 안된다.

   -> 따라서, 필드(멤버변수) 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal등을 사용해야 한다.

 

Ex) 상태를 유지하는 경우 & 문제점 예시

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

//Test Class

@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원 출력
      
    Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    

}

- ThreadA가 사용자 A의 코드를 호출하고, ThreadB가 사용자B의 코드를 호출한다고 가정하자.

- StatefulService의 price 필드는 공유필드이므로, 특정 클라이언트가 값을 마음대로 변경하게 된다.

- 따라서 원하지 않은 금액이 주문될수 있고, 이는 큰 장애로까지 이어질 수 있다. 

  : 공유 필드는 정말 조심해야 할 부분이고, 스프링 빈은 항상 stateless하게 설계하는 것을 기억하자!!

 

EX) 해결 방안

public class StatefulService {

	//공유필드는 삭제하고, 파라미터로 받고 값을 return하도록 한다.
    public int order(String name, int price){
        System.out.println("name="+name+"price="+price);
        //this.price=price;
        return price;
    }
}

@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원 주문
        int priceA=statefulService1.order("userA",10000);
        //Thread B: B사용자가 20000원 주문
        int priceB=statefulService2.order("userB",20000);
        
        //지역변수를 사용해 각각의 값을 받도록 한다. 공유필드는 절대 건드리지 말것!!
        }

 

 

#Configuration과 싱글톤

- 이전에 설정 정보를 담았던 클래스 AppConfig를 다시 한번 살펴보면, 하나의 객체가 여러번 생성되어야 하는 것 처럼 보여 얼핏 보면 싱글톤이 지켜지지 않을 것 같을 수 있다.

 

But, 테스트를 진행해보면 모든 객체가 여러번 호출되는 것 처럼 보이나 모두 한번씩만 호출되는 것을 확인할 수 있다.

 -> 이는 어떻게 가능할까? 모든 마법은 스프링이 이루어줄것이니..

 

 

 

 

#@Configuration와 바이트코드 조작

- 스프링 컨테이너는 싱글톤 레지스트리이다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 하지만, 존재하는 자바 코드까지 스프링이 어떻게 하기는 어렵다. 그래서 스프링은 클래스의 바이트 코드를 조작하는 라이브러리를 사용한다.

 

-> 여기서 AppConfig 또한 스프링 빈으로 출력되는데, 결과를 잘 보면 Spring뒤에 CGLIB라는 글자를 확인할 수 있다.

: 이는 스프링이 @Configuration 애노테이션을 인식하여 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

-> 이 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다.

 

 

- 아마 해당 클래스 내의 코드는 다음과 같을 것이다. (실제로는 매우 복잡함)

: 코드를 잘 살펴보면 객체가 이미 존재하면 그 객체를 반환하고, 없으면 객체를 생성하여 스프링 컨테이너에 등록됨을 알 수 있다. 반드시 @Configuration을 등록해야 이가 가능하고, 단순히 @Bean만 붙이면 순수한 AppConfig로 스프링 빈에 등록되어 객체를 여러번 생성하게 되고, 싱글톤 또한 보장되지 않는다.

 

#결론

: 스프링 설정 정보에는 고민하지 말고 항상 @Configuration을 적용하자!!! 반항하지 마세요.