인프런 스프링 기본 강의 정리 #5

728x90

1. 웹 애플리케이션과 싱클톤

대부분의 스프링 애플리케이션은 웹 애플리케이션이며, 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

이때 여러 클라이언트가 memberService를 요청할 때마다 컨테이너는 다른 memberService를 만든다.

이를 확인해보기 위해 테스트 코드를 작성해보자.

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

src/test에 singleton 패키지를 생성하고, 그 아래에 SingletonTest 클래스를 생성한다.

import hello.core1.AppConfig;
import hello.core1.member.MemberService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;

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

호출할 때마다 새로운 객체를 생성하기 때문에 메모리 낭비가 심해 비효율적이다.

2. 싱글톤 패턴

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

그렇기 때문에 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.

src/test/java/singleton에 SingletonService 클래스를 생성한다.

public class SingletonService {
    
    //static 영역에 객체를 딱 1개만 생성해둔다
    //자기 자신을 참조해서 isntance에 넣음
    private static final SingletonService instance=new SingletonService();

    //public으로 열어서 객체 인스턴스가 필요하면 static 메서드를 통해서만 조회하도록 허용
    //객체 인스턴스가 필요하면 오직 getInstance()를 통해서만 조회 가능
    public static SingletonService getInstance(){
        return instance;
    }

    //생성자를 private로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다
    private SingletonService(){

    }

    public void logic(){
        System.out.println("싱글톤 객체 로직 호출");
    }
}

딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 막아서 혹시라도 외부에서 new 키워드로

객체 인스턴스가 생성되는 것을 막는다.

위 코드를 테스트할 코드를 추가로 생성해보자.

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

singletonService1과 singletonService2가 같은 객체임을 확인할 수 있다.

-싱글톤 패턴 문제점

싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
의존관계상 클라이언트가 구체 클래스에 의존한다 -> DIP 위반
클라이언트가 구체 클래스에 의존해서 OCP 원칙을 위반할 가능성이 높다.
유연성이 떨어진다.

3. 싱글톤 컨테이너

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

지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

src/test/java/singleton/SingletonTest 클래스에 아래 코드를 추가하여 싱글톤 컨테이너를 테스트해보자.

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

memberService1과 memberService2의 객체가 같음을 확인할 수 있다.

스프링 컨테이너 덕분에 요청이 올 때마다 객체를 생성하는 것이 아니라, 이미 만들어진 객체를 공유해서 재사용할 수 있다.

4. 싱글톤 방식의 주의점

객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기

때문에 싱글톤 객체는 상태를 유지(stateful)하게 설계하면 안 된다.

따라서 무상태(stateless)로 설계해야 한다. 특정 클라이언트에 의존적인 필드가 있으면 안 되고, 특정 클라이언트가 값을 변경할 수 없는 읽기만 가능한 상태여야 한다.

-상태를 유지할 경우 발생하는 문제점 예시

src/test/java/singleton에 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;
    }

}

src/test/java/singleton에 StatefulServiceTest 클래스를 생성한다.

cf) 테스트 클래스 생성 : Ctrl + Shift + T 키

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

public class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

        StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
        StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);

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

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

        //ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
        System.out.println("price = " + price);
        Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

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

ThreadA가 사용자A 코드를 호출하고 ThreadB가 사용자B 코드를 호출한 상황이다. StatefulService 의 price 필드는 공유되는 필드인데, 클라이언트 B가 값을 변경했다. 결국 사용자A의 주문금액은 10000원이 아닌 20000원이라는 결과가 나왔다.

무상태로 설계하기 위해 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

파라미터를 사용해서 위 문제를 해결해보자.

먼저 StatefulService 클래스의 코드를 아래와 같이 수정한다.

public class StatefulService {
    private int price;
    //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 클래스의 코드도 다음과 같이 수정해주면 문제가 해결된다.

public class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

        StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
        StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);

        //ThreadA: A사용자 10000원 주문
        int userAprice = statefulService1.order("userA",10000);
        //ThreadB: B사용자 20000원 주문
        int userBprice = statefulService1.order("userB",10000);

        //ThreadA: 사용자A 주문 금액 조회
        int price = statefulService1.order("userA",10000);

        System.out.println("price = " + userAprice);

       // Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
    }

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

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

위 코드에서는 결과적으로 각각 다른 2개의 MemoryMemberRepository가 생성되면서 싱글톤이 깨지는 것처럼 보인다.

이를 확인해보기 위해 테스트 코드를 작성해보자.

먼저 테스트 용도로 MemberRepository를 조회할 수 있는 기능을 추가하기 위해 MemberService와 OrderService 를 수정한다.

public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

    //테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;

    //테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

다음으로 src/test/java/singleton에 ConfigurationSingletonTest 클래스를 생성한다.

