[Spring Boot] 싱글톤 패턴 vs 싱글톤 컨테이너 ( @Configuration)

 

📑 웹 애플리케이션과 싱글톤

 

웹 애플리케이션은 보통 여러 고객이 동시에 요청을 다. 그때 DI 컨테이너에서는 요청할 때 마다 객체를 새로 생성한다. 예를들어 같은 memberService를 호출했을 때 결과값은 다 다른 주소값을 가진 다른 객체들을 생성한다. 이는 메모리 낭비가 심하다. 따라서 객체 1개만 생성되고, 이 객체를 공유하도록 설계하면 된다. 이게 바로 싱글톤 패턴인 것.! 

 

 

@Test
@DisplayName("스프링 없는 순수한 DI 컨테이너")
void pureContainer(){
    AppConfig config = new AppConfig();
    //1. 조회 : 호출할 때마다 객체 생성
    MemberService memberService = config.memberService();

    //2. 조회 : 호출할 때마다 객체 생성
    MemberService memberService2 = config.memberService();

    //참조값이 다른 것을 확인
    System.out.println("memberService = " + memberService);
    System.out.println("memberService2 = " + memberService2);
    //이런식으로 계속 객체를 생성하는 것은 효율적이지 못함.

    assertThat(memberService).isNotSameAs(memberService2);

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

 

 

 

 

📑 싱글톤 패턴

 

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

 

1. static 영역에 객체 instance를 미리 하나 생성해서 올려둔다.
2. 이 객체 인스턴스가 필요하면 오직 getInstance() 메서드를 통해서만 조회할 수 있다. 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를  private로 막아 혹시 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다. 

 

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("싱글톤 객체 로직 호출");
    }
}

 

 

🔨 다른 클래스에서 새로운 객체를 생성하려고 하면 에러뜨는 거 확인.!

 

 

SingletonService.getInstance를 통해 2번 호출해도 같은 객체인 걸 확인할 수 있다.

 

 

 

BUT) 싱글톤 패턴은 문제점이 있다.

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

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

- 클라이언트가 구체 클래스에 의존하기에 OCP 원칙 또한 위반할 가능성이 없다.

- - - - - - 등등등 따지면 결론적으로 유연성이 떨어진다. 따라서 이를 해결하기 위해 싱글톤 컨테이너라는 단어가 나온 것!

 

 

 

📑 싱글톤 컨테이너

 

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다. 스프링 컨테이너 그 자체가 싱글톤 컨테이너 역할을 한다. 즉) 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스터라한다. 

 

@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer(){

//      AppConfig config = new AppConfig();
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    //ac.getBean(빈이름, 타입)
    MemberService memberService = ac.getBean("memberService", MemberService.class);
    MemberService memberService2 = ac.getBean("memberService", MemberService.class);


    System.out.println("memberService = " + memberService);
    System.out.println("memberService2 = " + memberService2);


    assertThat(memberService).isSameAs(memberService2);
    // assertThat(memberService).isEqualTo(memberService2); true

}

 

                                              

싱글톤 컨테이너를 적용함으로써 고객이 요청올 때 마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 효율적으로 재사용할 수 있다. 

 

 

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기에 상태는 유지(stateful)하게 설계하면 안되고 무상태(stateless)로 설계해야한다. 특정 클라이언트에 의존적인 필드가 있음 안되고, 값을 변경할 수 있는 필드가 있음 안 된다. 개발할 때 항시 조심해야한다.

 

아래 클래스는 예제!

package hello.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;
    }*/
}

 

 

 

📑 @Configuration과 싱글톤

 

스프링 컨테이너는 싱글톤 레지스트리다. 따라서 스프링 빈이 싱글톤이 되도록 보장해줘야한다. 모든 비밀은 @Configuration 어노테이션에 있다. 

 

만약) Configuration을 사용하지 않는다면? 일단) @Bean 어노테이션이 있으니까 스프링 컨테이너는 스프링 빈을 호출한다. 테스트 코드에서 memberService, memberRepository, orderService 이렇게 3번 MemberRepository.class 타입의 객체를 호출하게 되는데, 이렇게 되면 각각 다른 객체값을 가져와 다른 3개의 객체가 생성된다. 이는 싱글톤 방식이 적용되었다고 할 수 없게 된다. 

 

@Test
@DisplayName("스프링에서 싱글톤을 어떻게 유지하는가")
void configurationTest(){
    ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
    //ac.getBean(빈이름, 타입)
    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("memberRepository1 = " + memberRepository1);
    System.out.println("memberRepository2 = " + memberRepository2);
    System.out.println("memberRepository = " + memberRepository);

    Assertions.assertThat(memberRepository1).isEqualTo(memberRepository);
    Assertions.assertThat(memberRepository2).isEqualTo(memberRepository);
}

 

 

🔨 @Configuration 이 어노테이션이 대체 무슨 능력이 있길래? 

 

AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. AppConfig도 스프링 빈이 된다. 만약 AppConfig가 순수 클래스라면 class hello.core.AppConfig 이와 같이 출력되어야 하는데, 예상과는 다르게 복잡한 클래스를 출력하는 걸 확인할 수 있다. 즉) 이것은 내가 만든 클래스가 아니라 스프링이 바이트코드 조작 라이브러리를 사용해 AppConfig 클래스를 상속받은 임의의 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다.

 

 

 

아마 이렇게 생성한 AppConfig@CGLIB의 예상 코드는 만약 @Bean이 붙은 메서드마를 호출했을 때 이미 스프링 빈이 존재하면 그 빈을 반환하고, 없으면 스프링 빈으로 등록하는 작업이 반복될 것이다. 따라서!!! memberRepository가 3번 호출되는 로직이라도, 같은 빈으로 판단해서 객체 1개만 생성하게 되는 것이다. 

 

📌 따라서 싱글톤을 보장하기 위해선 스프링 설정 정보 클래스에 @Configuration을 사용하자.!