스프링 싱글톤 컨테이너

✅ 스프링 없는 순수한 DI 컨테이너 테스트

public class SingletonTest {

    @Test
    @DisplayName("스프링 없는 순수한 DI 컨테이너")
    void pureContainer() {
        AppConfig appConfig = new AppConfig();

        //1. 조회: 호출할 때마다 객체를 생성
        MemberService memberService1 = appConfig.memberService();
        MemberService memberService2 = appConfig.memberService();

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

        //memberService1 != memberService2 // 두개의 객체의 참조값이 다름
        assertThat(memberService1).isEqualTo(memberService2);
    }
}

• 위 코드는 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다 객체를 새로 생성한다.
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다 -> 메모리 낭비가 심하다.
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. -> 싱글톤 패턴

✅ 싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴
• 객체 인스턴스가 2개 이상 생성되지 못하도록 막아야함
  -> private 생성자를 사용해서 외부에서 임의로 new 키워드로 객체 생성을 못하도록 막음

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 영역에 객체가 한개 바로 생성
2. 객체 인스턴스가 필요하면 public 메소드를 통해서 동일한 객체만 조회할 수 있도록 허용
3. 하나의 객체 인스턴스만 존재해야 하므로, private으로 막음

// 테스트 코드
public class SingletonTest {
    @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest() {
        //private으로 생성자를 막아두었다. 컴파일 오류가 발생
        //new SingletonService();

        //조회: 호출할 때 마다 같은 객체를 반환
        SingletonService singletonService1 = SingletonService.getInstance();
        SingletonService singletonService2 = SingletonService.getInstance();

        //참조 값이 같은 것을 확인
        System.out.println("singletonService1 = " + singletonService1); // ex) 123@@
        System.out.println("singletonService2 = " + singletonService2); // ex) 123@@

        //singletonService1 == singletonService2
        assertThat(singletonService1).isEqualTo(singletonService2); // 2개의 객체 인스턴스가 동일
    }

싱글톤 패턴을 적용하면 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.

하지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있다.

✅ 싱글톤 패턴 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다. DIP를 위반한다. -> ex) 구체 클래스.getInstance
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
• 테스트하기 어렵다.
• 내부 속성을 변경하거나 초기화 하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어진다.

이러한 문제점이 존재하지만 스프링에서는 자동으로 싱글톤 으로 만들어준다

✅ 싱글톤 컨테이너

• 스프링 컨테이너는 객체 인스턴스를 싱글톤으로 관리하여 싱글톤 컨테이너 역할을 한다
• 일일이 싱글톤 코드를 다 작성하지 않아도, 알아서 객체를 싱글톤으로 유지시켜 준다

싱글톤으로 등록하는 방법

• @Configuration 을 설정 정보 클래스에 붙이고 빈으로 등록하고 싶은 코드에 @Bean 을 사용
• 이렇게 설정하면 스프링 컨테이너가 자동으로 싱글톤으로 관리
• @Configuration이 없이 @Bean만 사용하게 된다면 스프링 빈으로 등록이 되지만 싱글톤을 보장 X

@Configuration
public class AppConfig {
	@Bean
 	public MemberService memberService() {
 		return new MemberServiceImpl(memberRepository());
 	}
   	@Bean
 	public OrderService orderService() {
 		return new OrderServiceImpl(memberRepository(), discountPolicy());
 	}
   	@Bean
 	public MemberRepository memberRepository() {
 		return new MemoryMemberRepository();
 	}
   	@Bean
 	public DiscountPolicy discountPolicy() {
 		return new FixDiscountPolicy();
 	}
}

위에 AppConfig 코드를 보면 분명 각각 2번 new MemoryMemberRepository를 호출해서
다른 인스턴스가 생성되어야 하는데 밑에 테스크 코드를 돌리면 같은 인스턴스가 나온다

public class ConfigurationSingletonTest {

    @Test
    void configurationTest() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);
        MemberRepository memberRepository = ac.getBean("memberRepository", MemberRepository.class);

        MemberRepository memberRepository1 = memberService.getMemberRepository();
        MemberRepository memberRepository2 = orderService.getMemberRepository();

        //모두 같은 인스턴스를 참고하고 있다.
        System.out.println("memberService -> memberRepository = " + memberRepository1); // 123@@
        System.out.println("orderService -> memberRepository2 = " + memberRepository2); // 123@@
        System.out.println("memberRepository = " + memberRepository); // 123@@

        //모두 같은 인스턴스를 참고하고 있다.
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
    }
}

모든 비밀은 -> AppConfig 클래스에 @Configuration 를 적용해서 그렇다
아마 내부에서 이러한 로직을 통해 싱글톤이 유지되는 것 같다

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

스프링 설정 정보는 항상 @Configuration를 사용하자

✅ 싱글톤 방식의 주의점

• 싱글톤 객체는 상태를 유지(stateful) 하게 설계하면 안된다
• 무상태(stateless)로 설계해야 한다
  -> 특정 클라이언트에 의존적인 필드가 있으면 안된다
  -> 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다
  -> 가급적 읽기만 가능해야 한다
  -> 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, 쓰레드로컬 등을 사용해야 한다

상태를 유지할 경우 문제점 예시

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