[스프링 핵심 원리 - 기본편] week11

스프링 핵심 원리 - 기본편
https://www.inflearn.com/course/스프링-핵심-원리-기본편/dashboard

섹션 5. 싱글톤 컨테이너

1. 웹 애플리케이션과 싱글톤
2. 싱글톤 패턴
3. 싱글톤 컨테이너
4. 싱글톤 방식의 주의점
5. @Configuration과 싱글톤
6. @Configuration과 바이트코드 조작의 마법

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

• 스프링은 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
• 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. 물론 웹이 아닌 애플리케이션 개발도 얼마든지 개발할 수 있다.
• 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

스프링 없는 순수한 DI 컨테이너 테스트

• test/java/hello.core : singleton - package 생성
• test/java/hello.core/singleton : SingletonTest.java 생성

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

    }
}

• 우리가 만들었던 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다: 메모리 낭비가 심하다. 실제로 초당 50,000개도 나온다.
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다: 싱글톤 패턴

5.2 싱글톤 패턴

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

싱글톤 패턴을 적용한 예제 코드

• main이 아닌 test 위치에 생성한다. (앞에서 만든 파일에 영향이 가지 않게 test 파일에 만든다.)
• test/java/hello.core/singleton : SingletonService.java 생성

package hello.core.singleton;

public class SingletonService {

    // 1. static 영역에 딱 1개만 생성해둔다.
    // 자기 자신을 static으로 갖고 있음. class level에 올라가므로 딱 한 개만 존재.
    // 실행시 자기 자신을 new로 생성해서 instance에 넣어둠.
    private static final SingletonService instance = new SingletonService();


    // 2. public으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 허용한다.
    // getInstance를 통해서만 조회 가능 (instance만 반환)
    public static SingletonService getInstance() {
        return instance;
    }


    // 3. 생성자를 private으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    // new로 SingletonService가 외부에서 계속 생성되는 것을 막기 위해 private 생성자 사용.
    // 이제 외부에서 생성 불가
    private SingletonService() {

    }


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

}

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

외부에서 생성시 오류 확인

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

• SingletonTest.java에 작성

테스트 성공: 1176dcec이라는 singletonService를 사용하는 것을 알 수 있음

@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);
    // isSameAs: ==비교
    // isEqualTo: 자바의 equals 비교
}

• private으로 new 키워드를 막아두었다.
• 호출할 때마다 같은 객체 인스턴스를 반환하는 것을 확인할 수 있다.
• (참고) 싱글톤 패턴을 구현하는 방법은 여러가지가 있다. 여기서는 객체를 미리 생성해두는 가장 단순하고 안전한 방법을 선택했다.
• 싱글톤 패턴을 적용하면 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있다.하지만 싱글톤 패턴은 다음과 같은 수 많은 문제점들을 가지고 있다.

싱글톤 패턴 문제점

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

private static final SingletonService instance = new SingletonService();

public static SingletonService getInstance() {
    return instance;
}

private SingletonService() {
}

• 의존관계상 클라이언트가 구체 클래스에 의존한다. => DIP 위반
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
• 테스트하기 어렵다. 싱글톤은 인스턴스를 미리 받아 설정이 끝난 상태이므로 유연하게 테스트하기가 어려움.
• 내부 속성을 변경하거나 초기화하기 어렵다.
• private 생성자로 자식 클래스를 만들기 어렵다.
• 결론적으로 유연성이 떨어진다.
• 안티패턴으로 불리기도 한다.

5.3 싱글톤 컨테이너

• 스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다.
• 지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

싱글톤 컨테이너

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

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

• SingletonTest.java에 작성

테스트 성공: 같은 객체 인스턴스 반환 (4b7dc788)

    @Test
    @DisplayName("스프링 컨테이어놔 싱글톤")
    void singletonContainer() {
//        AppConfig appConfig = new AppConfig();    // springX
        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);

        Assertions.assertThat(memberService1).isSameAs(memberService2);

    }

싱글톤 컨테이너 적용 후

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

5.4 싱글톤 방식의 주의점

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

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

• test/java/hello.core/singleton : StatefulService.java 생성
• test 파일에 생성

package hello.core.singleton;

public class StatefulService {
        // cmd + shift + t: 테스트 만들기 (create new test)

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

• (단축키) cmd + shift + t : 테스트 만들기 (create new test)

테스트 코드

• test/java/hello.core/singleton : StatefulServiceTest.java

package hello.core.singleton;

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

import static org.junit.jupiter.api.Assertions.*;

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사용자 10000원 주문
        statefulService2.order("userB", 20000);

