본문 바로가기

Backend/Spring

싱글톤 컨테이너

앱 애플리케이션과 싱글톤

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

 

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

// SingletonTest.java
package ghdtjgus76.core.singleton;

import ghdtjgus76.core.AppConfig;
import ghdtjgus76.core.member.MemberService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.AssertionsForClassTypes.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는 요청할 때마다 객체를 새로 생성한다.

그래서 메모리 낭비가 심할 수 있다.

이에 대한 해결 방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. => 싱글톤 패턴

 

싱글톤 패턴

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

그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.

이는 private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 하면 된다.

// SingletonService.java
package ghdtjgus76.core.singleton;

public class SingletonService {
	private static final SingletonService instance = new SingletonService();
    
    public static SingletonService getInstance() {
    	return instance;
    }
    
    private SingletonService() {}
    
    public void logic() {
    	System.out.println("싱글톤 객체 로직 호출");
    }
}

위 코드에 대해서 조금 더 알아보자.

 

static 영역에 객체 인스턴스를 미리 하나 생성해둔다.

이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다.

이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.

1개의 객체 인스턴스만 존재해야 하기 때문에 생성자를 private으로 막아서 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

 

// SingletonTest.java
package ghdtjgus76.core.singleton;

import ghdtjgus76.core.AppConfig;
import ghdtjgus76.core.member.MemberService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.AssertionsForClassTypes.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);
    }

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

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

        assertThat(singletonService1).isSameAs(singletonService2);
    }
}

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

 

하지만 싱글톤 패턴은 다음과 같은 많은 문제점을 가지고 있다.

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

- 의존 관계상 클라이언트가 구체 클래스에 의존한다. -> DIP 위반, OCP 위반

- 테스트하기 어렵다.

- 내부 속성을 변경하거나 초기화하기 어렵다.

- private 생성자로 자식 클래스를 만들기 어렵다.

- 유연성이 떨어지고 안티 패턴으로 불리기도 한다.

 

싱글톤 컨테이너

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

스프링 빈은 싱글톤으로 관리되는 빈이다.

 

스프링 컨테이너는 추가적으로 싱글톤 패턴을 적용해야 하는 게 아니라 기본적으로 객체 인스턴스를 싱글톤으로 관리한다.

스프링 컨테이너는 싱글톤 컨테이너 역할을 하는데, 싱글톤 객체를 생성하고 관리하는 기능을 레지스트리라고 한다.

 

그래서, 스프링 컨테이너를 사용하면 싱글톤 패턴을 위한 지저분한 코드가 들어가지 않아도 되고, DIP, OCP, 테스트, private 생성자로부터 자유롭게 싱글톤을 사용할 수 있게 된다.

// SingletonTest.java
package ghdtjgus76.core.singleton;

import ghdtjgus76.core.AppConfig;
import ghdtjgus76.core.member.MemberService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.AssertionsForClassTypes.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);
    }

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

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

        assertThat(singletonService1).isSameAs(singletonService2);
    }

    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
//        AppConfig appConfig = new AppConfig();
        ApplicationContext 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 등을 사용해야 한다.

 

상태를 유지할 경우 발생할 수 있는 문제점

// StatefulService.java
package ghdtjgus76.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;
    }
    
    public int getPrice() {
    	return price;
    }
}
// StatefulServiceTest.java
package ghdtjgus76.core.singleton;

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.assertj.core.api.AssertionsForClassTypes.assertThat;
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);

        // ThreadB: B 사용자 20000원 주문
        statefulService2.order("userB", 20000);

        // ThreadA: A 사용자 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price = " + price);

        assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }
    
    static class TestConfig {
    	@Bean
        public StatefulService statefulService() {
        	return new StatefulService();
        }
    }
}

 

무상태로 설계한 코드

// StatefulService.java
package ghdtjgus76.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;
//    }
}
// StatefulServiceTest.java
package ghdtjgus76.core.singleton;

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.assertj.core.api.AssertionsForClassTypes.assertThat;
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);

        // ThreadB: B 사용자 20000원 주문
        int userBPrice = statefulService2.order("userB", 20000);

        // ThreadA: A 사용자 주문 금액 조회
//        int price = statefulService1.getPrice();
        System.out.println("price = " + userAPrice);

        assertThat(userAPrice).isEqualTo(10000);
    }

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

 

@Configuration과 싱글톤

// AppConfig.java
package ghdtjgus76.core;

