스프링 싱글톤

이번 포스팅에서는 싱글톤 패턴에 대해서 정리해보겠습니다.

 

싱글톤 

- 스프링은 기업용 온라인 서비스를 지원하기 위해서 탄생했습니다.

- 따라서 대부분의 스프링 애플리케이션은 웹 애플리케이션입니다

-> 이로 인해 동시에 여러 고객으로부터 요청을 받습니다.

위의 그림처럼 애플리케이션이 동작할 때

클라이언트의 요청에 따라 매번 새로운 객체를 생성해야 합니다.

    @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);

        assertThat(memberService1).isNotSameAs(memberService2);
    }

위의 코드는 스프링 컨테이너를 부르지 않고 AppConfig를 직접 실행시킨 경우입니다.

memberService1과 memberService2가 같지 않음을 알수 있고

이는 memberService를 호출할 때마다 새로운 객체가 만들어짐을 알 수 있습니다.

 

정말 작은 클라이언트의 요구를 수용하는 애플리케이션에서는 문제가 되지 않지만 스프링을 활용하는 대규모 애플리케이션에서 이런 방식은 메모리 낭비가 심하게 일어납니다.

 

이를 해결하기 위해서는

해당 객체를 딱 1개만 생성하고 공유해서 사용해야 합니다 -> 싱글톤 패턴

 

싱글톤 패턴

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

- 따라서 객체 인스턴스가 2개 이상 생성하지 못하도록 막아야 하는데

-> 생성자를 private으로 선언해 외부에서 new 키워드를 사용하지 못하도록 막아야 합니다.

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance(){
        return instance;
    }

    private SingletonService(){
    }

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

위의 코드를 보면 static을 이용해 인스턴스를 미리 생성해두고

인스턴스는 private로 다른 클래스에서 접근하지 못하도록 합니다.

@Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest(){
        SingletonService instance1 = SingletonService.getInstance();
        SingletonService instance2 = SingletonService.getInstance();

        System.out.println("instance1 = " + instance1);
        System.out.println("instance2 = " + instance2);

        assertThat(instance1).isSameAs(instance2);
    }

test결과가 성공하며 

출력되는 service도 같음을 알수 있습니다.

 

이런 방식으로 메모리를 아낄 수 있는 싱글톤 패턴을 이용할 수 있지만 문제점도 있습니다.

 

싱글톤 패턴의 문제점

- 싱글톤 패턴을 구현하기 위해서 코드가 추가적으로 필요합니다.

- 의존관계상 클라이언트가 구체 클래스에 의존하게 됩니다.

- 테스트하기가 어렵습니다.

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

- private생성자로 자식 클래스를 만들기 어렵습니다.

- 결론적으로 유연성이 떨어지게 됩니다.

 

싱글톤 컨테이너

- 스프링 컨테이너는 싱글톤 패턴의 문제를 해결하면서 객체 인스턴스를 싱글톤으로 관리합니다.

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

- 따라서 지저분한 코드가 들어가지 않고 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);
    }

위의 코드는 스프링 컨테이너를 활용해 memberService를 호출한 방법입니다.

테스트가 성공하고

memberServie가 같은 것을 확인할 수 있습니다.

그림과 같이 정리 할 수 있습니다.

 

싱글톤 방식의 주의점

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

- 즉 무상태로 설계해야 합니다.

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

-> 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안됩니다.

-> 가급적 읽기만 가능해야 합니다.

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

** 정말 주의해야 합니다!!

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

        statefulService1.order("userA",10000);
        statefulService2.order("userB",20000);

        int price = statefulService1.getPrice();
        System.out.println("price = " + price);
        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

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

클래스안에 TestConfig클래스를 만들고 @Bean을 이용하여 아까 만들어둔 클래스를 스프링 컨테이너에 등록합니다.

따라서 statefulService는 싱글톤 패턴이 됩니다.

 

그 후의 위에 test를 진행하면 어떻게 될까요??

test마지막쯤에 출력부분에서 제가 원하는 출력은 statefulService1의 price인 10000이 출력되기를 바라면서 test를 돌려보겠습니다.

테스트의 결과는 제 예상과는 다른 20000이 출력되었습니다.

즉 필드의 값이 공유되어 마지막에 statefulService2의 값이 statefulService1의 값에 영향을 준 것임을 알 수 있습니다.

따라서 공유필드에 대해서 신중하게 설계를 해야합니다.!!

 

@Configuration과 싱글톤

싱글톤 패턴과 스프링 컨테이너에 대해서 정리를 해봤습니다.

그런데 한가지 궁금한 점이 생겼습니다.

 

바로 AppConfig입니다.

@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService(){
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }


    @Bean
    public OrderService orderService(){
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }


    @Bean
    public DiscountPolicy discountPolicy(){
        return new RateDiscountPolicy();
    }
}

이 코드를 보시면

memberService빈을 만들때 memberRepository()를 호출하고

memberRepository()를 호출하면 new MemoryMemberRepository를 호출합니다.

 

마찬가지로

orderService를 호출하면 memberRepsitory를 호출하고 이에 따라

new MemoryMemberRepository가 호출됩니다.

 

이런 경우를 봤을 때 memberService와 orderService를 호출할 때 MemoryMemberService를 여러번 호출하게 되고

싱글톤 패턴이 깨지는 것처럼 보입니다. 과연 진짜로 깨지는 것일까요?

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

이런식으로 test를 위해서 각각 servieImpl에 본인을 찾는 메소드를 만듭니다.

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);
 
        //모두 같은 인스턴스를 참고하고 있다.
        System.out.println("memberService -> memberRepository = " + memberService.getMemberRepository());
        System.out.println("orderService -> memberRepository = " + orderService.getMemberRepository());
        System.out.println("memberRepository = " + memberRepository);
 
 //모두 같은 인스턴스를 참고하고 있다.
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository); 
        assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
    }
}

이제 test 코드를 실행시켜보면 신기한 일이 발생합니다.

여러번 호출될 줄 알았던 memberRepsitory가 모두 같은 memberRepository였습니다.

 

이제 어떻게 된일인지 한번 알아보겠습니다.

 

이 사건의 배경에는 @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

보면 뒤에 이상한 CGLIB라는게 붙어있는 것을 볼 수 있습니다.

 

결론부터 말하면 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 이용해 @Configuration이 붙어있는 AppConfig클래스를 상속받는 임의의 클래스를 만들고 그 클래스를 통해 스프링 빈이 싱글톤을 유지할 수 있었던 것입니다.

 

AppConfig@CGLIB예상 코드입니다.

@Bean
public MemberRepository memberRepository(){

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

이전 AppConfig에서는 무조건 new MemoryMemberRepository를 반환했지만

CLGIB라이브러리를 통해 AppConfig를 상속받은 AppConfig@CGLIB는 스프링 빈을 먼저 찾아보고 없을 경우 새로운 객체를 생성하게 됩니다.

 

-> 이 방법을 통해 싱글톤 패턴을 유지할 수 있는 것입니다.

 

출처

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/

스프링 핵심 원리 - 기본편 - 인프런 | 강의