[SpringBoot] [3] 5. 싱글톤 컨테이너

윤경·2021년 8월 22일

Springboot TIL

Spring Boot

목록 보기

27/79

1️⃣ 웹 애플리케이션과 싱글톤

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

웹이 아닌 애플리케이션 개발도 가능하지만 대부분의 스프링 애플리케이션은 웹 애플리케이션이다.

✔️ test에 singleton 패키지 생성 후 SingletonTest.java

package hello.core.singleton;
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 static org.assertj.core.api.Assertions.assertThat;

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컨테이너인 AppConfig는 요청 할 때마다 객체를 새로 생성
이는 메모리 낭비가 심한 방법이기 때문에

해당 객체가 딱 하나만 생성되고 공유하도록 설계하자 ➡️ 싱글톤 패턴

2️⃣ 싱글톤 패턴

: 클래스의 인스턴스가 딱 하나만 생성되는 것을 보장하는 디자인 패턴
→ private 생성자를 사용해 외부에서 임의로 new 키워드를 사용하지 못하도록 막자.

✔️ main말고 test에 SingletonService.java 생성 (main에 안 하는 이유는 다른 코드에 영향을 끼치지 않기 위함)

package hello.core.singleton;

import jdk.jshell.Snippet;

public class SingletonService {

    // (static이라고 되어있으면 static 영역에 딱 하나만 생성될 수 있음.)
    // 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("싱글톤 객체 로직 호출");
    }
}

static 영역에 객체 instance를 하나 생성
이 instance가 필요하면 getInstance() 메소드만을 통해 조회 가능 (항상 같은 인스턴스 반환)
딱 하나의 객체 인스턴스만 존재해야 하므로 생성자를 private으로 막아 외부에서 new로 객체 인스턴스를 생성할 수 없도록 한다.

✔️ 저번에 만들어뒀던 SingletonTest.java에 코드 추가

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

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

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

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

        singletonService1.logic();
    }

😺: 그런데, 싱글톤 패턴에도 문제가 있다고?

싱글톤 패턴을 구현하는 코드가 있어야 해서 좀 귀찮다(?)
의존관계 상 클라이언트가 구체 클래스에 의존한다 ➡️ 뭐? DIP를 위반하네 !!
클라이언트가 구체 클래스에 의존해 OCP 원칙을 위반할 가능성이 높다.
유연하게 테스트하기 어렵다.
내부 속성을 변경하거나 초기화하기 어렵다.
private 생성자로 자식 클래스를 만들기 어렵다. ➡️ 유연성이 떨어짐
안티 패턴으로 불리기도 한다.

😺: 아니, 이렇게 문제점이 많다고? 그럼 이제와서 어쩌라는거야 !!
👽: 순개씨 제발 좀,,
😺: (헤헤)

순진한 개발자를 위해 바로 싱글톤 컨테이너에 대해 알아보자.

3️⃣ 싱글톤 컨테이너

: 싱글톤 컨테이너는 순개씨가 걱정했던 문제점을 해결해주며 객체 인스턴스를 싱글톤으로 관리해준다.

싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리
스프링 컨테이너는 싱글톤 컨테이너의 역할. 이렇게 싱글톤 객체를 생성, 관리하는 기능을 싱글톤 레지스트리라고 함.
스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하며 객체를 싱글톤으로 유지 가능
(싱글톤 구현 코드 필요 없고, DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤 사용)

✔️ SingletonTest.java

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

위에서 3명의 사용자가 요청하여 3개의 객체가 만들어진 그림을 기억하십니까?
싱글톤 컨테이너를 적용하면 아래와 같은 형태로 효율적인 모습이 된다.

📌 (참고): 스프링의 기본 빈 등록 방식은 싱글톤이지만 싱글톤 방식만 지원하는 것은 아님.
요청할 때마다 새로운 객체를 생성해 반환하는 기능도 제공

4️⃣ 싱글톤 방식의 주의점

중요한 내용이니까 집중 해주세요.

객체 인스턴스를 하나만 생성해 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 동일한 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안된다.
➡️ 무상태(stateless) 로 설계하자

✔️ 무상태는

특정 클라이언트에 의존적인 필드가 있으면 안되며

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

또한 가급적 읽기만 가능해야하고

필드 대신 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal등을 사용해야 한다.
(📌 스프링 빈 필드에 공유 값을 설정한다면 큰 장애가 발생할 수 있으니 주의하자)

실무에서 정말 자주 발생하는 문제 !!
✔️ 우선 test/singleton StatefulService.java

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

📌 command + shift + t: 테스트 케이스 자동 생성
✔️ StatefulServiceTest.java

