싱글톤 패턴을 보장해주는 스프링 컨테이너와 @Configuration

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

- 싱글톤 패턴

- 싱글톤 컨테이너

- 싱글톤 방식의 주의점

- @Configuration과 싱글톤

- @Configuretion과 바이트 코드 조작의 마법

 

 

📌싱글톤 패턴

 

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

package singleton;

import com.example.core.AppConfig;
import com.example.core.member.MemberService;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

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


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

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

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

 

👧  계속해서 서비스를 호출할 때 참조값이 달라 메모리에 계속해서 올라간다. 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 하는데, 요청이 올 때마다 객체를 계속해서 만들어야 해 메모리 낭비가 심하다.

 

✅ 싱글톤 패턴을 적용해 보자

 

 👧  싱글톤 패턴? 클래스의 인스턴스가 딱 1개만 생성되는 디자인 패턴으로 객체 인스턴스를 2개 이상 생성하지 못하도록 한다.

 

package singleton;

public class SingletonService {

    //static 영역에 객체 instance를 하나 생성해서 올린다.
    private static final SingletonService instance = new SingletonService();

    // getInstance()메서드를 통해서만 조회할 수 있다.
    public static SingletonService getInstance(){
        return instance;
    }


    //딱 1개의 객체 인스턴스만 존재야하 하므로, 생성자를 private로 만들어 외부에서 생성되는것을 막는다.
    private SingletonService(){
        
    }
    
    public  void logit(){
        System.out.println("싱글톤 객체 로직 호출");
    }
    
}

 

👧 어떻게 싱글톤 패턴이 구현했나? static 메모리에 객체 인스턴스를 하나 생성했다. 메서드를 통해서 조회할 수 있게 했다. 그리고 생성자 private로 외부에서 호출 되는것을 막았다.

 

✅ 싱글톤 패턴의 문제점

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

 

✅ 싱글톤 패턴의 문제점을 해결해보자, 어떻게? 싱글톤 컨테이너로!

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

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

        //1. 조회 : 호출할 때 마다 객체를 생성할까?
        MemberService memberService1 = ac.getBean("memberService",MemberService.class);
        
        //2. 조회 : 호출할 때 마다 객체를 생성할까?
        MemberService memberService2 = ac.getBean("memberService",MemberService.class);

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

        //memberService1 == memberService2
        assertThat(memberService1).isSameAs(memberService2);
    }

 

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

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

 

 

📌싱글톤 방식은 Stateless(무상태)로 설계 되야한다!

싱글톤 패턴은 여러 클라이언트가 하나의 같은 객체 인스턴스를 '공유'해서 써서 statefule(유지) 되도록 설계되면 안된다.

✅ 무상태(stateless) 설계

  - 특정 클라이언트에 의존적인 필드가 있으면 안된다.

  - 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.

  - 가급적 읽기만 가능해야한다.

  - 필드 대신에 자바에서 공유되지 않는 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

  - 스프링 빈의 필드에 공유 값을 설정하면 장애 발생할 수 있다.

 

✅ Stateful 예제

 

package singleton;

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;
    }
}

package 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.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);

        //Thread A : A사용자가 10000원을 주문
        stateFulService1.order("userA",10000);

        //Thread B: B사용자가 10000원을 주문
        stateFulService2.order("userB",20000);

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


    }


    static class TestConfig{

        @Bean
        public StateFulService stateFulService(){
            return new StateFulService();
        }
    }
}

 

- 중간 사용자 B(특정 클라이언트)가 값을 바꼈다.

- 공유 필드는 조심해야 한다. 스프링 빈은 항상 무상태로 설계해야 한다.

 

stateless 예제

package singleton;

public class StateFulService {
    public int order(String name, int price){
        return price;
    }
}

stateful예제와 비교해서 봤을 때, 공유 필드를 사용하지 않고 return으로 넘겨았다.

 

📌 @Configuration과 싱글톤

 Appconfig에서 MemoryMemberRepository가 2번 호출되고 있다. 싱글톤이 깨지는 것이 아닐까?

package singleton;

import com.example.core.AppConfig;
import com.example.core.member.MemberRepository;
import com.example.core.member.MemberServiceImpl;
import order.OrderServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;


import static org.assertj.core.api.Assertions.assertThat;


public class ConfigurationSingletonTest {

    @Test
    void configurationTest(){
        AnnotationConfigApplicationContext 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();

        //세번의 new를 하는데 왜 같은가?

        System.out.println("memberService-> memberRepository = " + memberRepository1);
        System.out.println("orderService-> memberRepository = " + memberRepository2);
        System.out.println("memberRepository = " + memberRepository);


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

    }
}

결과값을 확인해 보면 같은 객체라는 것을 확인할 수 있었다.

AppConfig의 자바 코드에서는 2번의 new MemoryMemberRepository 호출하는데 왜 같은 객체일까?

 

✅  @Configuration과 바이트 코드 조작

 스프링 컨테이너는 싱글톤 레지스트리로 스프링 빈이 싱글톤이 되도록 보장해야 하나 자바 코드까지 처리하긴 어렵다.

@Configuration을 사용 CGLIB로 싱글톤을 보장한다.

 

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

        System.out.println("bean = " + bean.getClass());
    }

 

-> 스프링은 CGLIB라는 바이트코드 조작 라이브러리로 AppConfig 클래스를 상속받아 다른 임의 클래스를 만들어 스프링을 등록한다.

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

-> 이 임의 클래스가 싱글톤이 보장되도록 보장해준다.

 

✅  @Configuration를 적용 안하고 @Bean만 한다면?

 - @Configuration 을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장한다고 했다. but 안한다면?

 -  memberRepository은 3번 출력해 싱글톤을 보장 안한다!

 

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

 

👧  스프링 설정 정보는 항상 @Configuration 을 사용하자.

 

 

REFERENCE

---

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의