Chapter 05. 싱글톤 컨테이너

Spring Framework/[인프런] Spring 핵심 원리

Chapter 05. 싱글톤 컨테이너

계란💕 2022. 8. 14. 01:55

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

웹 애플리케이션과 싱글톤

스프링은 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
대부분 스프링 애플리케이션은 웹 애플리케이션이다.
웹 애플리케이션은 보통 여러 고객이 동시에 요청한다.
- 요청이 올 때마다 수많은 객체를 만들 수 있을까?

Ex) 스프링 없는 순자 자바 DI 컨테이너

<hide/>
package hello.core.singletone;
import hello.core.AppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
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);
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }
}

- 1번, 2번이 각각 다르게 생성된다.

- 이러면 객체가 너무 많이 생성되는 문제가 있다. => 메모리 낭비가 심하다.

Note) 실행 결과

- 순수한 DI 컨테이너인 AppConfig는 요청할 때마다 객체를 생성한다.

- 객체를 하나만 만들어서 공유하면 해결할 수 있다.

5.2 싱글톤 패턴(Singleton Pattern)

싱글톤 패턴

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

Ex) 싱글톤 패턴

<hide/>
package hello.core.singletone;
public class SingletonService {

    // 참조 - 자기 자신을 딱하나 생성
   private static  final SingletonService instance = new SingletonService();

   // 조회 - 인스턴스 조회하는 유일한 방법
    public static  SingletonService getInstance(){
        return instance;
    }
    private SingletonService(){
    }
    public void logic(){
        System.out.println("싱글톤 객체 로직 호출");
    }
}

- 자기 자신을 내부에 "private final static"으로 딱 하나만 선언한다. (그러면, 클래스에 딱 하나만 만들어진다.)

- getInstance(): 인스턴스의 참조를 꺼내는 방법은 딱 하나 뿐이다. 항상 같은 인스턴스를 반환한다.

- private 생성자를 쓴다. => 딱 1개의 객체 인스턴스만 존재하므로 생성자를 private로 막아서 외부 클래스에서 new 키워드로 인스턴스가 생성되는 걸 막는다.

cf) private static final이라고 변수를 선언하면 재할당하지 못하고 메모리에 한번 올라가면 같은 값을 클래스 내부의 전체 필드, 메서드에서 공유한다.

Ex) 싱글톤 패턴을 사용한 객체 사용 - 실패

- 위에서 private로 막아놨기 때문이다.

<hide/>
  @Test
   @DisplayName("싱글톤 패턴을 적용한 객체 사용")
   void singletonServiceTest(){
        new SingletonService();
   }

Note) 실행 결과 - private라서 접근을 못한다고 오류가 난다.

Ex) 싱글톤 패턴을 사용한 객체 사용 - 성공

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

Note) 실행 결과

- 같은 객체 인스턴스가 반환된다.

cf) 'same'과 'equal'의 차이는?

- isSameAs(): '==', 참조어를 비교한다.

- isEquals(): 자바의 equals

싱글톤 패턴의 문제점은?

싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
의존 관계상 클라이언트가 구체 클래스에 의존한다. => 'DIP' 위반한다.
클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
싱글톤은 테스트하기 어렵다.
내부 속성을 변경하거나 초기화하기 어렵다.
private 생성자라서 자식 클래스를 만들기 어렵다.
유연성이 떨어진다. dependency injection을 적용하기 어렵다.
'안티패턴'이라고도 불린다.

5.3. 싱글톤 컨테이너

싱글톤 컨테이너

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

Ex) 스프링 컨테이너와 싱글톤

<hide/>
   @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);
   }

Note) 실행 결과

- 참조값이 같다.

싱글톤 컨테이너 적용 후

고객의 요청이 올 때마다 만들지 않고 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다.

cf) 스프링의 기본 빈 등록 방식은 싱글톤이지만 다른 방식도 지원한다. 요청할 때마다 새로운 객체를 생성해서 반환하는 기능도 제공한다.

- 스프링에서는 대부분 싱글톤 방식이다.

5.4 싱글톤 방식의 주의점

싱글톤 방식의 주의점

