[스프링 핵심 원리] 05. 싱글톤 컨테이너 - @Configuration과 싱글톤 & @Configuration과 바이트코드 조작의 마법

인프런) 김영한님의 스프링 핵심 원리-기본편을 공부하고 리뷰한 글입니다.

5. @Configuration과 싱글톤

1. AppConfig의 의문점

// 애플리케이션 설정(구성) 정보
@Configuration
public class AppConfig {
    // @Bean memberService -> new MemoryMemberRepository()
    // @Bean orderService -> new MemoryMemberRepository()
    // MemberService 역할 스프링 빈 등록
    @Bean
    public MemberService memberService() {
        System.out.println("call AppConfig.memberService");
        // 생성자 주입
        return new MemberServiceImpl(memberRepository());
    }

    // MemberRepository 역할 스프링 빈 등록
    @Bean
    public MemberRepository memberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();    // 메모리 회원 저장소로
    }

    // OrderService 역할 스프링 빈 등록
    @Bean
    public OrderService orderService() {
        System.out.println("call AppConfig.orderService");
        // 생성자 주입
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    ...
}

1) @Bean memberService 등록 -> memberRepository() -> new MemoryMemberRepository()

2) @Bean orderService 등록 -> memberRepository() -> new MemoryMemberRepository()

3) @Bean memberRepository 등록 -> new MemoryMemberRepository()

자바 코드로 보면 new MemoryMemberRepository() 가 3번 호출되면서 싱글톤이 깨지는 것 처럼 보인다.

분명히 스프링 컨테이너는 싱글톤 방식으로 객체 인스턴스를 관리한다고 했는데, 실제도 그러한지 아래 테스트 코드를 통해 확인해보자.

 

2. 검증 용도의 코드 추가 (MemberServiceImpl, OrderServiceImpl)

테스트를 위해 MemberRepository를 조회할 수 있는 기능을 추가한다. (단순히 기능 검증을 위해 추가하는 코드로 인터페이스에 메서드를 추가할 필요는 없다.)

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

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

 

3. 테스트 코드

1) ConfigurationSingletonTest 코드 작성

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.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

public class ConfigurationSingletonTest {

    @Test
    void configurationTest() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        // getMemberRepository() 메서드 호출을 위해 구체타입으로 꺼냄(구체 타입으로 꺼내는 건 좋지X)
        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);

        // memberRepository가 모두 같은 인스턴스인지 검증
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
    }
}

 

2) 결과

위 그림과 같이 memberService, orderService, memberService의 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다. 분명 자바 코드 상으로는 new가 3번이나 되어야하는데, 호출이 안된 것인지 아래 코드로 확인해보자.

 

4. AppConfig에 호출 로그 남김

1) AppConfig 로그 추가

memberService(), orderService(), memberRepository() 메서드가 호출될 때마다 로그를 남기도록 한다.
우리가 생각했던대로 memberRepository()가 3번 호출되는지 확인해본다.

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 memberService -> new MemoryMemberRepository()
    // @Bean orderService -> new MemoryMemberRepository()
    // MemberService 역할 스프링 빈 등록
    @Bean
    public MemberService memberService() {
        System.out.println("call AppConfig.memberService");
        // 생성자 주입
        return new MemberServiceImpl(memberRepository());
    }

    // MemberRepository 역할 스프링 빈 등록
    @Bean
    public MemberRepository memberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();    // 메모리 회원 저장소로
    }

    // OrderService 역할 스프링 빈 등록
    @Bean
    public OrderService orderService() {
        System.out.println("call AppConfig.orderService");
        // 생성자 주입
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    // DiscountPolicy 역할 스프링 빈 등록
    @Bean
    public DiscountPolicy discountPolicy() {
        //return new FixDiscountPolicy();     // 고정 할인 정책으로
        return new RateDiscountPolicy();    // 정률 할인 정책으로 변경
    }
}

 

2) 결과

자바 코드 상으로는 3번이 호출되어야 하는게 맞지만 실제로는 memberRepository()는 1번만 호출된다.

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

자바 코드 상으로는 memberRepository()가 3번 호출되어야 하는게 맞지만 스프링 컨테이너는 싱글톤 레지스트리로 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.

그래서 스프링은 싱글톤 보장을 위해 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

 

1. ConfigApp 스프링 빈 

1) configurationDeep() 테스트 코드

이 테스트 코드는 AnnotationConfigApplicationContext에 파라미터로 넘긴 AppConfig 스프링 빈의 클래스 정보를 확인하는 코드다.

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.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

public class ConfigurationSingletonTest {
    ...
    
    @Test
    void configurationDeep() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        // AppConfig 타입으로 빈 조회
        AppConfig bean = ac.getBean(AppConfig.class);

        // AppConfig의 클래스 타입 조회
        System.out.println("bean = " + bean.getClass());    // AppConfig@CGLIB
    }
}

 

(참고) AppConfig@CGLIB는 AppConfig의 자식 타입이므로, AppConfig 타입으로 조회할 수 있다.

 

2) 결과

2-1) 예상 결과

순수한 클래스라면 아래와 같이 출력되어야 한다.

2-2) 실제 결과

예상 결과와 다르게 클래스 명 뒤에 ~CGLIB가 붙었다. 즉, 내가 만든 클래스가 아니라 스프링이 바이트코드 조작 라이브러리(CGLIB)를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 스프링 빈으로 등록한 것이다. 

 

2. 그림

AppConfig 클래스를 상속받은 임의의 다른 클래스(AppConfig@CGLIB)가 싱글톤을 보장해준다.

아마 아래와 같이 바이트코드를 조작해서 작성되어 있을 것이다. (실제로는 더 복잡함)

 

3. AppConfig@CGLIB 예상 코드

@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.

 

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

1) AppConfig의 @Configuration 애노테이션 삭제

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 {
	...
}

2) configurationDeep() 테스트 결과 

AppConfig가 CGLIB 기술없이 순수한 AppConfig로 스프링 빈에 등록된 것을 확인할 수 있다.

 

3) configurationTest() 인스턴스가 같은지 테스트 결과

MemberRepository()가 3번 호출되었고, 각각 다른 MemoryMemberRepository 인스턴스를 갖고 있다.

 

<정리>

- @Bean만 사용해도 스프링 빈으로 등록은 되지만, 싱글톤을 보장하지 않는다.

- 싱글톤 보장을 위해서 스프링 설정 정보는 항상 @Configuration 을 사용하자.