스프링 핵심 원리 Section 5. 싱글톤 컨테이너

Bae YuSeon·2024년 5월 16일
Spring
0

spring스터디

목록 보기
12/15
post-thumbnail

김영한 강사님이 제공하시는 인프런 - "스프링 입문 - 스프링 핵심 원리 - 기본편" 강의를 듣고 정리한 내용입니다
강의 링크
김영한 - 스프링 핵심 원리 - 기본편 (유료강의)

1강) 웹 애플리케이션과 싱글톤

  • 스프링: 기업용 온라인 서비스 기술을 지원하기 위해 탄생
  • 대부분의 스프링 애플리케이션 = 웹 애플리케이션
    (웹이 아닌 애플리케이션 개발도 가능함)
  • 웹 애플리케이션: 보통 여러 고객이 동시에 요청

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

  • 스프링 없는 순수한 DI 컨테이너(AppConfig)는 요청을 할 때 마다 새로운 객체를 생성
  • 고객 트래픽이 초당 100이 나오면 초당 100개의 객체가 생성되고 소멸
    → 메모리 낭비 문제
    ⇒ 해결 방안 : 싱글톤 패턴으로 해당 객체를 1개만 생성되고, 공유하도록 설계

src/test/java/hello.core/singleton/SingletonTest.java

public class SingletonTest {
    
    @Test
    @DisplayName("스프링 없는 순수한 DI 컨테이너")
    void pureContainer() {
        AppConfig appConfig = new AppConfig();
        // 호출할 때 마다 객체를 생성
        MemberService memberService1 = appConfig.memberService();

        // 호출할 때 마다 객체를 생성
        MemberService memberService2 = appConfig.memberService();

        // 위에서 생성한 객체 2개의 참조값이 다른 것을 확인
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        // memberService1 != memberService2 (두 객체가 다른지) 검증
        Assertions.assertThat(memberService1).isNotSameAs(memberService2);
    }
}

실행하면 appConfig의 memberService()를 호출해 생성된 MemberServiceImpl 2개는 다른 인스턴스라는 결과를 볼 수 있다.

2강) 싱글톤 패턴

싱글톤 패턴

  • 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴
  • 객체 인스턴스를 2개 이상 생성하면 안되므로, private 생성자를 사용해 외부에서 임의로 new 키워드를 사용하지 못하도록 막음

싱글톤 패턴을 적용한 예제 코드

src/test/java/hello.core/singleton/SingletonService.java
(main이 아닌 test 위치에 생성)

public class SingletonService {

    //static 영역에 외부에서 접근하지 못하도록 private으로 객체를 딱 1개만 생성
    private static final SingletonService instance = new SingletonService();

    // Singleton 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 public으로 선언
    public static SingletonService getInstance() {
        return instance;
    }

    // 외부에서 new로 객체를 생성하는 것을 막기 위한 private 생성자
    private SingletonService() {
    }

    public void logic() {
        System.out.println("싱글톤 객체 로직 호출");
    }
}
  • SingletonService 클래스 static 영역에 객체 instance 1개를 미리 생성
  • SingletonService 객체 인스턴스가 필요하면 public으로 선언된 getInstance()를 통해서만 조회 가능. 이 메서드를 호출하면 항상 같은 인스턴스 반환
  • 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 선언해 외부에서 new 키워드로 객체 인스턴스가 생성되는 것 방지

싱글톤 패턴을 사용하는 테스트 코드

src/test/java/hello.core/singleton/SingletonTest.java

public class SingletonTest {
    ...
    
    @Test
    @DisplayName("싱글톤 패턴을 적용한 객체 사용")
    void singletonServiceTest() {
        //호출할 때 마다 같은 객체 반환
        SingletonService singletonService1 = SingletonService.getInstance();
        //호출할 때 마다 같은 객체 반환
        SingletonService singletonService2 = SingletonService.getInstance();

        // getInstance()로 얻은 객체 인스턴스 2개의 참조값이 같은지 확인
        System.out.println("singletonService1 = " + singletonService1);
        System.out.println("singletonService2 = " + singletonService2);

        // singletonServcie1 == singletonService2 (두 객체 인스턴스가 같은지 검증)
        assertThat(singletonService1).isSameAs(singletonService2);

        singletonService1.logic();
    }
}

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

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

