[Spring] 싱글톤 컨테이너

싱글톤

---

탄생 배경과 필요성

---

여러 고객이 동시에 요청 시

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

 

호출마다 객체 새로 생성 > 메모리 낭비 Up 

➡︎ 해당 객체 1개만 생성,공유하도록 설계 (싱글톤 패턴)

 

싱글톤 패턴

---

하나의 클래스에 대해 단 하나의 인스턴스만 생성되도록 보장하는 디자인 패턴

> 객체 인스턴스 2개 이상 생성못하도록 해야함

> private 생성자 사용해 외부에서 new 키워드를 사용하지 못하도록 함

 

public class SingletonService {

    //1. static 영역에 객체를 딱 1개만 생성
    private static SingletonService instance = new SingletonService();

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

    //3. 생성자를 private으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {}

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

 

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용") public void singletonServiceTest() {
    //private으로 생성자를 막아두었다. 컴파일 오류가 발생한다.
    //new SingletonService();

    //1. 조회: 호출할 때 마다 같은 객체를 반환
    SingletonService singletonService1 = SingletonService.getInstance();
    //2. 조회: 호출할 때 마다 같은 객체를 반환
    SingletonService singletonService2 = SingletonService.getInstance();

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

    // singletonService1 == singletonService2
    assertThat(singletonService1).isSameAs(singletonService2);

    singletonService1.logic();
}

 

>싱글톤 패턴 적용시 고객 요청마다 객체 생성이 아니라 만들어진 객체 공유해 효율적 사용 가능

 

싱글톤 패턴 문제점

---

1. 싱글톤 패턴 구현하는 자체 코드 많이 들어감
2. 클라이언트가 구체 클래스에 의존해 DIP, OCP 원칙 위반 높음.

3. 테스트 어려움

4. 내부 속성 변경 및 초기화 어려움

5. private 생성자로 자식 클래스 만들기 어렵움
6. 결론적으로 유연성이 떨어짐

7. 안티패턴으로 불리기도 함

 

싱글톤 컨테이너

---

스프링 컨테이너는 싱글톤 패턴의 문제점을 다 제거하면서, (싱글턴 패턴을 적용없이도) 객체 인스턴스를 싱글톤으로 관리함.

스프링 빈이 바로 싱글톤으로 관리되는 빈.

이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 함

 

 

@Test
@DisplayName("스프링 컨테이너와 싱글톤") void springContainer() {
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    //1. 조회: 호출할 때 마다 같은 객체를 반환
    MemberService memberService1 = ac.getBean("memberService", MemberService.class);

    //2. 조회: 호출할 때 마다 같은 객체를 반환
    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)로 설계해야 한다.

 

• 특정 클라이언트에 의존적인 필드 x
• 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안됨.
• 가급적 읽기만 가능
• 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 함
• 스프링 빈의 필드에 공유 값을 설정하면 정말 큰 장애가 발생 할 수 있음!!

 

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

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

}

 

class StatefulServiceTest {
    @Test
    void statefulServiceSingleton() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
        StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);

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

        //ThreadA: 사용자A 주문 금액 조회
        int price = statefulService1.getPrice();
        //ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
        System.out.println("price = " + price);
        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

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

이로인해 정말 해결하기 어려운 큰 문제들이 터질수 있기 때문에 주의!

 

@Configuration과 싱글톤

---

@Configuration은 싱글톤을 위해 존재

 

- AppConfig.java

@Configuration
public class AppConfig {
    
    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

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

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

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

@Bean memberService ->new MemoryMemberRepository() 호출

@Bean orderService ->new MemoryMemberRepository() 호출
각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것 아닌가?

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

memberService -> memberRepository = hello.core.member.MemoryMemberRepository@2f62ea70
orderService -> memberRepository  = hello.core.member.MemoryMemberRepository@2f62ea70
memberRepository = hello.core.member.MemoryMemberRepository@2f62ea70

 

 

호출 로그 남김

@Bean
public MemberService memberService() {
	System.out.println("call AppConfig.memberService");
	return new MemberServiceImpl(memberRepository());
}
@Bean
public OrderService orderService() {
	System.out.println("call AppConfig.orderService");
    return new OrderServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
	System.out.println("call AppConfig.memberRepository");
	return new MemoryMemberRepository();
}

자바 코드로만 보면 call AppConfig.memberRepository가 3번 호출돼야하지만

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

출력 보면 모두 1번씩만 호출됨 (스프링이 싱글톤 보장)

스프링은 어떻게 처리하는걸까?

 

@Configuration과 바이트코드 조작

---

스프링 컨테이너는 싱글톤 레지스트리라 스프링빈이 싱글톤이 되도록 보장해줘야함

위대로라면 3번 호출되어야하는데 스프링이 자바 코드까지 어떻게 하기 어려움. 그럼 어떻게?

> @Configuration붙여 클래스의 바이트코드를 조작하는 라이브러리(CGLIB)를 사용

 

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

    AppConfig bean = ac.getBean(AppConfig.class);

    //AppConfig 빈의 클래스 정보 출력
    System.out.println("bean = " + bean.getClass());
    //bean = class hello.core.AppConfig$$SpringCGLIB$$0
}

순수한 클래스라면 class hello.core.AppConfig 같이 출력되어야 하는데

뒤에 $$SpringCGLIB~ 붙으면서 복잡해짐

➡︎ 내가 만든 클래스가 아닌 스프링이 바이트코드 조작 라이브러리(CGLIB)를 사용해

AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 이를 스프링 빈으로 등록한 것!

상속받은 임의의 다른 클래스가 싱글톤 보장되도록 해줌.

AppConfig@CGLIB 예상 코드

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

이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환

➡︎ 싱글톤 보장

 

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