Lee ChangMin

기록 블로그

스프링 기본원리(6)

4 minute read

싱글톤

웹 애플리케이션과 싱글톤

  • 스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.
  • 대부분의 스프링 애플리케이션은 웹 애플리케이션이지만 웹이 아닌 것도 개발 가능하다.
  • 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

싱글톤을 사용하지 않았을때의 문제점

다음의 코드는 스프링을 사용하지 않은 코드이다.

    void pureContainer(){
        AppConfig appConfig = new AppConfig();
        MemberService memberService1 = appConfig.memberService();
        MemberService memberService2 = appConfig.memberService();
        System.out.println("system1+"+memberService1);
        System.out.println("system2+"+memberService2);
    }

-> 해당 코드를 출력해보면 각 MemberService의 주소지가 다르므로 서로 다른 객체라는걸 알 수 있다.

  1. 고객 트래픽이 초당 10000이 나오면 초당 10000개 객체가 생성되고 소멸된다. -> 메모리 낭비가 심하다.
  2. 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계 하자 -> 싱글톤 패턴

싱글톤 패턴

  1. 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
  2. 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야한다. -> private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야한다.

싱글톤 패턴 적용해보기

public class SingletonService {
    // static 으로 설정하면 클래스 레벨에 올라가서 딱 하나만 존재하게 된다.
    private static final SingletonService instance = new SingletonService();

    public static  SingletonService getInstance(){
        return instance;
    }
    private SingletonService(){
        // 다른곳에선 생성하지 못하도록 막음
    }
    public void logic(){
        System.out.print("싱글톤 객체 로직 호출");
    }
}
  • static 영역에 객체 instance를 하나 생성해서 올려두면 딱 하나만 존재하게 된다.
  • 이 객체 인스턴스가 필요하면 오직 getInstance()메서드를 통해서만 조회 가능하다.
  • getInstance()를 호출하면 항상 같은 인스턴스를 반환한다.
  • private 생성자로 인해서 외부에서 new 키워드로 생성되는 것을 막는다.

테스트 해보기

    @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용해보기")
    void singletonServiceTest(){
        SingletonService instance1 = SingletonService.getInstance();
        SingletonService instance2 = SingletonService.getInstance();
        System.out.println("instance1= "+instance1);
        System.out.println("instance2= "+instance2);
        Assertions.assertThat(instance1).isSameAs(instance2);
    }

해당 결과 값으로 다음과 같은 결과가 나온다.

GitHub Logo

-> 호출할 때 마다 같은 객체 인스턴스를 반환하는 것을 확인 할 수 있다. -> 스프링은 이 싱글톤 기능을 스프링 컨테이너로 제공!

싱글톤 패턴의 문제점

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

  1. 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
  2. 의존관계상 클라이언트가 구체 클래스에 의존한다. -> DIP를 위반한다.
  3. 클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
  4. 테스트하기 어렵다.
  5. 내부 속성을 변경하거나 초기화 하기 어렵다.
  6. private 생성자로 자식 클래스를 만들기 어렵다.
  7. 결론적으로 유연성이 떨어진다.
  8. 안티패턴으로 불리기도 한다.

싱글톤 컨테이너

스프링 컨터이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤으로 관리한다. 스프링 빈이 싱글톤으로 관리되는 빈이다.

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

싱글톤 컨테이너 적용해보기

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer(){
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
    MemberService instance1 = ac.getBean("memberService",MemberService.class);
    MemberService instance2 = ac.getBean("memberService",MemberService.class);
    System.out.println("instance1+"+instance1);
    System.out.println("instance2+"+instance2);
}

결과 값으로 다음과 같이 나온다.

GitHub Logo -> 같은 인스턴스인걸 확인 할 수 있다.