3강) 싱글톤 컨테이너

스프링 컨테이너: 싱글톤의 문제점 해결 & 객체 인스턴스를 싱글톤(1개만 생성)으로 관리

싱글톤 컨테이너

  • 스프링 컨테이너는 싱글턴 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리
  • 스프링 컨테이너가 싱글톤 컨테이너 역할
    → 이렇게 싱글톤 객체를 생성하고 관리하는 기능: 싱글톤 레지스트리
    → 스프링 컨테이너의 이런 기능 덕분에 싱글턴 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지 가능

스프링 컨테이너를 사용하는 테스트 코드
src/test/java/hello.core/singleton/SingletonTest.java

public class SingletonTest {
	...

    @Test
    @DisplayName("스프링 컨테이너와 싱글톤")
    void springContainer() {
        // 스프링 컨테이너 생성
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        // 호출할 때 마다 같은 객체를 반환
        MemberService memberService1 = ac.getBean("memberService", MemberService.class);
        // 호출할 때 마다 같은 객체를 반환
        MemberService memberService2 = ac.getBean("memberService", MemberService.class);

        // 위에서 반환된 객체 2개의 참조값이 값은지 확인
        System.out.println("memberService1 = " + memberService1);
        System.out.println("memberService2 = " + memberService2);

        // memberService1 == memberService2 (두 객체가 값은지) 검증
        assertThat(memberService1).isSameAs(memberService2);
    }
}

싱글톤 컨테이너 적용 후

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

4강) 싱글톤 방식의 주의점

  • 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유
    ⇒ 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안되고 무상태(stateless)로 설계!
    • 특정 클라이언트에 의존적인 필드가 있으면 안된다.
    • 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다!
    • 가급적 읽기만 가능해야 한다.
    • 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

상태를 유지할 경우 발생하는 문제점 예시
1. StatefulService 코드 작성

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;
  }
}
  • 상태를 유지하는 필드 → 클라이언트가 order()를 호출하면 넘어온 파라미터 price 값이 필드 값(price)를 변경하는 문제

  1. StatefulServiceTest 코드 작성

    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);     // 20000원 출력(중간에 사용자B가 price를 바꾸었기 때문)
     
     // A사용자 주문 금액이 20000원인지 검증
     assertThat(statefulService1.getPrice()).isEqualTo(20000);
 }

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

}

  2. 결과

    • 실제로 A사용자의 주문 금액은 10000원이지만 20000원이라는 결과가 나온다.
      사용자 A가 주문을 하고 금액을 조회하기 전에 사용자 B가 주문을 하면서 필드값(price)가 변경되기 때문이다.

문제 해결

  • 공유 필드 → 지역 변수 사용
    • 원래는 price를 공유필드로 사용했지만, order() 메서드 내에서 지역변수 price를 그대로 리턴하는 방식으로 변경

  1. StatefulService 코드 수정

    public class StatefulService {

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

  2. StatefulServiceTest 코드 수정

    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 userA = statefulService1.order("userA", 10000);
     // ThreadB: B사용자 20000원 주문
     int userB = statefulService2.order("userB", 20000);

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

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

  3. 결과

5강) @Configuration과 싱글톤

AppConfig의 의문점

@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 FixDiscountPolicy();     // 고정 할인 정책으로
        return new RateDiscountPolicy();    // 정률 할인 정책으로 변경
    }
}

위의 코드에서
memberService 빈을 만드는 코드

 @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

@Bean memberService 등록 → memberRepository() 호출 → new MemoryMemberRepository() 호출한다.

orderService 빈을 만드는 코드도 동일하게

@Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

@Bean orderService 등록 → memberRepository() 호출 → new MemoryMemberRepository() 호출한다.

memberRepository 빈을 만드는 코드도

@Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();    // 메모리 회원 저장소로
    }

@Bean memberRepository 등록 → new MemoryMemberRepository() 호출한다

