Spring

[스프링 핵심 원리 - 기본편] 싱글톤 패턴 1

경딩 2024. 10. 17. 17:22

 

싱글톤 패턴이란

싱글톤 패턴은 인스턴스를 불필요하게 생성하지 않고 오직 하나의 인스턴스만 생성하여 사용하는 디자인패턴이다.

즉, 생성자의 호출이 반복적으로 이루어져도 실제로 생성되는 객체는 최초로 생성된 객체를 반환해 주는 것이다.

 

 

싱글톤 패턴을 사용하는 이유

인스턴스가 단 하나만 존재하는 것을 보증하고 싶은 경우 싱글톤 패턴을 사용한다.

 

장점

  1. 메모리 낭비를 방지해 준다
    1. 이미 생성된 인스턴스를 활용함으로써 속도 측면에서도 장점이 있다.
  2. 데이터 공유가 쉽다.
    1. 싱글톤으로 생성된 객체는 전역성을 띄기 때문에 다른 객체와 공유가 용이하다.
    2. 하지만 만약 여러 클래스의 인스턴스에서 싱글톤 인스턴스의 데이터에 동시에 접근하게 된다면 동시성 문제가 생길 수 있다.

단점

  1. 싱글톤 패턴을 구현하는 코드가 많이 들어간다.
  2. 의존관계상 클라이언트가 구체클래스에 의존하게 되어 DIP , OCP 원칙을 위반할 가능성이 높다. (다른 객체 간의 결합도가 높아진다)
  3. 테스트하기 어렵다. 싱글톤 인스턴스는 자원을 공유하기 때문에 테스트 시 매번 인스턴스 상태를 초기화시켜주어야 한다.
  4. private 생성자로 자식 클래스를 만들기 어렵다.

 

즉 유연성이 떨어져 안티패턴으로 불리기도 한다.

 

 


 

 

웹 애플리케이션과 싱글톤

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

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

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

 

 

 

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 org.springframework.context.annotation.AnnotationConfigApplicationContext;

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();
        // 1. 조회 : 호출할 때마다 객체를 생성
        MemberService memberService2 = appConfig.memberService();

        // 참조값이 다른 것을 확인
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        // memberService1 != memberService2
        assertThat(memberService1).isNotSameAs(memberService2);

    }

 
}

 

스프링 없는 순수한 DI 컨테이너 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.

고객 트래픽이 초당 100 이 나오면 객체가 생성되고 소멸된다. -> 메모리 낭비가 심하다.

해결방안은 해당 객체를 1개만 생성되고, 공유하도록 설계하면 된다.-> 싱글톤 패턴

 

 

싱글톤 코드구현

  • 클래스의 인터턴스가 단 1개만 생성하도록 보장하는 디자인 패턴이다.
    •  static 영역에 객체 instance를 미리 하나 생성해서 올린다. 
    • 객체가 2개 이상 생성하지 못하도록 private 생성자를 사용하여 외부에서 임의로 new 키워드를 사용하지 못하게 막아야 한다.
    • 이 객체 인스턴스는 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드 호출 시 항상 같은 인스턴스가 반환된다
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
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest() {
        //new SingletonService(); - private 으로 생성자를 막아두어 컴파일 오류가 발생한다.
        SingletonService instance1 = SingletonService.getInstance();
        SingletonService instance2 = SingletonService.getInstance();

        System.out.println("memberService1 = " + instance1);
        System.out.println("memberService2 = " + instance2);
        assertThat(instance1).isSameAs(instance2);
        instance1.logic();
        // same == (참조비교)
        // equl
    }
  • 호출할 때마다 같은 인스턴스가 반환되는 것을 확인할 수 있다

 


 

싱글톤 컨테이너

 

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

스프링빈은 기본적으로 싱글톤으로 관리된다.

 

 

싱글톤 컨테이너

  • 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
    • 컨테이너는 객체를 하나만 생성해서 관리한다,
  • 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다, 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.
  • 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.
    • 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 된다.
    • DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 관리할 수 있다.

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

 

    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
        AnnotationConfigApplicationContext 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; // 상태를 유지하는 필드 10000 -> 20000

    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.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 bean1 = ac.getBean(StatefulService.class);
        StatefulService bean2 = ac.getBean(StatefulService.class);

        // ThreadA : A 사용자 10000원 주문
         bean1.order("userA", 10000);
        // ThreadB : B 사용자 20000원 주문
        bean2.order("userB", 20000);
        int price = bean1.getPrice();
        
        // ThreadA : 사용자 A 는 10000원을 기대했지만, 기대와 다르게 20000원 출력
        System.out.println("price = " + price);

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

    static class TestConfig {

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



}
  • ThreadA 가 사용자 A  코드를 호출하고 ThreadB 가 사용자 B 코드를 호출한다.
  • StatefulService 의 price 필드는 공유되는 필드인데, 특정 클라이언트가 값을 변경한다.
  • 사용자A 의 주문 금액은 10000 원이 되어야 하는데 20000 원 이라는 결과가 나왔다,
  • 공유필드대신 지역변수를 사용해보자! 스프링빈은 항상 무상태(stateless) 로 설계하자.

 

참고 자료: 

https://dev-coco.tistory.com/109

김영한 - [스프링 핵심원리 - 기본 편] 中 싱글톤 컨테이너