import ghdtjgus76.core.discount.DiscountPolicy;
import ghdtjgus76.core.discount.FixDiscountPolicy;
import ghdtjgus76.core.discount.RateDiscountPolicy;
import ghdtjgus76.core.member.MemberRepository;
import ghdtjgus76.core.member.MemberService;
import ghdtjgus76.core.member.MemberServiceImpl;
import ghdtjgus76.core.member.MemoryMemberRepository;
import ghdtjgus76.core.order.OrderService;
import ghdtjgus76.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

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

위 코드만 보면 memberService 빈을 만드는 코드에서 memberRepository()를 호출하고, orderService 빈을 만드는 코드에서도 memberRepository()를 호출해서 다른 두 개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보인다.

 

확인해보자.

// MemberServiceImpl.java
package ghdtjgus76.core.member;

public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;

    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }

    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}
// OrderServiceImpl.java
package ghdtjgus76.core.order;

import ghdtjgus76.core.discount.DiscountPolicy;
import ghdtjgus76.core.discount.FixDiscountPolicy;
import ghdtjgus76.core.discount.RateDiscountPolicy;
import ghdtjgus76.core.member.Member;
import ghdtjgus76.core.member.MemberRepository;
import ghdtjgus76.core.member.MemoryMemberRepository;

public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        Member member = memberRepository.findById(memberId);
        int discountPrice = discountPolicy.discount(member, itemPrice);

        return new Order(memberId, itemName, itemPrice, discountPrice);
    }

    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}
// ConfigurationSingletonTest.java
package ghdtjgus76.core.singleton;

import ghdtjgus76.core.AppConfig;
import ghdtjgus76.core.member.MemberRepository;
import ghdtjgus76.core.member.MemberServiceImpl;
import ghdtjgus76.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.AssertionsForClassTypes.assertThat;

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 -> memberRepository = " + memberRepository1);
        System.out.println("orderService -> memberRepository = " + memberRepository2);
        System.out.println("memoryMemberRepository = " + memberRepository);

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

확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

 

AppConfig에 호출 로그 추가

// AppConfig.java
package ghdtjgus76.core;

import ghdtjgus76.core.discount.DiscountPolicy;
import ghdtjgus76.core.discount.FixDiscountPolicy;
import ghdtjgus76.core.discount.RateDiscountPolicy;
import ghdtjgus76.core.member.MemberRepository;
import ghdtjgus76.core.member.MemberService;
import ghdtjgus76.core.member.MemberServiceImpl;
import ghdtjgus76.core.member.MemoryMemberRepository;
import ghdtjgus76.core.order.OrderService;
import ghdtjgus76.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 RateDiscountPolicy();
    }
}

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

 

@Configuration과 바이트코드 조작

스프링 컨테이너는 싱글톤 레지스트리이다.

따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.

 

하지만 자바 코드 상에서는 분명 3번 호출이 되어야 하는 것이 맞는데, 스프링이 클래스의 바이트 코드를 조작하는 라이브러리를 사용해서 이를 처리해준다.

// ConfigurationSingletonTest.java
package ghdtjgus76.core.singleton;

import ghdtjgus76.core.AppConfig;
import ghdtjgus76.core.member.MemberRepository;
import ghdtjgus76.core.member.MemberServiceImpl;
import ghdtjgus76.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.AssertionsForClassTypes.assertThat;

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 -> memberRepository = " + memberRepository1);
        System.out.println("orderService -> memberRepository = " + memberRepository2);
        System.out.println("memoryMemberRepository = " + memberRepository);

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

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

        AppConfig bean = ac.getBean(AppConfig.class);
        System.out.println("bean = " + bean.getClass());
        // bean = class ghdtjgus76.core.AppConfig$$SpringCGLIB$$0
    }
}

AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다.

그래서 AppConfig도 스프링 빈이 된다.

AppConfig 스프링 빈을 조회해서 클래스 정보를 출력하면 위와 같은 결과가 나온다.

 

위 결과는 스프링이 CGLIB이라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

그 임의의 다른 클래스는 싱글톤이 보장되도록 해준다.

 

AppConfig@CGLIB 예상 코드

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

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

이렇게 싱글톤이 보장되는 것이다.

 

AppConfig@CGLIB는 AppConfig의 자식 타입이기 때문에 AppConfig 타입으로 조회할 수 있는 것이다.

 

@Configuration을 붙이면 바이트 코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하게 된다.

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

 

'Backend > Spring' 카테고리의 다른 글

의존 관계 자동 주입  (0) 2023.08.03
컴포넌트 스캔  (0) 2023.08.02
스프링 컨테이너와 스프링 빈  (0) 2023.08.02
스프링 예제-2  (0) 2023.08.02
스프링 예제-1  (0) 2023.08.02