싱글톤 컨테이너

1. 웹 애플리케이션과 싱글톤

- 스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.

- 스프링 애플리케이션은 웹 애플리케이션이다.

- 여러 고객이 동시에 요청을 한다.

@Test
    @DisplayName("스프링 없는 순수한 DI 컨테이너")
    void pureContainer (){
        AppConfig appConfig = new AppConfig();
        //1. 조회 : 호출할때마다 객체를 생성
        MemberService memberService1 = appConfig.memberService();

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

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

        // memberService1 != memberService2
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }

- 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때 마다 객체를 새로 생성한다.

ex) 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다. 메모리 낭비가 심하다.

해결방안: 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. -> 싱글톤 패턴

 

2. 싱글톤 패턴

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

- 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.

- private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다

 

public class SingletonService {

    private static  final SingletonService instance =  new SingletonService();

    public static SingletonService getInstance() {
        return instance;
    }

    private SingletonService(){

    }

    public void logic(){
        System.out.println("싱글톤 객체 로직 호출");
    }

}

- static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.

- 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.

- 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아서 혹시라도 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

 

싱글톤 패턴을 사용하는 테스트 코드

 @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    public void singletonServiceTest(){
        SingletonService singletonService1 = SingletonService.getInstance();
        SingletonService singletonService2 = SingletonService.getInstance();
        //참조 값이 다른 것을 확인
        System.out.println("singletonService1 = " +  singletonService1);
        System.out.println("singletonService2 = " +  singletonService2);
        //singletonService1 = hello.core.singleton.SingletonService@13b6aecc
        //singletonService2 = hello.core.singleton.SingletonService@13b6aecc

        Assertions.assertThat(singletonService1).isSameAs(singletonService2);

        //same ==
        // equal 자바의 equals 비교
    }

- private으로 new 키워드를 막아두었다.

- 호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.

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

 

문제점

- 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다

- 의존관계상 클라이언트가 구체 클래스에 의존한다 -> DIP를 위반

- 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.

- 테스트하기 어렵다 -> 내부 속성을 변경하거나 초기화 하기 어렵다.

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

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

3. 싱글톤 방식의 주의점

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

- 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

싱글톤 컨테이너

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

- 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

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

 

스프링 컨테이너를 사용하는 테스트 코드

   @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
     //   AppConfig appConfig = new AppConfig();
        //1. 조회 : 호출할때마다 객체를 생성
        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);
        
        Assertions.assertThat(memberService1).isSameAs(memberService2);
    }

- 스프링 컨테이너 덕분에 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다

 

 

4. 싱글톤 방식의 주의점

- 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.

- 무상태(stateless)로 설계해야 한다 -> 특정 클라이언트에 의존적인 필드가 있으면 안된다. 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다

 

상태를 유지할 경우 발생하는 문제점과 해결방안 

 

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


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

}

class StatefulServiceTest {
    @Test
    void statefulServiceSingleton(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

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

        //ThreadA : A사용자 주문 금액 조회
    //    int price = statefulService1.getPrice();
        System.out.println("price = "+ userAprice);

   //     Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);

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

}

 

5. @Configuration 과 싱글톤

memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다. 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.

orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다. 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.

각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것 처럼 보인다.

스프링 컨테이너는 이 문제를 어떻게 해결할까?

 

테스트 용도 추가하기 (테스트를 위해 MemberRepository를 조회할 수 있는 기능을 추가한다. 기능 검증을 위해 잠깐 사용하는 것이니 인터페이스에 조회기능까지 추가하지는 않기)

public class MemberServiceImpl implements MemberService {
 private final MemberRepository memberRepository;
 //테스트 용도
 public MemberRepository getMemberRepository() {
 return memberRepository;
 }
}
public class OrderServiceImpl implements OrderService {
 private final MemberRepository memberRepository;
 //테스트 용도
 public MemberRepository getMemberRepository() {
 return memberRepository;
 }
}

 

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

        MemberSeriviceImpl memberService = ac.getBean("memberService", MemberSeriviceImpl.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);
        System.out.println("orderService -> memberRepository = "+ memberRepository2);
        System.out.println("memberRepository = " + memberRepository);
//memberService -> memberRepository = hello.core.member.MemoryMemberRepository@710b18a6
//orderService -> memberRepository = hello.core.member.MemoryMemberRepository@710b18a6
// memberRepository = hello.core.member.MemoryMemberRepository@710b18a6

        Assertions.assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        Assertions.assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);

    }
}

 

 

 

 

6. @Configuration 과 바이트코드 조작의 마법

스프링 컨테이너는 싱글톤 레지스트리 -> 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.

자바 코드를 보면 분명 3번 호출되어야 하는 것이 맞다.

그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

모든 비밀은 @Configuration 을 적용한 AppConfig 에 있다

@Test
void configurationDeep() {
 ApplicationContext ac = new
AnnotationConfigApplicationContext(AppConfig.class);
 //AppConfig도 스프링 빈으로 등록된다.
 AppConfig bean = ac.getBean(AppConfig.class);
 
 System.out.println("bean = " + bean.getClass());
 //출력: bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70
}

AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보자.

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

 

순수한 클래스라면 다음과 같이 출력되어야 한다. class hello.core.AppConfig

 

이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다

 

AppConfig@CGLIB 예상 코드

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