[Spring] 싱글톤 컨테이너

안녕하세요? 주니하랑 입니다.

오늘은 Spring의 Singleton Container에 대해서 공부 해 보도록 하는 것이에요.

이 내용은 인프런 - 김영한 강사님의 스프링 핵심 원리를 공부하면서 정리 하였습니다.

 

 

백견불여일타 스프링 부트 쇼핑몰 프로젝트 with JPA:이젠 프로젝트다!

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

 

📋 목차

---

01. [Spring] 스프링 핵심 원리
02. [Spring] 좋은 객체 지향 설계의 5가지 원칙 (SOLID)
03. [Spring] 객체 지향 설계와 스프링   
04. [Spring] OCP와 DIP 고려하기
05. [Spring] 객체 지향 원리 적용 - 새로운 할인 정책 개발
06. [Spring] AppConfig 리팩터링    
07. [Spring] Ioc, DI Container  
08. [Spring] 스프링 컨테이너 생성  
09. [Spring] 싱글톤 컨테이너  
10. [Spring] Component Scan And Auto wired Start
11. [Spring] 의존관계 주입 방법    
12. [Spring] Bean Life Cycle Call Back
13. [Spring] Bean Scope

 

 

---

 

 

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

---

원래 스프링은 Enterprise용으로 온라인 서비스 기술을 지원하기 위해 탄생했다고 합니다.

대부분의 스프링 애플리케이션은 웹 애플리케이션인 것이에요. 물론 웹이 아닌 애플리케이션 개발도 얼마든지 스프링을 이용해서 할 수 있는 것이에요.

웹 애플리케이션은 중요한 부분이 여러 고객이 동시에 요청을 한다는 점인것이에요.

 

 

위와 같이 우리가 아는 객체 생성 개념대로라면 클라이언트가 요청할 때마다 new를 통해 해당 서비스 객체를 만들어서 반환해 주는 것이에요.

 

 

📖 Test 결과

 

위와 같이 이 전에 만들었던 스프링 없는 순수 DI Container인 AppConfig는 요청을 할 때마다 객체를 새로 생성하는 것이에요.

고객 트래픽이 초당 100이 나오면 초당 100개의 객체가 생성되고, 가비지컬렉터에 의해 소멸되는 것이에요. 때문에 Memory 낭비가 매우 심해질 것이에요.

이것을 해결하기 위해서는 해당 객체가 딱 1개만 생성되고, 공유하도록 만들면 되는 것이에요. 그것이 바로 싱글톤 패턴이랍니다!

 

 

    📍싱글톤 패턴

싱글톤 패턴이란 클래스의 인스턴스가 딱 한개만 생성되는 것을 보장하는 디자인 패턴인 것이에요.

그래서 객체 인스턴스 2개를 생성하지 못하도록 막아준답니다! private 생성자를 통해 외부에서 임의로 new를 사용하지 못하도록 막으면 되는 것이에요.

 

위의 코드를 보면 static 영역에 객체 instance를 미리 하나 생성해서 올려두는 것이에요.

이 객체 인스턴스가 필요하면 오직 getInstance() Method를 통해서만 조회할 수 있는 것이고, 이것을 호출하면 항상 같은 인스턴스만을 반환하는 것이에요.

딱 한 개의 인스턴스만 존재해야 하기 때문에 생성자를 private으로 막아 혹시라도 외부에서 new를 사용하여 객체 인스턴스가 다른 것이 생성되는 것이 막아야 하는 것이에요.

 

💡참고 : Static이란? 

'주니하랑'의 [JAVA] Class Method(static Method)와 인스턴스 Method

 

자바의 Static에 대해 잘 모르시거나, 헷갈리시는 분은 여기에 관심을 주세요!

 

위의 코드는 싱글톤 패턴을 사용하는 테스트 코드인 것이에요.

위에 코드에서 생성자를 private으로 막게 되면 컴파일 오류가 발생하는 것이에요.

private으로 하면 new를 통해서 객체 생성을 막을 수 있답니다!

 

📖 Test 결과

반응형

위의 테스트 코드를 실행해 보면 같은 인스턴스(객체)가 반환되는 것을 확인할 수 있는 것이에요.

 

💡참고 :
1. 싱글톤 패턴을 구현하는 방법은 여러가지가 있다. 여기서는 객체를 미리 생성해두는 가장 단순하고, 안전한 방법을 사용했다.

2. isSameAS는 ==처럼 인스턴스를 비교하는 것이고, isEqual는 Equals Mehotd처럼 비교하는 것

 

싱글톤 패턴을 적용하면 Client의 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있답니다. 하지만, 싱글톤 패턴은 다음과 같은 수 많은 문제점을 가지고 있는 것이에요.

 