싱글톤 패턴이든 스프링 같은 싱글톤 컨테이너를 사용하든 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하도록 설계하면 안된다.
스프링 빈은 항상 무상태(stateless)로 설계해야한다.
- 특정 클라이언트에 의존전인 필드가 있으며 안된다.
- 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
- 가급적 읽기만 가능해야한다. 수정하지 않도록 한다.
- 방법: 필드 대신에 공유되지 않는 변수, 지역 변수, 파라미터, ThreadLocal 등을 사용해야한다
(스프링) 싱글톤 빈의 필드에 공유 값을 설정하면 장애가 발생할 수 있다.

Ex) 싱글톤 주의 사항

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

        // ThreadA: A사용자 만 원 주문
        statefulService1.order("userA", 10000);

        // ThreadB: B사용자 2만 원 주문
        statefulService2.order("userB", 20000);

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

- StatusServiceTest 클래스를 만든 다음에 테스트한다.

Note) 실행 결과

- 예상과 다르게 A의 주문 금액(10000)과 B의 주문금액(20000)이 동일하다고 나온다.

- 이유는? StatefulService의 공유 필드 price 때문이다.

-> 따라서, StatefulService클래스를 수정한다. 전역 변수 price를 없애고 매개변수로 price로 넣는다.

<hide/>
package hello.core.singletone;
public class StatefulService {
//   제거  private int price;  // 상태를 유지하는 필드
    // 주문해서 값을 저장한다.
    public int order(String name, int price){
        System.out.println("neme = " + name + " price = " +price);
//   제거     this.price = price;
        return price;
    }

// 제거   public int getPrice(){
//        return price;
//    }
}

- 수정된 테스트 클래스

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

        // ThreadA: A사용자 만 원 주문
        int userAPrice = statefulService1.order("userA", 10000);

        // ThreadB: B사용자 2만 원 주문
        int userBPrice = statefulService2.order("userB", 20000);

        // ThreadA: A사용자 주문 금액 조회
//       int price = statefulService1.();
        System.out.println("price = " + userAPrice);
//        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

Note) 실행 결과

- 이번에는 지역변수 price가 공유되지 않기 때문에 정상 작동한다.

5.5 @Configuration과 싱글톤

Configuration과 싱글톤

- @Configuration은 싱글톤을 위해 존재한다.

<hide/>
package hello.core;
import hello.core.discount.DiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@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();
    }
}

AppConfig 코드의 memberService빈을 만드는 코드를 보면 memberRepository()를 호출한다
memberRepository()는 MemoryMemberRepository()를 호출한다.
orderService()의 코드도 memberRepository()를 호출한다.
결국, memberService()와 orderService()는 둘다 MemoryMemberRepository()를 호출한다.
그러면 2개의 MemoryMemberRepository()가 생성되면서 싱글톤이 깨질까?
- 스프링 컨테이너는 이를 어떻게 해결할까?

Ex) 검증 용도의 코드를 추가한다.

- MemberServiceImpl 클래스에 다음 과 같이 코드를 추가한다.

<hide/>
package hello.core.member;
public class MemberServiceImpl implements  MemberService{

    private final MemberRepository memberRepository;
        
    // 추가
    public  MemberRepository getMemberRepository(){
        return  memberRepository;
    }
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

- OrderServiceImpl 클래스에도 추가한다.

<hide/>
package hello.core.order;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Member;
import hello.core.member.MemberRepository;
public class OrderServiceImpl implements  OrderService{

    private final MemberRepository memberRepository;    // = new MemoryMemberRepository();
    private final DiscountPolicy discountPolicy;    // = new RateDiscountPolicy();
    
    // 추가
    public MemberRepository getMemberRepository(){
        return memberRepository;
    }

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
            Member member = memberRepository.findById(memberId);    // 회원정보를 조회한다.
            int discountPrice = discountPolicy.discount(member, itemPrice); // 최종적으로 할인된 금액
            return new Order(memberId, itemName, itemPrice, discountPrice);
    }
}

- 테스트 클래스를 만든다.

<hide/>
package hello.core.singletone;
import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.Assertions.assertThat;

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

Note) 실행 결과

- 세 개의 스프링 빈이 다르지 않을까 생각했지만 세 개의 스프링 빈이 모두 같은 걸 알 수 있다.

- memberRepository인스턴스는 모두 인스턴스가 공유되어 사용된다.

Ex) AppConfig 에 호출 로그를 남겨서 위 예제의 원리를 알아보자.

<hide/>
package hello.core;
import hello.core.discount.DiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class AppConfig {

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

    @Bean
    public MemberRepository 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 RateDiscountPolicy();
    }
}

