[스프링 핵심 원리 - 기본편] 5. 싱글톤 컨테이너

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

✔ 스프링 : 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생

• 대부분의 스프링 애플리케이션은 웹 애플리케이션임
• 물론 웹이 아닌 애플리케이션 개발도 얼마든지 개발 가능

✔ 웹 애플리케이션은 보통 여러 고객이 동시에 요청

 

 

 

 

 

 

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

🔶 test/.../hello/core/singleton/SingletonTest

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("스프링 없는 순수한 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);
    }
}

 

❗ 우리가 만들었던 순수한 DI 컨테이너가 가진 문제점을 확인

 

 

실행해보면 다른 것이 생성되는 것을 볼 수 있음

 

✔ 정리

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

 

 

⚡ 싱글톤 패턴

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

• 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 함

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

 

예제 코드

❗ main이 아닌 test 아래에 생성

🔶 test/.../singletone/SingletonService

package hello.core.singleton;

public class SingletonService {

    //1. static 영역에 객체를 딱 1개만 생성해둠
    private static final 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/.../singleton/SingletonTest

@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
public void singletonServiceTest(){
    SingletonService singletonService1 = SingletonService.getInstance();
    SingletonService singletonService2 = SingletonService.getInstance();

    System.out.println("singletonService1 = " + singletonService1);
    System.out.println("singletonService2 = " + singletonService2);

    assertThat(singletonService1).isSameAs(singletonService2);
}

 

❗ new SingletonService(); 이렇게 생성하려면 안됨(위에서 private로 new 키워드를 막아놨기 때문)

 

📌 same : 동일한 객체를 가리키는지(메모리에서 동일한 위치를 가리키는지), 즉, ==
📌 equal : 객체의 내용이 동일한지(객체를 나타내는 속성들이 동일한지)

 

❗❗❗스프링 컨테이너를 사용하면 기본적으로 객체를 싱글톤으로 만들어서 관리해줌❗❗❗

 

싱글톤 패턴 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어감
• 의존관계상 클라이언트가 구체 클래스에 의존함 -> DIP 위반
• 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높음
• 테스트하기 어려움
• 내부 속성을 변경하거나 초기화하기 어려움
• private 생성자로 자식 클래스를 만들기 어려움
• 결론적으로 유연성이 떨어짐
• 안티패턴으로 불리기도 함

 

 

📌 싱글톤 컨테이너

 

스프링 컨테이너

• 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리

 

⚡ 싱글톤 컨테이너란

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

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

✔ 스프링 컨테이너는 싱글톤 컨테이너 역할을 함

• 싱글톤 레지스트리 : 싱글톤 객체를 생성하고 관리하는 기능

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

• 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 됨
• DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용가능

 

 

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

🔶 test/.../singleton/SingletonTest

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer(){
    //AppConfig appConfig = new AppConfig();
    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);
}

 

❗ 위에 pureContainer()와 비교

 

<싱글톤 컨테이너 적용 후>

 

✔ 스프링 컨테이너 덕분에 고객의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있음

 

cf)
스프링의 기본 빈 등록 방식은 싱글톤이지만, 싱글톤 방식만 지원하는 것은 아님
요청할 때마다 새로운 객체를 생성해서 반환하는 기능도 제공함 (빈 스코프에서 더 자세히 다룸)

 

 

 

📌 싱글톤 방식의 주의점❗⭐⭐⭐⭐⭐

 

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

 

❗ 무상태(stateless)로 설계해야함!

• 특정 클라이언트에 의존적인 필드가 있으면 안됨
• 특정 클라이언트에 값을 변경할 수 있는 필드가 있으면 안됨
• 가급적 읽기만 가능해야 함
• 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 함

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

 

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

StatefulService.java

🔶 test/.../singleton/StatefulService

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

 

this.price = price; 🌟🌟🌟 여기서 문제 발생 🌟🌟🌟

• 클라이언트의 의도는 주문을 하고 값을 저장해두는 것

 

StatefulServiceTest.java

 

🔶 test/.../singleton/StatefulServiceTest

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;

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);        //ThreadA : A 사용자가 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);
    }

    static class TestConfig{

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

 

❗ 같은 객체를 사용하기 때문에 발생
-> 진짜 공유필드는 조심해야 함 

 

❗ 스프링 빈은 항상 무상태(stateless)로 설계해야함

 

해결방안

🔶 test/.../singleton/StatefulService.java

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

• private로 선언한 price를 지우고 아예 order 함수에서 바로 price값을 반환해줌

 

🔶 test/.../singleton/StatefulService.java

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;

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


        //ThreadA-사용자A가 주문 금액 조회
        //int price = statefulService1.getPrice();
        //System.out.println("price = " + price);
        System.out.println("userAprice = " + userAprice);
        System.out.println("userBprice = " + userBprice);
        //Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

    static class TestConfig{

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

 

statefulService1.order("userA", 10000);을 호출하면 리턴값이 존재하기 때문에 int 변수를 선언해줌

• userAprice, userBprice를 출력해보면 구매한 가격대로 잘 출력됨

 

 

📌 @Configuration과 싱글톤

AppConfig의 문제점 ❗

❗AppConfig를 보면 이상한 점이 있음

 

🔶 test/.../hello.core/AppConfig

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 FixDiscountPolicy();
        return new RateDiscountPolicy();
    }
}

