[Spring] 싱글톤 컨테이너 2) 싱글톤 방식의 주의점

 

 

목차 

• 싱글톤 컨테이너 - 웹 애플리케이션과 싱글톤 
• 싱글톤 컨테이너 - 싱글톤 패턴 (디자인패턴에서의..)
• 싱글톤 컨테이너 - 싱글톤 컨테이너 -> 스프링 컨테이너가 자동으로 싱글톤 패턴을 적용해줌 
• 싱글톤 컨테이너 - 싱글톤 방식의 주의점 (중요)
• 싱글톤 컨테이너 - @Configuration과 싱글톤
• 싱글톤 컨테이너 - @Configuration과 바이트코드 조작의 마법

 

 

싱글톤 방식의 주의점

 

무상태(stateless)로 설계해야한다. 

싱글톤 패턴, 싱글톤 컨테이너든 객체 인스턴스를 하나만 생성하여 공유하게 되면, 여러 클라이언트가 하나의 객체 인스턴스를 공유하기 떄문에 상태를 유지(stateful)하게 설계하면 안된다.

 

특정 클라이언트에 의존적인 필드가 있으면 안된다.

특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다

가급적 읽기만 가능

필드 대신 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal을 사용해야한다.

 

 

stateful로 설계시 문제점

위의 문제점을 코드로 확인해보자.

singleton 패키지 하위에 StatefulService클래스를 생성한다. 

이 클래스는 상태를 유지하는 stateful 필드인 price를 가진다. 

order라는 메소드가 호출되면 매개변수로 들어온 값을 통해, price가 변경되며, getPrice로 이 필드를 조회 가능하다. 

 

 

StatefulSerivce

package hello.core.singleton;

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


}

 

 

singleton 패키지 하위에 StatefulServiceTest 

실제로 동작시켜보자. 

package hello.core.singleton;

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;

import static org.junit.jupiter.api.Assertions.*;

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원 주문
        statefulService1.order("userA",10000);

        //Thread B : B사용자 20000원 주문 (주문 금액 조회 사이에 B사용자가 끼어든 상황)
        statefulService2.order("userB",20000);


        //Thread A : A사용자 주문 금액 조회 하려고 함
        int price = statefulService1.getPrice();
        System.out.println("price = " + price); //B사용자의 주문 금액이 나옴


        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000); //안됨 10000원이어야함

    }


    static class TestConfig{

        @Bean
        public StatefulService statefulService(){
            return new StatefulService();
        }

    }

}

우리의 목적은 userA의 금액을 조회하는 것인데, 

userA의 주문과 가격 조회 사이에 userB의 주문이 들어왔다.

        //Thread A : A사용자 10000원 주문
        statefulService1.order("userA",10000); // price : 10000

        //Thread B : B사용자 20000원 주문 (주문 금액 조회 사이에 B사용자가 끼어든 상황)
        statefulService2.order("userB",20000); // price : 10000 -> 20000 변경됨

결과는 우리의 의도와 다르게 userB의 주문가격이 입력되었다. (userA에게 userB의 결제가격이 청구될 수 있는 상황) : 망함

 

 

문제는 다음과 같다. 

(최대한 단순히 설명하기 위해, 실제 쓰레드는 사용하지 않았다.)
ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.

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

따라서, 사용자A의 주문금액은 10000원이 되어야 하는데, (사용자 B클라이언트가 값을 변경해) 20000원이라는 결과가 나왔다.

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

 

 

 

위에서 언급한대로 지역변수를 사용해서 문제를 해결할 수 있다.

StatefulSerivce

package hello.core.singleton;

public class StatefulService {


//    private int price; //상태를 유지하는 필드

    public int order(String name, int price){

        System.out.println("name = " + name + " price = "+price);

//        this.price = price; //여기가 문제! 공유필드가 변경됨
        return price; //지역변수로 넘겨버리기

    }

//    public int getPrice(){
//        return price;
//    }


}

문제가 되는 공유필드를 없애고, 해당 값이 받은 price값을 그대로 리턴하도록 변경한다.

 

 StatefulServiceTest 

package hello.core.singleton;

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;

import static org.junit.jupiter.api.Assertions.*;

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원 주문 (주문 금액 조회 사이에 B사용자가 끼어든 상황)
        int userBPrice = statefulService2.order("userB",20000);


        //Thread A : A사용자 주문 금액 조회 하려고 함
//        int price = statefulService1.getPrice();
        System.out.println("price = " + userAPrice); //B사용자의 주문 금액이 나옴


//        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000); //안됨 10000원이어야함

    }


    static class TestConfig{

        @Bean
        public StatefulService statefulService(){
            return new StatefulService();
        }

    }

}

지역변수인 userAPrice, userBPrice에 값을 담아 A의 가격을 출력한다. 

 

 

이는 매우 해결하기 어려운 오류이고, 발견도 어렵고, 고치는건 더 어렵다! 매우중요한 문제