싱글톤 컨테이너(Spring)

웹 애플리케이션

- 스프링은 기업용 온라인 서비스 기술을 지원하기 위해 만들어졌다. 

- 스프링 애플리케이션은 웹 애플리케이션이 대부분이지만 웹이 아닌 애플리케이션 개발도 가능하다.

- 클라이언트가 요청을 할 때마다 DI컨테이너(AppConfig)는 새로운 인스턴스를 만들어서 반환한다.

- 트래픽이 초당 100개면 초당 100개의 객체가 생성되고 소멸됨 -> 자원의 낭비

- 생성된 인스턴스를 공유하면 됨: 싱글톤 패턴

package hello.core.singleton;
import hello.core.AppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;
public class SingletonTest {
    @Test
    @DisplayName("스프링 없는 순수한 DI 컨테이너(AppConfig)")
    void pureContainer() {
        AppConfig appConfig = new AppConfig();
        // 호출할 때 마다 객체를 생성
        MemberService memberService1 = appConfig.memberService();
        // 호출할 때 마다 객체를 생성
        MemberService memberService2 = appConfig.memberService();
        //참조값이 다름 -> 인스턴스가 낭비되고 있음 -> 싱글톤 패턴이 필요
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);
        // memberService1 != memberService2
        assertThat(memberService1).isNotSameAs(memberService2);
    }
}

싱글톤 패턴

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

- 생성자를 private으로 만들면 밖에서 생성자 호출을 막을 수 있다.(컴파일 오류)

package hello.core.singleton;
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영역에 객체 인스턴스가 1개 생성된다.

2. getInstance를 통해 미리 생성해 둔 instance를 반환해 갈 수 있도록 한다.

3. 생성자를 private으로 선언해 외부에서 인스턴스를 생성하지 못하게 막는다.

    @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    public void singletonServiceTest() {
        //private으로 생성자를 막아두었다. 컴파일 오류가 발생한다.
        //new SingletonService();
        // 호출할 때 마다 같은 객체를 반환
        SingletonService singletonService1 = SingletonService.getInstance();
        // 호출할 때 마다 같은 객체를 반환
        SingletonService singletonService2 = SingletonService.getInstance();
        // 참조값이 같은 것을 확인
        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);
        // singletonService1 == singletonService2
        // same은 인스턴스 값을 확인 ==
        // equal은 값을 확인 .equals
        assertThat(singletonService1).isSameAs(singletonService2);
        singletonService1.logic();
    }

싱글톤 패턴의 문제점

- 구현 코드가 많이 들어감

- new 인스턴스를 반환하면서 구체 클래스에 의존해 DIP를 위반한다.

- 마찬가지 이유로 OCP를 위반할 수 있다

- 테스트하기 어렵다

- 내부 속성을 변경하거나 초기화하기 어렵다

- private 생성자로 자식 클래스를 만들기 어렵다 -> 유연성이 떨어진다

- 안티패턴으로 불리기도 한다

싱글톤 컨테이너

- 스프링 컨테이너 == 싱글톤 컨테이너라고도 부름

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

- 스프링 컨테이너가 싱글톤으로 관리를 해주면서 기존 싱글톤 패턴의 모든 단점을 해결해주었다.

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

* 스프링의 기본 빈 등록 방식은 싱글톤(99.9%)이다. 하지만 다른 기능들도 제공한다.

    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
        ApplicationContext ac = new
                AnnotationConfigApplicationContext(AppConfig.class);
        //1. 조회: 호출할 때 마다 같은 객체를 반환
        MemberService memberService1 = ac.getBean("memberService",
                MemberService.class);
        //2. 조회: 호출할 때 마다 같은 객체를 반환
        MemberService memberService2 = ac.getBean("memberService",
                MemberService.class);
        //참조값이 같은 것을 확인
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);
        //memberService1 == memberService2
        assertThat(memberService1).isSameAs(memberService2);
    }

싱글톤 방식의 주의할 점

- 여러 클라이언트가 하나의 인스턴스를 공유하는 형태이기때문에 상태유지(stateful)하게 설계하면 안된다

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

- 지역변수, 파라미터, ThreadLocal 등을 사용해 공유되지 않는 방식으로 리턴해서 사용한다.

- 반드시 지켜야 할 점이다.

// 상태 유지 문제 코드
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;
    }
}

// 테스트 코드
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;
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원 출력
        // 반환값을 price로 해 해결할 수 있다
        System.out.println("price = " + price);
        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }
    static class TestConfig {
        @Bean
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }
}

@Configuration

- spring이 이 악물고 싱글톤 보장해 줌.
- AppConfig@CGLIB라는 AppConfig를 상속받는 클래스를 새롭게 만들어서 싱글톤을 보장함.

@Bean
public MemberRepository memberRepository() {

    if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
        return 스프링 컨테이너에서 찾아서 반환;
    } else { //스프링 컨테이너에 없으면
        기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
        return 반환
    }
}

- 상속받은 클래스를 스프링 빈으로 등록함.

bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70

- Configuration 어노테이션을 빼면 싱글톤 컨테이너가 적용이 안됨.

bean = class hello.core.AppConfig

- @Bean만 사용해도 스프링 빈으로 등록은 됨.

- 스프링 설정 정보는 항상 @Configuration을 사용하자.