• memberService 빈을 만드는 코드를 보면, ➡ memberRepository()를 호출
  • memberRepository를 호출하면, ➡ new MemoryMemberRepository()를 호출
• orderService 빈을 만드는 코드를 보면, ➡ 동일하게 memberRepository()를 호출
  • memberRepository를 호출하면, ➡ new MemoryMemberRepository()를 호출

 

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

• 스프링컨테이너는 이 문제를 어떻게 해결할 수 있는가

 

 

검증 용도의 코드 추가

🔶 main/.../hello.core/member/MemberServiceImpl.java
🔶 main/.../hello.core/order/OrderServiceImpl.java

 

기존에 있던 MemberServiceImpl.java와 OrderServiceImpl.java 코드에 코드 추가

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

 

❗ 테스트를 위해 MemberRepository를 조회할 수 있는 기능을 추가함
-> 검증을 위해 추가한 것이니 인터페이스에 조회기능까지는 추가 X

 

테스트 코드

 

🔶 test/.../hello.core/singleton/ConfigurationSingletonTest

package hello.core.singleton;

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

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

    }
}

 

❗ 위에 pureContainer()와 비교

❗ ac.getBean("memberRepository", MemberRepository.class); + 단축키 command + option + V 추가 생성

 

📌 정리

• 모두 같은 인스턴스가 공유되어 사용됨
• 여기서 의문점
  • AppConfig.java를 보면 각각 2번 new MemoryMemberRepository가 호출되어 다른 인스턴스가 생성될텐데 왜 같은 인스턴스일까?

 

 

AppConfig에 호출 남김

 

🔶 main/.../hello.core/AppConfig.java 코드 추가

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
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(){
        System.out.println("call AppConfig.memberService");
        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());
    }
    @Bean
    public DiscountPolicy discountPolicy() {
        //return new FixDiscountPolicy();
        return new RateDiscountPolicy();
    }


}

 

🔶 MemberService, MemberRepository, OrderService 함수 안에 soutm

• 스프링 컨테이너가 각각 @Bean을 호출하여 스프링빈을 생성함
• memberRepository()는 3번 호출되어야 함
  •  근데 출력 결과 모두 1번만 호출됨
    

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

 

 

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

• 스프링 컨테이너는 싱클톤 레지스트리임
  • 스프링 빈이 싱글톤이 되도록 보장해주어야 함
  • but, 스프링이 자바 코드까지 어떻게 하기는 어려움

 

✔ 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용
(모든 비밀은 @Configuration을 적용한 AppConfig에 있음)

 

🔶 test/.../singleton/ConfigurationSingletonTest.java

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

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

bean = class hello.core.AppConfig$$SpringCGLIB$$0

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

 

 

그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해줌

• 바이트 코드를 조작해서 작성됨(실제로 CGLIB 내부 기술을 사용하는데 매우 복잡함)

 

AppConfig@CGLIB 예상 코드

@Bean
public MemberRepository memberRepository(){

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

 

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

• 덕분에 싱글톤 보장

cf) AppConfig@CGLIB은 AppConfig의 자식타입이므로, AppConfig 타입으로 조회가능

 

❗ @Configuration을 적용하지 않고, @Bean만 적용하면 어떻게 되는가?

• @Configuration을 통해 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 만약 @Bean만 적용하면?
• bean = class hello.core.AppConfig 출력
  -> AppConfig가 CGLIB기술 없이 순수한 AppConfig로 스프링빈에 등록됨

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

 

-> MemberRepository가 3번 호출된 것을 알 수 있음 (싱글톤이 깨진 것)

1번 : @Bean에 의해 스프링 컨테이너에 등록하기 위해서
나머지 2번 : 각각 memberRepository()를 호출하면서 발생한 코드

 

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

 

configurationTest() 함수 돌려봄
-> error 발생

 

memberService -> memberRepository1 = hello.core.member.MemoryMemberRepository@6f36c2f0
orderService -> memberRepository2 = hello.core.member.MemoryMemberRepository@f58853c
memberRepository = hello.core.member.MemoryMemberRepository@1224144a

• 각각 다 다른 MemoryMemberRepository 인스턴스를 가지고 있음

 

 

 

📌 정리

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

 

 

 

 

 

출처 : <인프런 스프링 핵심원리 - 기본편_김영한>을 수강하고 참고하여 작성한 글입니다.

 

 

 

---

PREV

[스프링 핵심 원리] 4. 스프링 컨테이너와 스프링 빈

NEXT

[spring 핵심 원리] 6. 컴포넌트 스캔