import hello.core1.AppConfig;
import hello.core1.member.MemberRepository;
import hello.core1.member.MemberServiceImpl;
import hello.core1.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.Assertions.*;

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

        //모두 같은 인스턴스를 참고하고 있다.
        System.out.println("memberService -> memberRepository = " + memberService.getMemberRepository);
        System.out.println("orderService -> memberRepository = " + orderService.getMemberRepository());
        System.out.println("memberRepository = " + memberRepository);

        //모두 같은 인스턴스를 참고하고 있다.
        assertThat(memberService.getMemberRepository()).isSameAs(memberRepository);
        assertThat(orderService.getMemberRepository()).isSameAs(memberRepository);
    }
}

테스트 결과를 확인해보면 memberRepository 인스턴스는 모두 같은 인스턴스를 공유한다.

AppConfig의 자바 코드를 보면 분명히 각각 2번 new MemoryMemberRepository 호출해서 다른 인스턴스가 생성되어야 하는데, 그러지 않는 이유를 다음 코드에서 확인해보자.

이를 확인하고자 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());
    }

    @Bean
    public DiscountPolicy discountPolicy(){
        return new RateDiscountPolicy();
    }
}

위 코드상으로는 아래와 같이 memberRepostiory가 총 3번 호출되어야 한다고 생각된다.

call AppConfig.memberService -> call AppConfig.membeRepository -> call AppConfig.membeRepository

-> call AppConfig.orderService -> call AppConfig.membeRepository

그러나 출력 결과는 모두 1번만 호출되었다. 이를 통해 스프링이 싱글톤을 보장해 줌을 확인할 수 있다.

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

스프링은 클래스의 바이트 코드를 조작하는 라이브러리를 사용한다. 그 핵심은 @Configuration을 적용한 AppConfig에 있다.

ConfigurationSingletonTest 클래스에 다음 코드를 추가해 수정해보자.

   @Test
    void  configurationDeep() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        
        //AppConfig도 스프링 빈으로 등록된다.
        AppConfig bean = ac.getBean(AppConfig.class);

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

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

AppConfig 스프링 빈을 조회해서 클래스 정보를 출력해보면 아래와 같은 값이 나온다.

순수한 클래스의 경우 class hello.core.AppConfig가 출력되어야 하는데, 상당히 복잡한 값이 출력되었다.

이것은 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다. 그 임의의 다른 클래스가 바로 싱글톤이 보장되도록 해준다.

-AppConfig@CGLIB 예상 코드

@Bean
public MemberRepository memberRepository() {

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

@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 스프링 빈이 없으면 생성해서 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다. 이러한 원리 덕분에 싱글톤이 보장된다.

@Configuration을 붙이면 바이트코드를 조작하는 CGLIB 기술을 사용해서 싱글톤을 보장하지만,

만약 @Configuration을 사용하지 않고 @Bean만 적용했을 때의 결과를 알아보자.

먼저 AppConfig에서 @Configuration을 삭제한다.

//@Configuration 삭제
public class AppConfig {
}

그러면 위와 같이 AppConfig가 CGLIB 기술 없이 순수한 AppConfig로 스프링 빈에 등록되어 출력된다.

또한 MemberRepository가 총 3번 호출되었다.

객체들의 인스턴스도 모두 다르기 때문에 싱글톤이 지켜지지 않는다는 것을 알 수 있다.

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

그렇기 때문에 스프링 설정 정보는 항상 @Configuration을 사용해야 한다.

728x90

'Spring > 스프링 핵심 원리' 카테고리의 다른 글

인프런 스프링 기본 강의 정리 #7 (1)	2023.11.27
인프런 스프링 기본 강의 정리 #6 (2)	2023.11.25
인프런 스프링 기본 강의 정리 #4 (1)	2023.11.23
인프런 스프링 기본 강의 정리 #3 (0)	2023.11.20
인프런 스프링 기본 강의 정리 #2 (0)	2023.11.19

예린이의 코딩 성장기

인프런 스프링 기본 강의 정리 #5

1. 웹 애플리케이션과 싱클톤

2. 싱글톤 패턴

3. 싱글톤 컨테이너

4. 싱글톤 방식의 주의점

5. @Configuration과 싱글톤

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

'Spring > 스프링 핵심 원리' 카테고리의 다른 글

티스토리툴바

인프런 스프링 기본 강의 정리 #5

1. 웹 애플리케이션과 싱클톤

2. 싱글톤 패턴

3. 싱글톤 컨테이너

4. 싱글톤 방식의 주의점

5. @Configuration과 싱글톤

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

'Spring > 스프링 핵심 원리' 카테고리의 다른 글

관련글

티스토리툴바