Spring - 싱글톤 컨테이너

- 웹 어플리케이션과 싱글톤

 

1. 스프링은 온라인 서비스 기술을 지원하기 위해 탄생했다.

2. 대부분 스프링 어플리케이션은 웹 애플리케이션이다.

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

        assertThat(memberService1).isNotSameAs(memberService2);
    }

- 위의 경우 new AppConfig();가 2번 실행되기 때문에 memberService1과 memberService2가 서로 다른 객체인 것을 알 수 있다.

- 위와 같이 Appconfig에 memberService 요청이 많아질 경우 메모리 낭비가 심해진다.

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

---

- 싱글톤 패턴

 

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

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

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

public class SingletonService {

    private static final SingletonTest instance = new SingletonTest();

    public static SingletonTest getInstance() {
        return instance;
    }

    private SingletonService() {

    }

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

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

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

- 외부에서 new로 생성되는 것을 막기 위해 생성자를 private로 막는다.

 

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

        System.out.println("singletonTest1 = " + singletonTest1);
        System.out.println("singletonTest1 = " + singletonTest2);

        assertThat(singletonTest1).isSameAs(singletonTest2);
        //same == 객체 인스턴스를 자체를 넣는다.
        //equal == java equals
    }

- 같은 객체를 반환하는 것을 볼 수 있다.

---

- 싱글톤 패턴 문제점

 

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

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

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

4. 테스트하기 어렵다.

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

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

7. 결론적으로 유연성이 떨어진다.

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

---

- 싱글톤 컨테이너

 

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

2. 지금까지 사용한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

3. 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.

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

@Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {

//        AppConfig appConfig = new AppConfig();
        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);
    }
}

- memberService1, 2의 인스턴스 객체가 동일한 객체인 것을 확인할 수 있다.

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

---

- 싱글톤 방식의 주의점

 

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

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

   1. 특정 클라이언트에 의존적인 필드가 있으면 안된다.

   2. 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.

   3. 가급적 읽기만 가능해야 한다.

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

3. 스프링 빈의 필드에 공유 값을 설정하면 큰 장애가 발생할 수 있다.

 

- 상태를 유지할 경우 발생하는 문제점

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

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 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price = " + userAPrice);

        ssertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

    static class TestConfig {

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

- 위의 코드를 실행하게 되면 10000원이 조회되어야 하는데 싱글톤에 의해 20000원이 출력되는 것을 볼 수 있다.

---

@Configuration
public class AppConfig {

    //@Bean memberService -> new MemoryMemberRepository()
    //@Bean orderService -> new MemoryMemberRepository()

    @Bean
    public MemberService memberService() {
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemoryMemberRepository memberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        System.out.println("call AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

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

- 위 AppConfig 코드를 보면 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);
        System.out.println("orderService -> memberRepository = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);

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

(getMemberRepository()는 각 클래스의 인스턴스 memberRepository 변수를 가져오기 위한 임의의 메서드이다.)

- 위 코드를 실행해보면 전부 같은 객체를 가져오는 것을 확인 할 수 있다.

 

- @Configuration 어노테이션이 붙게 되면 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한다.

- 해당 어노테이션 때문에 스프링에서 자동으로 이전에 만들어진 객체가 있다면 알아서 해당 객체를 사용하도록 만들어 준다. 즉, 싱글톤 패턴이 적용된다.

 

 

 

 

 

 

출처 : 인프런 - 우아한 형제들 기술이사 김영한의 스프링 완전 정복 (스프링 핵심원리 - 기본 편)