싱글톤 방식의 주의점

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

  • 무상태(stateless)로 설계 해야한다.
  • 특정 클라이언트에 의존적인 필드가 있으면 안된다.
  • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
  • 가급적 읽기만 가능해야한다.
  • 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, 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 {
    static class TestConfig{
        @Bean
        public StatefulService statefulService(){
            return new StatefulService();
        }
    }
    @Test
    void statefulServiceSinglton(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        //ThreadA가 주문
        statefulService1.order("userA",10000);
        //ThreadB가 주문
        statefulService2.order("userB",20000);

        int price  = statefulService1.getPrice();
        System.out.println(price);
    }
}

GitHub Logo -> Test 코드에서 userA가 주문한 금액을 보면 10000원이 나와야 하지만 20000원이 나오게 된다!

  • StatefulService의 price 필드는 공유되는 필드로, 특정 클라이언트가 값을 변경한다.
  • 공유필드는 매우 조심해야한다. 스프링 빈은 항상 무상태로 설계하자.

해결방안으로는 다음과 같은 코드로 변환하여 StatefulService를 수정하여 price를 반환하게 하자.

public class StatefulService {

    //private int price; //상태를 유지하는 필드

    public int order(String name, int price){
        System.out.println("name = "+name+" price = "+price);
        return price; 
    }
}

Configuration과 싱글톤

다음 AppConfig 코드를 살펴보자


@Configuration
public class AppConfig {
    @Bean
    public MemberService memberService(){
        return new MemberServiceImpl(memberRepository());
    }
    @Bean
    public MemoryMemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
    @Bean
    public OrderService orderService(){
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }
    @Bean
    public DiscountPolicy discountPolicy() {
        return new RateDicountPolicy();
    }
}
  • memberService 빈을 만드는 코드를 보면 memberRepository() 를 호출한다. 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다.
  • orderService 빈을 만드는 코드도 동일하게 memberRepository() 를 호출한다. 이 메서드를 호출하면 new MemoryMemberRepository() 를 호출한다. -> 결과적으로 각각 다른 2개의 MemoryMemberRepository 가 생성되면서 싱글톤이 깨지는 것 처럼 보인다. 하지만 호출해보면 모두 같은 MemberRepository를 가지는 것을 알 수 있다.

Configuraton과 바이트코드 조작

스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 하기 때문에 스프링은 바이트코드를 조작하는 라이브러리를 사용한다.

@Test
void configurationDeep(){
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
    AppConfig bean = ac.getBean(AppConfig.class);
    System.out.println("bean = "+bean.getClass());
}

위의 코드를 실행하면 아래와 같은 문구가 나와야 한다.

class hello.core.AppConfig

하지만 아래와 같은 코드가 나오게 된다.

bean = class hi.practicespring.AppConfig$$EnhancerBySpringCGLIB$$6018a6f3

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

GitHub Logo

그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다. 아마도 다음과 같이 바이트 코드를 조작해서 작성되어 있을 것이다.(실제로는 CGLIB의 내부 기술을 사용하는데 매우 복잡하다.

아래는 AppConfig@CGLIB 예상 코드이다.

@Bean
public MemberRepository memberRepository() {
 
    if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
        return 스프링 컨테이너에서 찾아서 반환;
    } else { //스프링 컨테이너에 없으면 기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
        return 반환
    }  
}
  • @Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다. -> 싱글톤 보장
  • 만약 @Configuration 을 붙이지 않는다면? -> memberRepository()가 호출될 때마다 서로 다른 MemberRepository가 생성되어 싱글톤이 깨지게 된다.

출처 : 인프런 김영한의 스프링 핵심원리 기본편

Leave a comment

You may also enjoy

개인정보처리방침

July 04 2023

< ChangMinCompany >(‘null’이하 ‘null’)은(는) 「개인정보 보호법」 제30조에 따라 정보주체의 개인정보를 보호하고 이와 관련한 고충을 신속하고 원활하게 처리할 수 있도록 하기 위하여 다음과 같이 개인정보 처리방침을 수립·공개합니다.