        //ThreadA: A사용자 주문 금액 조회
        int price = statefulService1.getPrice();    //statefulService1을 썼지만 userB가 설정한 20000원이 나옴(공유자원)
        System.out.println("price = " + price);

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

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

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

• 다음과 같이 코드를 수정해서 문제를 해결할 수 있다.

// 변경 전
public void order(String name, int price) {
    System.out.println("name = " + name + " price = " + price);
    this.price = price;     // 여기가 문제!!
}

// 변경 후, 무상태로 설계
public int order(String name, int price) {
    System.out.println("name = " + name + " price = " + price);
    return price;	// price 값을 반환    // 각각 userAPrice, userBPrice 등(지역변수)으로 받으면 됨
}

5.5 @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()를 호출한다.
  • 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.
  • @Bean memberService -> new MemoryMemberRepository()
• orderService 빈을 만드는 코드도 동일하게 memberRepository()를 호출한다.
  • 이 메서드를 호출하면 new MemoryMemberRepository()를 호출한다.
  • @Bean orderService -> new MemoryMemberRepository()
• 결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보인다.
• 스프링 컨테이너는 이 문제를 어떻게 해결할까? - 직접 테스트 해보자.

검증 용도의 코드 추가

• MemberServiceImpl과 OrderServiceImpl에서 memberRepository 확인
• MemberServiceImpl.java와 OrderServiceImpl.java에 다음 코드 추가

//테스트 용도
public MemberRepository getMemberRepository() {
    return memberRepository;
}

• 테스트를 위해 MemberRepository를 조회할 수 있는 기능을 추가한다. 기능 검증을 위해 잠깐 사용하는 것이니 인터페이스에 조회 기능까지 추가하지는 않는다.

테스트 코드

• test/java/hello.core/singleton : ConfigurationSingletonTest.java 생성

같은 객체 인스턴스를 반환한다. (@35399441)

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

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

• 확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
• AppConfig의 자바 코드를 보면 분명히 각각 2번(memberRepository까지 3번) new MemoryMemberRepository 호출해서 다른 인스턴스가 생성되어야 한다?
  • 두 번 호출이 안되는 것인가. 실험을 통해 알아본다.

AppConfig에 호출 로그 남김

• AppConfig.java의 memberService(), memberRepository(), orderService()에 각각 soutm을 추가하여 출력을 통해 호출을 확인한다.

@Bean   // 스프링 컨테이너에 등록됨
public MemberService memberService() {
    System.out.println("call AppConfig.memberService");  //soutm 추가
    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());
}

//빈 등록 시 출력 예상 (메서드 순서(1.~3.)는 보장하지 않음)
//1. memberService
//call AppConfig.memberService
//(memberRepository 호출) call AppConfig.memberRepository --(1)
//2. memberRepository
//call AppConfig.memberRepository --(2)
//3. orderService
//call AppConfig.orderService
//(memberRepository 호출) call AppConfig.memberRepository --(3)
//=>최종적으로 memberRepository가 3번 호출되어야 함 ((1)~(3))

//실제 실행 결과:
//call AppConfig.memberService
//call AppConfig.memberRepository
//call AppConfig.orderService
//=> memberRepository는 1번만 호출됨 (스프링이 싱글톤을 보장해줌)

• 스프링 컨테이너가 각각 @Bean을 호출해서 스프링 빈을 생성한다. 그래서 memberRepository()는 다음과 같이 총 3번이 호출되어야 하는 것 아닌가?
  1. 스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean이 붙어있는 memberRepository() 호출
     • call AppConfig.memberRepository --(1)
  2. memberService() 로직에서 memberRepository() 호출
     • call AppConfig.memberService
     • (memberRepository 호출) call AppConfig.memberRepository --(2)
  3. orderService() 로직에서 memberRepository() 호출
     • call AppConfig.orderService
     • (memberRepository 호출) call AppConfig.memberRepository --(3)
•  
• 그런데 출력 결과는 모두 1번만 호출한다.

call AppConfig.memberService가 한 번만 찍힘

• 스프링이 싱글톤을 보장해준다.

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

• 스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다. 저 자바 코드를 보면 분명 3번 호출되어야 하는 것이 맞다. 그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.
• 모든 비밀은 @Configuration을 적용한 AppConfig에 있다.

코드

• ConfigurationSingletonTest.java에 다음 Test 추가

@Test
void configurationDeep() {
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
    AppConfig bean = ac.getBean(AppConfig.class);

    System.out.println("bean = " + bean.getClass());
}

• 사실 AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래서 AppConfig도 스프링 빈이 된다.
• AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보자.

• 순수한 클래스라면 다음과 같이 출력되어야 한다.

class hello.core.AppConfig

• 그러나 실제 출력된 결과는 다음과 같다.

bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$d7177c49

• 예상과는 다르게 클래스 명에 xxxCGLIB가 붙으면서 상당히 복잡해진 것을 볼 수 있다. 이것은 내가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

그림

• 그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다. 아마도 다음과 같이 바이트 코드를 조작해서 작성되어 있을 것이다. 실제로는 CGLIB의 내부 기술을 사용하는데 매우 복잡하다.
• AppConfig를 상속 받은 AppConfig@CGLIB을 만든다.

AppConfig@CGLIB 예상 코드

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

• @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
• 덕분에 싱글톤이 보장되는 것이다.
• (참고) AppConfig@CGIB는 AppConfig의 자식 타입이므로, AppConfig 타입으로 조회할 수 있다.

@Configuration을 적용하지 않고, @Bean만 적용하면 어떻게 될까?

• @Configuration을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약 @Bean만 적용하면 어떻게 될까?

@Configuration 제거 후 configurationDeep() test 실행

• 출력 결과를 통해서 AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.

bean = class hello.core.AppConfig

• 이 출력 결과를 통해서 MemberRepository가 총 3번 호출된 것을 알 수 있다. 1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서이고, 2번은 각각 memberRepository()를 호출하면서 발생한 코드다.

call AppConfig.memberService
call AppConfig.memberRepository
call AppConfig.memberRepository
call AppConfig.orderService
call AppConfig.memberRepository

• @Configuration이 없으면 싱글톤을 보장하지 않는다.

인스턴스가 같은지 테스트 결과

@Configuration 없이 configurationTest() 실행 후 출력 확인

memberService -> memberRepository = hello.core.member.MemoryMemberRepository@6b09fb41
orderService -> memberRepository = hello.core.member.MemoryMemberRepository@624ea235
memberRepository = hello.core.member.MemoryMemberRepository@3932c79a

• 당연히 인스턴스가 같은지 테스트하는 코드도 실패하고, 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있다.
• 확인이 끝났으면 다시 @Configuration이 동작하도록 돌려놓는다.

정리

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

FIN.