Program Artist를 꿈꾸는 Blog

테스트 코드 추가

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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 -> memberRepository1 = " + memberRepository1);
        System.out.println("orderService -> memberRepository2 = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);

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

• 실행 결과 세 개의 객체는 동일함
• 확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용

AppConfig 수정(디버그)

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
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 FixDiscountPolicy();
        return new RateDiscountPolicy();
    }
}

• memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다.
  • 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
• orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다.
  • 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
• AppConfig의 자바 코드를 보면 각각 2번 new MemoryMemberRepository를 호출해서 다른 인스턴스가 생성되는 것으로 보인다
  • 결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것 처럼 보임
• 디버그를 위해 각 메소드 호출 시 출력문 추가

테스트 실행 결과

// 출력 결과
call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.orderService

• memberRepository() 메소드가 단 한 번만 실행됨
• 스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성한다. 그래서 memberRepository() 는 다음과 같이 총 3번이 호출되어야 하는 것으로 보인다.
  • 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean이 붙어있는 memberRepository() 호출
  • memberService() 로직에서 memberRepository() 호출
  • orderService() 로직에서 memberRepository() 호출
• 그런데 출력 결과는 모두 1번만 호출된다.
• 어떻게 이런 결과가 나온 것인지는 다음 강의에서 알아본다.

※ 본 게시글은 인프런의 스프링 핵심 원리 - 기본편(김영한)을 수강하고 정리한 내용입니다.

싱글톤 방식의 주의점

• 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안됨
• 무상태(stateless)로 설계해야 함
  • 특정 클라이언트에 의존적인 필드가 있으면 안됨
  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안됨
  • 가급적 읽기만 가능해야 함
  • 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 함
• 스프링 빈의 필드에 공유 값을 설정하면 큰 장애가 발생할 수 있음

테스트 코드: StatefulService 클래스 생성

package hello.core.singleton;

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

• 테스트를 위한 클래스
• 단순하게 order를 통해 this.price를 할당
• 올바르게 고치기 위해서는 this.price = price 부분과 getPrice 메소드 로직을 없애고, order에서 바로 price를 리턴하면 Statless가 됨

테스트코드: StatefulServiceTest

package hello.core.singleton;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

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원 주문
        statefulService1.order("userA", 10000);

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

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

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

    }

    static class TestConfig {

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

}

• StatefulService 클래스에서 Ctrl + Shift + T로 테스트 클래스 생성 가능
• 최대한 단순히 설명하기 위해, 실제 쓰레드는 사용하지 않았다.
• ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.
• StatefulService의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
• 사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.
• 실무에서 이런 경우를 종종 보는데, 이로 인해 정말 해결하기 어려운 큰 문제들이 터진다.
  • 몇 년에 한번씩 만난다.
• 진짜 공유필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자.

※ 본 게시글은 인프런의 스프링 핵심 원리 - 기본편(김영한)을 수강하고 정리한 내용입니다.

스프링 컨테이너

• 싱글톤 패턴의 문제점을 해결하면서 객체 인스턴스를 싱글톤으로 관리
• 지금까지 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈

싱글톤 컨테이너

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

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

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

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

        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);

        // isSameAs : == 문법을 이용한 비교(인스턴스가 같은지 비교)
        // isEqual  : 자바의 equals() 메소드를 이용한 비교
        Assertions.assertThat(singletonService1).isSameAs(singletonService2);
    }

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

        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberService memberService1 = ac.getBean("memberService", MemberServiceImpl.class);
        MemberService memberService2 = ac.getBean("memberService", MemberServiceImpl.class);

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

        // memberService1 == memberService2
        Assertions.assertThat(memberService1).isSameAs(memberService2);
    }
}

• 스프링 컨테이너와 싱글톤 테스트 코드 추가
• MemberServiceImpl에서는 싱글톤과 관련된 코드가 있지 않음에도, 싱글톤으로 객체를 관리

싱글톤 컨테이너 적용 후

• 스프링 컨테이너로 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유
• 참고
  • 스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아님
    • 하지만 99.9%는 싱글톤을 사용함
  • 요청할 때마다 새로운 객체를 생성해서 반환하는 기능도 제공
  • 자세한 내용은 뒤에 빈 스코프에서 설명

※ 본 게시글은 인프런의 스프링 핵심 원리 - 기본편(김영한)을 수강하고 정리한 내용입니다.

싱글톤 패턴

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

싱글톤 패턴 코드

package hello.core.singleton;

public class SingletonService {

    private static final SingletonService instance = new SingletonService();

    public static SingletonService getInstance() {
        return instance;
    }

    private SingletonService() {
        // private 생성자. 외부에서 new 키워드를 통한 객체 생성을 막음(컴파일 오류)
    }

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

• static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
• 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회
  • 이 메서드를 호출하면 항상 같은 인스턴스를 반환
• 1개의 객체 인스턴스만 존재해야 함
  • 생성자를 private으로 막아서 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 방지

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

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
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);

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

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

        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);

        // isSameAs : == 문법을 이용한 비교(인스턴스가 같은지 비교)
        // isEqual  : 자바의 equals() 메소드를 이용한 비교
        Assertions.assertThat(singletonService1).isSameAs(singletonService2);
    }
}

• 이전에 만든 SingletonTest 코드에 “싱글톤 패턴을 적용한 객체 사용” 테스트 추가
• private으로 new 키워드를 막음
• 호출할 때마다 같은 객체 인스턴스를 반환하는 것을 확인 가능

싱글톤 패턴과 문제점

• 참고
  • 싱글톤 패턴을 구현하는 방법은 여러 가지가 있음
  • 여기서는 객체를 미리 생성해두는 가장 단순하고 안전한 방법을 선택했다.
    • 객체 인스턴스가 메모리를 많이 차지하는 것이 아니면 이 방법이 간단하고 안전함
  • 싱글톤 패턴을 적용하면 고객의 요청이 올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.
  • 하지만 싱글톤 패턴은 다음과 같은 수많은 문제점들을 가지고 있다.
• 싱글톤 패턴의 문제점
  • 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
  • 의존관계상 클라이언트가 구체 클래스에 의존한다. ⇒ DIP를 위반한다.
  • 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다. 테스트하기 어렵다.
  • 내부 속성을 변경하거나 초기화 하기 어렵다.
  • private 생성자로 자식 클래스를 만들기 어렵다.
  • 결론적으로 유연성이 떨어진다.
  • 안티패턴으로 불리기도 한다.

※ 본 게시글은 인프런의 스프링 핵심 원리 - 기본편(김영한)을 수강하고 정리한 내용입니다.