<hide/>    
[예상 호출 순서]
// call AppConfig.memberService
// call AppConfig.memberRepository
// call AppConfig.memberRepository
// call AppConfig.orderService
// call AppConfig.memberRepository

[실행 결과]
// call AppConfig.memberService
// call AppConfig.memberRepository
// call AppConfig.orderService

Note) 실행 결과

- 예상과 다르게 call이 세 번만 출력된다.

- 멤버리포짓은 세 번이 아니라 왜 한 번만 호출됐을까?

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

- 스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해줘야한다.

Ex) 앞서 예제에서 call이 세 번만 호출된 이유는?

- AppConfig에 비밀이 있다.

- 테스트 하나 더 만든다.

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

Note) 실행 결과

- 출력 결과를 보면 클래스명 AppConfig 뒤에 뭔가 다른 값들이 따라 붙는 것들이 보인다.

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

- 따라서, 이름은 AppConfig인데 인스턴스 객체가 AppConfig@CGLIB인 데이터가 들어가 있는 것이다.

-> 임의의 클래스가 바로 싱글톤이 보장되도록 해준다. 아래와 같이 바이트 코드를 조작해서 작성되어 있을 것이다. 실제로는 훨씬 복잡하다.

memberRepository()를 오버라이드했을 것이다. 실제로는 오버라이드 된 위의 메서드가 호출되는 것이다.
@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 빈을 반환하고 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
그래서, 싱글톤이 보장되는 것이다.

Ex) @Configuration이 아니라 @Bean만 적용하면 그래도 싱글톤을 보장할까?

- ConfigurationDeep()를 실행한다.

- AppConfig의 @Configuration을 주석처리하고나서 테스트를 실행한다.

- AnnotationConfigApplicationContext(AppConfig.class)의 매개 변수인 AppConfig는 스프링 빈으로 등록된다.

- 그리고 AppConfig의 네 가지도 빈으로 모두 등록된다. 그런데 문제는?

Note) 실행 결과

- 순수한 AppConfig 가 그대로 출력된다.

- 그런데, 문제는? 멤버 리포지토리가 3번 호출된다. 즉, 다른 싱글톤이 깨진 것이다.

-> 첫 번째는 @Bean에 의해 스프링 컨테이너에 등록하기 위해서 호출 두 번째, 세 번째는 둘다 memberRepository()를 호출하면서 발생한 코드

- 순수한 자바 코드가 들어간다. (CGLIB이 출력되지 않는다.)

cf) 기존의 테스트 돌리면

- memberService가 호출하는 memberRepository와 orderService가 호출하는 memberRepository, 새로 호출 되는 memberRepository 이 세 가지가 모두 완전히 다르다.

- Impl에 있는 멤버변수 memberRepository는 스프링 빈이 아니다. 스프링 컨테이너가 관리하지 않는다.

Note)

@Bean 만으로도 스프링 빈으로 등록이 되지만 싱글톤을 보장하지는 않는다.
memberRepository()처럼 의존 관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.
스프링 설정 정보는 항상 @Configuration를 넣어서 자동으로 싱글톤을 보장하도록한다.

출처 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/dashboard

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

스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...

www.inflearn.com

저작자표시

'Spring Framework > [인프런] Spring 핵심 원리' 카테고리의 다른 글

Chapter 07. 의존 관계 자동 주입 (0)	2022.08.15
Chapter 06. 컴포넌트 스캔(@ComponentScan) (0)	2022.08.14
Chapter 04. 스프링 컨테이너와 스프링 빈 (0)	2022.08.12
Chapter 03. 스프링 핵심 원리 이해2 - 객체 지향 원리 적용 (0)	2022.08.12
Chapter 02. 스프링 핵심 원리 이해1 - 예제 만들기 (0)	2022.08.11

현재글Chapter 05. 싱글톤 컨테이너

Backend Developer lan4250@naver.com https://github.com/goraneee

데이터베이스, 백준, Queue, 알고리즘, 제로베이스 백엔드, BFS, JPA, 스프링, Stack, SQL, dfs, Java, GIT, 코드업, 제로베이스 스쿨, 자바, DB, 프로그래머스, mysql, dp,

Today :
Yesterday :

일	월	화	수	목	금	토
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29	30	31

계란 블로그