싱글톤

웹 애플리케이션과 싱글톤

클라이언트 A,B,C가 동시에 같은 요청을 하면 스프링 없는 순수 DI 컨테이너는 객체를 3개를 생성한다.

public class SingletonTest {
    @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);
    }
}

실행결과

싱글톤 패턴

클래스의 인스턴스가 1개만 생성되는 것을 보장하는 디자인 패턴이다. private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.
자바가 뜰 때 내부적으로 자기 자신을 참조해서 instance에 넣어둔다.

public class SingletonService {
    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance() {
        return instance;
    }
    private SingletonService(){
    }
}

static 영역에 객체 instance를 미리 하나 생성해서 올려둔다. 이 객체 인스턴스가 필요하면 오직 getInstance()를 통해서 조회할 수 있다. 이 메서드를 호출하면 항사 같은 인스턴스를 반환한다. 하나의 객체 인스턴스만 존재해야 하므로 생성자를 private로 설정해서 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다. 자바가 뜰 때 생성해둔 객체를 가져다 쓰는 것이다.

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonServiceTest() {
    SingletonService singletonService1 = SingletonService.getInstance();
    SingletonService singletonService2 = SingletonService.getInstance();
    System.out.println("singletonService1 = " + singletonService1);
    System.out.println("singletonService2 = " + singletonService2);
}

스프링 컨테이너가 객체를 싱글톤으로 설정해서 관리해준다.

싱글톤 패턴의 문제점

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

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서 객체 인스턴스를 싱글톤으로 관리한다. 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다. 스프링 컨테이너의 이런 기능이 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다. 싱글톤 패턴의 지저분한 코드가 들어가지 않아도 되고 DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있다.

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer(){
    AnnotationConfigApplicationContext 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 등을 사용해야 한다.
• 스프링 빈의 필드에 공유되는 값을 설정하면 큰 장애가 발생할 수 있다.

클라이언트가 필드 값을 변경할 수 있는 코드

class StatefulServiceTest {
    @Test
    void statefulServiceSingleton(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(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(20000);

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

}

사용자A가 조회한 값이 10000원이 나와야 하지만 결과값이 20000원이 나왔다.

값을 그대로 반환하도록 변경한 코드

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

class StatefulServiceTest {
    @Test
    void statefulServiceSingleton(){
        AnnotationConfigApplicationContext 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 주문 금액 조회
        System.out.println("price = "+userAPrice);
    }
}

@Configuration과 싱글톤

AppConfig에서 memberService()를 호출하면 new MemoryMemberRepository()를 호출하고, orderService()를 호출하면 new MemoryMemberRepository()를 호출해서 'new MemoryMemberRepository()'를 2번 호출하게 된다. 그럼 이때 싱글톤이 깨지는 것이 아닌가에 대한 의문을 가질 수 있다.

public class ConfigurationSingleton {
    @Test
    void configurationTest(){
        AnnotationConfigApplicationContext 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 -> memberRepository1 = " + memberRepository1);
        System.out.println("memberService -> memberRepository2 = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);
        
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository1);
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository2);
    }
}

AppConfig 메서드의 예상 호출 순서

//예상 호출 순서
//call AppConfig.memberService
//call AppConfig.memberRepository
//call AppConfig.memberRepository
//call AppConfig.orderService
//call AppConfig.memberRepository

AppConfig 메서드의 실제 호출 순서

//실제 호출 순서
//call AppConfig.memberService
//call AppConfig.memberRepository
//call AppConfig.orderService

@Configuration과 바이트코드 조작

스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들로 그 다른 클래스를 스프링 빈으로 등록한 것이다. 임의의 다른 클래스가 싱글톤이 보장되도록 해준다.
memberRepository가 두번째 실행 될 때 오버라이드 된 AppConfig@CGLIB가 실행된다. 즉, 이미 스프링 컨테이너에 등록되어 있다면 그 빈 객체를 꺼내준다. @Configuration을 사용하지 않고 @Bean만 적용하면 각자 다른 인스턴스를 갖게 되어 싱글톤이 깨진다. @Bean만 사용해도 스프링 빈으로 등록되지만 싱글톤은 불가능하다.

@Test
void configurationDeep(){
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
    AppConfig bean = ac.getBean(AppConfig.class);
    System.out.println("bean = " + bean.getClass());
}

bean = class hello0703.core.AppConfig$$EnhancerBySpringCGLIB$$9e0e1c18