싱글톤 컨테이너

 

싱글톤 컨테이너

웹 애플리케이션과 싱글톤

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

싱글톤 패턴

싱글톤 패턴의 문제점

싱글톤 컨테이너

싱글톤 컨테이너

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

싱글톤 방식의 주의점

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

@Configuration과 싱글톤

테스트 코드

@Configuration과 바이트코드 조작

AppConfig@CGLIB 예상코드

싱글톤 컨테이너

 

웹 애플리케이션과 싱글톤

 

스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.

대부분의 스프링 어플리케이션은 웹 어플리케이션이다. 물론 웹이 아닌 어플리케이션 개발도 얼마든지 개발할 수 있다.

웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

스프링이 없는 순수한 DI 컨테이너인 AppConfig는 요청이 들어올때마다 객체가 생성되어 메모리 낭비가 심해진다.

이를 해결하기 위해 객체를 하나만 생성한 뒤 해당 객체를 공유하도록 설계하면 된다. → 싱글톤을 사용한다.

 

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

 

package hello.core.singleton;

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);
				
				// memberService1 != memberService2
        assertThat(memberService1).isNotSameAs(memberService2);
    }

}

호출할때마다 서로 다른 객체가 생성되었음을 확인할 수 있다.

 

싱글톤 패턴

 

클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.

그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.

private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

package hello.core.singleton;

public class SingletonService {

//    자기 자신의 객체를 생성한다.
//    여기서 private 접근 제한자와 static 을 선언해줘 객체를 추가로 생성하지 않으며,
//    static을 선언해주었기 때문에 클래스가 처음으로 로드될때 객체를 생성하고 정적 영역에 해당 객체를 등록한다.
//    특정 메소드를 통해서만 접근할 수 있도록 설정해준다.
    private static final SingletonService instance = new SingletonService();

//    싱글톤으로 설정된 객체인 자기 자신의 instance를 호출할 수 있는 getInstance
    public static SingletonService getInstance() {
        return instance;
    }

//    생성자로 외부에서의 객체 생성을 막아준다.
    private SingletonService() {
    }

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

 

해당 class가 정말 하나의 객체를 반환하는지 테스트 해보자.

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;

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

public class SingletonTest {

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

}

성공적으로 같은 객체를 반환하는 모습

 

싱글톤 패턴의 문제점

 

싱글톤 패턴을 구현하는 코드 자체가 많이 든다.

의존관계상 클라이언트가 구체 클래스에 의존한다. → DIP를 위반한다.

클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.

테스트하기 어렵다.

내부 속성을 변경하거나 초기화하기 어렵다.

private 생성자로 자식 클래스를 만들기 어렵다.

결론적으로 유연성이 떨어진다.

안티패턴으로 불리기도 한다.

 

싱글톤 컨테이너

 

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤으로 관리한다.

지금까지 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

 

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.

이전에 설명한 컨테이너 생성과정을 보면, 컨테이너는 객체를 하나만 생성해서 관리한다.

스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다

싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.

DIP,OCP,테스트,private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있다.

 

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

 

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberService;
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.*;

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

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


    }
}

빈으로 등록되어 있는 객체들을 스프링 컨테이너에서 싱글톤으로 관리하는 모습이다

 

싱글톤 방식의 주의점

 

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.

무상태(stateless)로 설계해야 한다!

특정 클라이언트에 의존적인 필드가 있으면 안된다.

특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.

가급적 읽기만 가능해야 한다.

필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생할 수 있다

 

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

 

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

package hello.core.singleton;

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);
//        ThreadA: B사용자 20000원 주문
        statefulService1.order("userB", 20000);

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

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

    static class TestConfig {

        @Bean
        public StateFulService stateFulService() {
            return new StateFulService();
        }
    }

}

사용자 B의 정보가 입력되며 price의 값이 20000원으로 수정되었다.

 

해당 코드를 무상태로 수정해보자.

package hello.core.singleton;

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 void getPrice() {
//        return price;
    }
}

package hello.core.singleton;

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;

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원 주문
        int userAPrice = statefulService1.order("userA", 10000);
//        ThreadA: B사용자 20000원 주문
        int userBPrice = statefulService1.order("userB", 20000);

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

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

    }

    static class TestConfig {

        @Bean
        public StateFulService stateFulService() {
            return new StateFulService();
        }
    }

}

 

@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 {

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

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

이 메소드를 호출하면 new MemeoryMemberRepository()를 호출한다

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

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

 

결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보인다. 스프링 먼테이너는 이 문제를 어떻게 해결할까?

 

직접 테스트 해보자

 

테스트 코드

 

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

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

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

memberService와 orderService가 빈으로 등록되는 과정에서 함께 생성되는 memberRepository 도 함께 빈으로 등록되어 싱글톤으로 관리된다.

 

@Configuration과 바이트코드 조작

 

스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다. 저 자바 코드를 보면 분명 다른 객체가 등록되어야 하는것이 맞다.

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

@Configuration을 적용한 AppConfig가 이 역할을 수행한다.

 

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

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

순수한 클래스라면 class hello.core.AppConfig 라고 출력되어야 한다.

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

그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다. 아마도 다음과 같이 바이트 코드를 조작해서 작성되어 있을것이다.

 

AppConfig@CGLIB 예상코드

 

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