7/6 싱글톤 컨테이너

싱글톤 컨테이너

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer(){
    //AppConfig appConfig = new AppConfig();

    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
    
    // MemberService memberService1 = appConfig.memberService();
    MemberService memberService1 = ac.getBean("memberService", MemberService.class);

    //MemberService memberService2 = appConfig.memberService();
    MemberService memberService2 = ac.getBean("memberService", MemberService.class);

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

    //검증(자동화되게 만들어야.눈으로확인하면 X)
    assertThat(memberService1).isSameAs(memberService2);
}

 

클라이언트가 올때마다 동일한 멤버서비스를 반환해준다. 

 

스프링 컨테이너는 기본적으로 싱글톤으로 동작한다

 

싱글톤 방식의 주의점

ctrl + shift + T 통해서 테스트 클래스를 간단하게 생성

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

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("userB",20000);

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

        //검중
        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

A가 주문한 금액 조회했더니 2만원이 출력되는 문제 발생

 ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한다 가정하자.

StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.

사용자A의 주문금액은 10000원이 되어야 하는데, 20000원이라는 결과가 나왔다.

실무에서 이런 경우를 종종 보는데, 이로인해 정말 해결하기 어려운 큰 문제들이 터진다.(몇년에 한번씩 꼭 만난다.)

진짜 공유필드는 조심해야 한다! 스프링 빈은 항상 무상태(stateless)로 설계하자

->지역변수를 사용해보자

 

public class StatefulService {

    private int price; // 상태를 유지하는 필드

    public int order(String name, int price) {
        System.out.println("name = " + name + " price = " + price);
        this.price = price;
        return price;
    }

    public int getPrice() {
        return price;
    }

}

지역 변수는 공유되는것이 아니라 정상 출력 되는것을 확인할 수 있다.

 

@Configuration과 싱글톤

@Configuration
public class AppConfig {

    //@bean memberService -> new MemoryMemberRepository()
    //@bean orderService -> new MemoryemberRepository()
    @Bean
    public MemberService memberService(){
        return new MemberServiceImpl(memberRepository()); //요기에서 만든 객체 인스턴스의 참조값을
    } // MemberServiceImpl 객체를 생성하고 MemorymemberRepository를 사용할거야 라고 주입해줌

    @Bean
    public MemoryMemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService(){
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

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

memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다.

이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.

 

orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다.

이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.

 

결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것 처럼 보인다.

스프링 컨테이너는 이 문제를 어떻게 해결할까?

 

깨질까 안깨질까 고민된다면, 테스트 만들어보면됨.

 

public class OrderServiceImpl implements OrderService{
    //MemberRepository에서 회원 찾아야하고, DiscountPolicy 필요
    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

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

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

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

public class MemberServiceImpl implements MemberService{

    private final MemberRepository 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);
    }

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

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 -> memberRepository2 = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);
         //검증
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);

    }
}

세개의 스프링빈이 다 같은 것을 확인

확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository 호출해서 다른 인스턴스가 생성되어야 하는데? 어떻게 된 일일까? 혹시 두 번 호출이 안되는 것일까? 실험을 통해 알아보자

 

AppConfig에 호출 로그 남김

@Configuration
public class AppConfig {

    //@bean memberService -> new MemoryMemberRepository()
    //@bean orderService -> new MemoryemberRepository()

    //예상 출력
    //call AppConfig.memberService
    //call AppConfig.memberRepository
    //call AppConfig.memberRepository
    //call AppConfig.orderService
    //call AppConfig.memberRepository

    //실제 출력
    //call AppConfig.memberService
    //call AppConfig.memberRepository
    //call AppConfig.orderService

    //빈 등록할 때 다 호출됨
   @Bean
    public MemberService memberService(){
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository()); //요기에서 만든 객체 인스턴스의 참조값을
    } // MemberServiceImpl 객체를 생성하고 MemorymemberRepository를 사용할거야 라고 주입해줌

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

 

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

스프링 컨테이너는 싱글톤 레지스트리다.

따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.

그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다.

저 자바 코드를 보면 분명 3번 호출되어야 하는 것이 맞다.

그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

모든 비밀은 @Configuration 을 적용한 AppConfig 에 있다

@Test
void configurationDeep(){
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
    //AppConfig도 스프링 빈으로 등록됨
    AppConfig bean = ac.getBean(AppConfig.class);

    //bean.getClas() : 클래스 타입이 뭔지
    System.out.println("bean = " + bean.getClass());
}

사실 AnnotationConfigApplicationContext 에 파라미터로 넘긴 값은 스프링 빈으로 등록된다.

그래서 AppConfig 도 스프링 빈이 된다. AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보자

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

순수한 클래스라면 다음과 같이 출력되어야 한다. ->  class hello.core.AppConfig

AppConfig@CGLIB가 appConfig라는 이름도 자기가 가져가고 스프링 빈에 AppConfig@CGLIB 가 저장됨

 

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

부모 타입을 조회하면 자식 타입도 다 끌려옴 -> AppConfig@CGLIB가 튀어나온것.

@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고,

스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.

덕분에 싱글톤이 보장되는 것이다.

 

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

 

@Configuration 안붙여도 스프링 빈에 다 등록됨

그러나 @Bean만 적용하면 

//@Configuration
public class AppConfig {
    
    //빈 등록할 때 다 호출됨됨
   @Bean
    public MemberService memberService(){
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository()); //요기에서 만든 객체 인스턴스의 참조값을
    } // MemberServiceImpl 객체를 생성하고 MemorymemberRepository를 사용할거야 라고 주입해줌

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

이 출력 결과를 통해서 MemberRepository가 총 3번 호출된 것을 알 수 있다.

1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해서이고,

2번은 각각 memberRepository() 를 호출하면서 발생한 코드다

 

정리

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

memberRepository() 처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤을 보장하지 않는다.

크게 고민할 것이 없다. 스프링 설정 정보는 항상 @Configuration 을 사용하자

 

*

@Autowired : 스프링이 자동으로 의존관계를 등록해줌