Spring- 싱글톤

싱글톤

 객체를 필요시마다 새로이 생성하는 것이 아니라 하나의 객체를 계속 공유해 사용하는 것이다.

 

싱글톤의 구현

package hello.core.singleton;

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    private SingletonService(){} // private 생성자로 객체가 하나만 생성되도록 함 (외부에서 new 방지)

    public static SingletonService getInstance(){  // instance를 꺼내기 위한 유일한 방법
        return instance;
    }
    public void logic(){
        System.out.println("싱글톤 객체 로직 호출");
    }
}

 SingletinService 객체는 private 생성자를 가지고 있기 때문에 instance 객체 하나만 존재할 수 있다. 외부에서 new를 하는 것이 불가하기 때문이다.

 객체 인스턴스는 오직 getInstance 메서드를 통해서만 조회할 수 있다.

 

 싱글톤의 문제점

• 구체 클래스에 의존한다. -> DIP를 위반한다.
• 구체 클래스에 의존하여 OCP를 위반할 가능성이 높다.
• private 생성자로 자식 클래스를 만들기 어렵다.

 

 스프링 컨테이너를 통한 싱글톤 구현

 스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체를 싱글톤으로 관리한다. 스프링 컨테이너는 객체를 하나만 생성해서 관리하기 때문에 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 관리하는 기능을 싱글톤 레지스트리라고 한다.

@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);
}
    
memberService1 = hello.core.member.MemberServiceImpl@3382f8ae
memberService2 = hello.core.member.MemberServiceImpl@3382f8ae

스프링 컨테이너를 사용했더니 memberService1과 memberService2가 모두 같은 객체(싱글톤)인 것을 확인할 수 있다.

 싱글톤 방식 사용시 주의

 싱글톤은 하나의 객체를 여러 클라이언트가 공유하는 방식이다보니 하나의 유저가 객체에 영향을 줄 경우 다른 유저들도 그 영향을 받을 수 있다라는 큰 문제점이 존재한다.

 그렇기에 싱글톤을 다룰 때에는 특정 클라이언트에 의존적이거나 특정 클라이언트가 값을 변경할 수 있는 필드가 존재해서는 안된다. 그렇기에 가급적이면 읽기만 가능한 형태가 되어야한다.

 

  - 문제가 있는 방식

 

값이 변경되는 필드가 존재하는 싱글톤 구현

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

 이 코드는 단순한 클래스 구현코드로 볼 수 있지만 만일 이 클래스의 객체 반환 함수가 스프링 빈으로 등록되는 경우 문제가 커진다. 다 필요없고 order()를 보자. order()에는 this.price = price; 라는 구문이 존재하는데, 인자로 들어온 값이 "필드(멤버변수 price)의 값을 변경"한다.

 

 위 클래스 객체를 반환하는 메소드를 스프링 빈으로 등록한 코드를 보자.

싱글톤 방식의 문제를 구현한 코드

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", 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();
        System.out.println("price = " + price);

        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(statefulService2.getPrice());
    }

    static class TestConfig{

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

name = userA price= 10000
name = userB price= 20000
price = 20000

 여기서 price는 분명히 userA의 금액으로 10000원이 나와야 하는데 반해, 정작 20000원으로 출력이된다. 이는 싱글톤 방식의 문제점이 여실히 드러나는 점이다. 하나의 객체를 여러 사용자가 공유하기 때문에 한 사용자가 price를 중간에 건들면 다른 사용자들의 값들도 모두 변하는 것이다. 이 경우에는 userA가 10000원을 설정했지만 후에 userB가 20000원을 설정하여 그 값이 변경된 것이다. 

 그렇기에 싱글톤 방식(스프링 컨테이너를 사용하든 싱글톤을 직접구현하든)은 값을 변경할 수 있는 필드가 있어선 안된다는 것이다.

 

  - 올바른 방식

값이 변경되는 필드가 없는 싱글톤 구현

package hello.core.singleton;

public class StatefulService {

    public int order(String name, int price) {
        System.out.println("name = " + name + " price= " + price);
        return price;  // 값을 공유하는 필드를 없애버림
    }
}

문제가 없는 테스트 코드

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", StatefulService.class);
        StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);

        // ThreadA: A사용자 10000원 주문
        int priceA = statefulService1.order("userA", 10000);
        // ThreadB: B사용자 20000원 주문
        int priceB = statefulService2.order("userB", 20000);

        // ThreadA: 사용자A 주문 금액 조회

        System.out.println("priceA = " + priceA);
        System.out.println("priceB = " + priceB);

        Assertions.assertThat(priceA).isNotEqualTo(priceB);
    }

    static class TestConfig{

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


name = userA price= 10000
name = userB price= 20000
priceA = 10000
priceB = 20000

 문제가 있는 방식에서는 값의 변경이 가능한 필드 price가 존재했지만, 여기서는 그냥 없애버렸다. 그리고 받은 인자를 그대로 반환하여 변경이 가능한 부분이 없다. 이런식으로 문제를 해결했다.

 스프링은 항상 무상태로 구현해야한다.