⇒ 결과적으로 new MemoryMemberRepository() 가 3번 호출되면서 싱글톤이 깨지는 것 처럼 보인다!
스프링 컨테이너는 싱글톤 방식으로 객체 인스턴스를 관리한다고 했는데, 실제로 그런지 테스트 코드를 통해 확인해보자!

검증 용도의 코드 추가
테스트를 위해 MemberRepository를 조회할 수 있는 기능을 MemberServiceImpl과 OrderServiceImpl에 각각 추가

public class MemberServiceImpl implements MemberService{
    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}
public class OrderServiceImpl implements OrderService{
    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

테스트 코드

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("memberRepository = " + memberRepository);

        // memberRepository가 모두 같은 인스턴스인지 검증
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
    }
}

테스트를 실행하면

memberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.
호출이 안된 것인지 코드에 AppConfig 로그 추가해서 확인해보자

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

다시 테스트를 실행하면

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

로 memberRepository()는 1번만 호출된다.

6강) @Configuration과 바이트코드 조작의 마법

자바 코드를 보면 분명 memberRepository()가 3번 호출되어야 하는 것이 맞다.
그러나 스프링 컨테이너는 싱글톤 레지스트리로 스프링 빈이 싱글톤이 되도록 보장해주어야 한다.
그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

ConfigApp 스프링 빈
src/test/java/hello.core/singleton/ConfigurationSingletonTest.java

public class ConfigurationSingletonTest {
    ...
    
    @Test
    void configurationDeep() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        // AppConfig 타입으로 빈 조회
        AppConfig bean = ac.getBean(AppConfig.class);

        // AppConfig의 클래스 타입 조회
        System.out.println("bean = " + bean.getClass());    
    }
}

AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 그래서 AppConfig도 스프링 빈이 된다.
위의 테스트 코드는 AnnotationConfigApplicationContext에 파라미터로 넘긴 AppConfig 스프링 빈의 클래스 정보를 확인하는 코드다.

순수한 클래스라면 class hello.core.AppConfig로 출력되어야 한다.

그러나 예상과 다르게 bean = class hello.core.AppConfig$$SpringCGLIB$$0 가 출력된다.
⇒ 내가 만든 클래스가 아니라 스프링이 바이트코드 조작 라이브러리(CGLIB)를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 스프링 빈으로 등록한 것

⇒ AppConfig 클래스를 상속받은 임의의 다른 클래스(AppConfig@CGLIB)가 싱글톤을 보장

AppConfig@CGLIB 예상 코드

@Bean
public MemberRepository memberRepository() {

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

@Configuration 을 적용하지 않고, @Bean 만 적용하면 어떻게 될까?
1. AppConfig의 @Configuration 애노테이션 삭제
2. configurationDeep() 테스트 결과

  • AppConfig가 CGLIB 기술없이 순수한 AppConfig로 스프링 빈에 등록
  • MemberRepository가 총 3번 호출
    • 1번은 @Bean에 의해 스프링 컨테이너에 등록하기 위해 호출
    • 2번은 각각 memberRepository() 호출하면서 발생한 코드
  1. configurationTest() 인스턴스가 같은지 테스트 결과
    • 인스턴스가 같은지 테스트 하는 코드 실패
    • MemberRepository()가 3번 호출 & 각각 다른 MemoryMemberRepository 인스턴스 가짐

확인이 끝났으면 @Configuration이 동작하도록 다시 돌려놓자

정리

  • @Bean만 사용해도 스프링 빈으로 등록되지만, 싱글톤을 보장 X
    • memberRepository() 처럼 의존관계 주입이 필요해서 메서드를 직접 호출할 때 싱글톤 보장 X
  • 싱글톤 보장을 위해서 스프링 설정 정보는 항상 @Configuration 사용
profile
Bae YuSeon
이전 포스트

스프링 핵심 원리 Section 4. 스프링 컨테이너와 스프링 빈

다음 포스트

스프링 핵심 원리 Section 6. 컴포넌트 스캔

0개의 댓글

관련 채용 정보