package hello.core.singleton;

import org.junit.jupiter.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 javax.swing.plaf.nimbus.State;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.*;

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);
        // ThreadA: 사용자 A가 10000원 주문
        statefulService2.order("userB", 20000);
        
        // ThreadA: 사용자 A 주문 금액 조회
        int price = statefulService1.getPrice();
        // 기댓값은 10000원이지만 1.order후 getPrice() 사이에 2.order로 20000이 되었기 때문에 20000 출력
        System.out.println("price = " + price);

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

    static class TestConfig {

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

StatefulService의 price 필드는 공유되는 필드인데 특정 클라이언트가 값을 변경해버려서 이러한 결과를 초래했다.

(private int price 변수를 없애고 (price에 값을 담지 않고) 바로 return하게 바꾸어주면 원하는 기댓값을 얻을 수 있긴 하다.)

실무에서는 이런 경우가 종종 발생하고 해결하기 어려운 큰 문제가 발생하므로 꼭 !! 조심해야 한다.
(공유 필드는 항상 조심하고 스프링 빈은 항상 ⭐️무상태(stateless)로 설계하자)

5️⃣ @Configuration과 싱글톤

😺: 그런데 AppConfig.java .. 이것도 뭔가 싱글톤이 깨지는 상황 아닌가?

✔️ AppConfig.java 코드의 일부

@Configuration
public class AppConfig {

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

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

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

}

➡️ 이때,
@Bean memberService도 memberRepository()를 호출해 new MemoryMemberReposiotry()를 호출하고
@Bean orderService도 memberRepository()를 호출해 new MemoryMemberReposiotry()를 호출하는데

싱글톤이 깨지는 것 같은데 ,,??

이럴땐 되는지 안 되는지 test로 실험해보자 !!

✔️ MemberServiceImpl.java 에 다음 코드를 추가

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

✔️ OrderServiceImpl.java 에 다음 코드를 추가

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

✔️ test에 configurationSingletonTest.java 생성

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

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

public class configurationSingletonTest {

    @Test
    void configutationTest() {
        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);

        // 모두 같은 인스턴스를 참고
        System.out.println("memberService -> memberRepository = " + memberService.getMemberRepository());
        System.out.println("orderService -> memberRepository = " + orderService.getMemberRepository());
        System.out.println("memberRepository = " + memberRepository);

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

➡️ 이상하다. 각각 다른 세개의 인스턴스가 생성됐을 줄 알았는데 모두 같은 인스턴스가 공유되어 사용되고 있었다.

어떻게 된 것인지 테스트해보자.

✔️ AppConfig.java 코드의 일부

@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        // soutm 으로 아래의 코드를 각각 추가
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberReposiotry();
    }

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

}

📌 (참고): soutm + enter → System.out.println("AppConfig.memberService");

⬇️ 우리가 예상했던 출력

call Appconfig.memberService
call Appconfig.memberRepository
call Appconfig.memberRepository
call Appconfig.orderService
call Appconfig.memberRepository

⬇️ 실제 출력

memberRepository의 3번 호출을 예상했지만

스프링 컨테이너가 스프링 빈에 등록하기 위해 @Bean 붙어있는 memberRepository() 호출
memberService() 로직에서 호출
orderService() 로직에서 호출

실제로는 각 한 번씩만 호출되는 것을 확인했다.

memberService
memberRepository
orderService

😺:

6️⃣ @Configuration과 바이트코드 조작의 마법 🧙🏻‍♀️

스프링 컨테이너 = 싱글톤 레지스트리 이므로 스프링 빈이 싱글톤을 보장해주어야 한다.
그래서 스프링은 클래스 바이트 코드를 조작하는 라이브러리인 @Configuration을 사용한다.

✔️ configurationSingletonTest.java에 다음 코드를 추가

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

        // Appconfig도 스프링 빈으로 등록된다.
        AppConfig bean = ac.getBean(AppConfig.class);

        System.out.println("bean = " + bean.getClass());
        // 출력: bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70
    }

AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록 (그래서 AppConfig도 스프링 빈이 된다는 것)
AppConfig 스프링 빈을 조회해 클래스 정보 출력한 결과 ⬇️

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

하지만 이와 같이 순수한 클래스가 아님을 확인했다.
이는 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들어 그것을 스프링 빈으로 등록했다는 것.

✔️ AppConfig@CGLIB 예상 코드 (실제로는 이것보다 복잡할 것)

➡️ @Bean이 붙은 메소드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환,
없다면 생성해 스프링 빈으로 등록하고 반환하는 코드가 동적으로 생성됨 (이로 인해 싱글톤이 보장 !!)