싱글톤 패턴의 문제점

 

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.

싱글톤 구현 코드의 한 예

• 의존 관계상 Client가 구체 클래스에 의존 -> DIP 위반 사항
• Client가 구체 클래스에 의존해서 OPC 원칙 위반 가능성 높음
• 테스트가 어려움
• 내부 속성 변경 및 초기화 어려움
• private 생성자로 자식 클래스 만들기 어려움
• 유연성이 떨어짐
• 안티 패턴이라고 불리기도 함.

 

 

 

📌 싱글톤 컨테이너

---

스프링 컨테이너는 싱글톤 패턴의 모든 문제를 해결하면서도 객체 인스턴스를 싱글톤(1개만 생성)으로 관리할 수 있는 것이에요.

지금까지 공부한 스프링 빈이 바로 싱글톤으로 관리되는 빈이라고 합니다!

스프링 컨테이너는 싱글톤 패턴을 적용하지 않아더라도 객체 인스턴스를 싱글톤으로 관리하는 것이에요.

이전에 컨테이너 생성 과정을 보면 컨테이너는 객체를 하나만 생성해서 관리하는 것을 알 수 있죠!

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

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

결국 싱글톤 패턴을 위한 지저분한 코드가 필요가 없고, DIP 및 OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있게 된 것이에요!

 

 

 

 

    📍싱글톤 컨테이너 적용 뒤

 

 

스프링 컨테이너 덕에 Client 요청이 올 때 마다 객체를 생성하는 것이 아닌 이미 만들어진 객체를 공유해서 효율적으로 사용할 수 있게 된 것이에요.

 

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

 

 

    📍싱글톤 방식의 주의점

 

싱글톤 패턴, 스프링 같은 싱글톤 컨테이너를 사용하던지 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 Client가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안되는 것이에요. 즉, 무상태(stateless)로 설계해야 한답니다!

그말인 즉 특정 Client에 의존적인 필드(멤버변수)가 있으면 안되는 것이에요.

또한, 특정 Client가 값을 변경할 수 있는 필드가 있으면 안되는 것이에요.

이것은 가급적 읽기만 가능해야 하며, 필드 대신 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 하는 것이에요.

스프링 빈의 필드에 공유 값을 설정하게 되면 정말 무시무시한 야근에 시달리게 될수도 있는 것이에요!

 

💡참고 :
Thread(쓰레드)란? 프로세스는 실행중인 하나의 애플리케이션이고, 쓰레드는 한 프로세스 내에 동작되는 여러 실행 흐름
프로세스는 OS로 부터 할당 받은 작업 단위, 쓰레드는 프로세스가 할당 받은 자원을 이용하는 실행의 단위

자바에서는 JVM(Java Virtual Machin)위에 하나의 프로세스가 돌아가고, 하나의 프로세스 안에서 main Method 하나의 쓰레드가 실행된다. 또한, 쓰레드는 추가가 가능

ThreadLocal이란? ThreadLocal은 Java Class로 ThreadLocal은 오직 한 쓰레드에 의해서 쓰여질 수 있는 변수와 같은 개념으로 두 쓰레드가 같은 코드를 실행하고, 이 코드가 하나의 ThreadLocal 변수를 참조 하더라도 서로의 ThreadLocal 변수를 참조할 수 없다.

즉, ThreadLocal 변수 선언 시 멀티 쓰레드 환경에서 각 쓰레드마다 독립적인 변수를 가지고 접근 가능.

ThreadLocal 활용 : 한 쓰레드에서 실행되는 코드가 동일한 객체를 사용할 수 있도록 해주기 때문에 관련된 코드에서 파라미터를 사용하지 않고, 객체를 각개로 가져다 쓸 때 사용.

1. 사용자 인증 정보 Spring Security에서 사용자마다 다른 인증 정보를 사용할 때나 Session 정보
2. 쓰레드에 안전해야 하는 Data 보관 시

ThreadLocal 주의사항 : 이것은 Memory 누수의 위험이 있기에 주의해야 한다.
Thread pool 환경에서 ThreadLocal을 사용하는 경우 변수에 보관된 Data 사용이 끝나면 반드시 해당 Data를 삭제 해줘야 한다. 그렇지 않은 경우 재 사용되는 쓰레드가 올바르지 않은 Data를 참조할 수 있다. 

 

 

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; //여기가 문제!
	} // order() 끝
    
    public int getPrice() {
          return price;
	} // getPrice() 끝
} // Class 끝

 

위와 같은 코드로 상태를 유지 했을 때 어떤 문제가 발생할까요?

 

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

 

