[SPRING] 스프링 컨테이너 (싱글톤 패턴 개선)

싱글톤 패턴예제에 대한 내용은 기존 블로그에 정리 했었다.

 

prodo-developer.tistory.com/16

[JAVA] static과 싱글톤 패턴 예제

 

하지만, 여러가지 단점들도 있었다.

단점.
1. 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
2. 의존관계상 클라이언트가 구체 클래스에 의존한다. DIP를 위반한다.
3. 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
4. 테스트하기 어렵다.
5. 내부 속성을 변경하거나 초기화 하기 어렵다.
6. private 생성자로 자식 클래스를 만들기 어렵다.
7. 결론적으로 유연성이 떨어진다.
8. 안티패턴으로 불리기도 한다.

 

여기서는 객체를 미리 생성해두는 가장 단순하고 안전한 방법을 선택했다.

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("싱글톤 객체 로직 호출");
    }
}

 

이것을 편리하게 개선해줄 수있는 것이 바로 SpringContainer 스프링 컨테이너 (싱글 컨테이너) 입니다.

 

위와 아래는 JUnit5로 테스트를 해본 결과다. 두개 모두 정상적으로 작동한다.

 

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
	SingletonService singletonService1 = SingletonService.getInstance();
	SingletonService singletonService2 = SingletonService.getInstance();

	System.out.println("singletonService1" + singletonService1);
	System.out.println("singletonService2" + singletonService2);

	assertThat(singletonService1).isSameAs(singletonService2);
}

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
	ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

	MemberService memberService1 = ac.getBean("memberService", MemberService.class);
	MemberService memberService2 = ac.getBean("memberService", MemberService.class);

	// 참조 값이 같은 것을 확인
	System.out.println("memberService1 = " + memberService1);
	System.out.println("memberService2 = " + memberService2);

	assertThat(memberService1).isSameAs(memberService2);
}

 

스프링 컨테이너 장점

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

지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

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

 

이전에 설명한 컨테이너 생성 과정을 자세히 보자.

컨테이너는 객체를 하나만 생성해서 관리한다. 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다.

 

이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.

 

DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다.

 

스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라,

이미 만들어진 객체를 공유 해서 효율적으로 재사용할 수 있다.

 

> 참고: 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아니다. 요청할 때 마다 새 로운 객체를 생성해서 반환하는 기능도 제공한다.

 

 

싱글톤 방식의 주의점 싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서

공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지 (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 int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);

        return price;
    }
}

 

* 상태를 유지할 경우 발생하는 문제점 예시 (테스트)

import org.assertj.core.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;

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

 

- 최대한 단순히 설명하기 위해, 실제 쓰레드는 사용하지 않았다.

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

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

- 사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.

- 실무에서 이런 경우를 종종 보는데, 이로인해 정말 해결하기 어려운 큰 문제들이 터진다.(몇년에 한번씩 꼭 만난다.)

- 진짜 공유필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자.

 

* 개선된 테스트

package hello.core.singleton;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

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원 주문
        int userAPrice = stateFulService1.order("userA", 10000);
        // Thread B : B사용자가 20000원 주문
        int userBPrice = stateFulService2.order("userB", 20000);

        // Thread A : 사용자A가 주믄 금액 조회
        System.out.println(userAPrice);

    }

    static class TestConfig {

        @Bean
        public StateFulService stateFulService() {
            return new StateFulService();
        }
    }
}

 

참조 : 김영한의 스프링