위와 같이 사용자 A가 10,000원어치의 주문을 하고 난 뒤 자신의 주문 금액을 조회하기 전에 사용자 B가 20,000원의 주문을 해 버리면 사용자 A가 주문할 때, 20,000원이 출력되는 어마무시한 일이 발생하는 것이에요.

StatefulService의 price 필드(멤버 변수)는 공유되는 곳인데, 특정 Client가 값을 바꿔 버리는 것이에요.

공유 필드는 정말 조심해야 하고, 스프링 빈은 항상 무상태(stateless)로 설계해야 하는 것이에요.

 

 

 

 

📌 @Configuration과 싱글톤

---

 

 

이상한 점이 있는 것이에요.

위의 코드에서 memberService Bean을 만드는 코드를 보면 memberRepository()를 호출하고, 이것은 다시 new MemoryMemberRepository()를 호출하는 것이에요.

또, orderService Bean을 만드는 코드 역시 memberRepository()를 호출하고, 이것은 다시 new MemoryMemberRepository()를 호출하는 것이에요.

 

각각 다른 2개의 MemoryMemberRepository가 생성되니 싱글톤이 깨져야 하는데, 스프링 컨테이너는 이걸 어떻게 해결할까요?

 

MemberServiceImpl.java

 

OrderServiceImpl.java

 

위의 클래스에 Test용 Getter에 주목해 주시길 바라는 것이에요.

테스트를 위해 MemberRepository를 조회할 수 있는 기능을 추가한 것이에요. 기능 검증을 위해 잠깐 추가한 것이라 인터페이스까지 건들진 않을것이에요.

 

테스트 코드

 

 

 

📖 Test 결과

 

memberRepository 인스턴스는 모두 같은 인스턴스가 공유 되고 있는 것을 볼 수 있는 것이에요.

AppConfig의 자바 코드에서 보면 분명 각각 2번 new MemoryRepository를 호출해서 다른 인스턴스가 생성되는건데, 넘나 신기한 것이에요.

 

 

 

    📍@Configuration과 Bytecode 조작

 

스프링 컨테이너는 위에서도 언급했지만, 싱글톤 레지스트리인 것이에요. 그렇기 때문에 스프링 빈이 싱글톤이 되도록 보장해줘야 하는 것이에요. 그런데, 스프링이 자바 코드까지 조작하긴 어려운 것이에요. 위에 코드를 보면 분명 3번이 호출되어야 하는것인데 말이에요.

그래서 스프링은 클래스의 바이트코드를 조작하는 Library를 사용하는 것이에요.

모든 비밀은 @Configuration을 적용한 AppConfig가 범인인 것이에요.

 

 

AnnotaionConfigApplicationContext에 매개 변수(파라미터)로 넘긴 값은 스프링 빈으로 등록되는 것이에요. 그래서 AppConfig 자체도 스프링 빈이 된답니다!

AppConfig 스프링 빈을 조회해서 클래스 정보를 출력하면 어떤 결과가 나올까요?

 

 

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

 

만약 순수 자바 클래스 였다면 아래와 같이 출력이 되었을 것이에요.

 

class hello.core.AppConfig

 

하지만 결과는 ~~~CGLIB가 붙으면서 상당히 복잡하게 출력이 된 것이에요. 

이것은 현재 개발자가 만든 클래스가 아니라 스프링이 CGLIB라는 바이트 코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이에요.

 

 

그 임의의 다른 클래스가 바로 싱글톤이 되도록 보장하는 것이에요. 

김영한 강사님은 아마도 다음과 같이 바이트 코드를 조작해서 작성 되어 있을 것이라고 예상하셨어요.

(실제 CGLIB의 내부 기술을 사용하는데, 매우 복잡)

 

@Bean public MemberRepository memberRepository() {

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

 

@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 그렇지 않으면 생성해서 스프링 빈으로 등록하여 반환하는 코드가 동적으로 만들어질 것이에요.

그 결과 싱글톤이 보장된답니다!

 

💡참고 :
AppConfig@CGLIB는 AppConfig의 자식 타입이므로, AppConfig 타입으로 조회 가능

 

@Configuration을 적용하지 않고, @Bean만 적용한다면 어떻게 될까요?

@Configuration을 붙이면 바이트 코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만, 붙이지 않고, @Bean만 사용하면 싱글톤을 보장 받을 수 없는 것이에요.

 

정리하자면

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

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

따.라.서 스프링 설정 정보가 담긴 Class에는 무조건 @Configuration을 붙이는 것이 좋은 것이에요!

 

 

 

---

 

백견불여일타 스프링 부트 쇼핑몰 프로젝트 with JPA:이젠 프로젝트다!

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

주니하랑의 글이 마음에 드셨나요? 구독과 공감! 그리고, 댓글 그리고 방명록은 주니하랑에게 많은 힘이 됩니다