스프링 핵심 원리 - 기본편
인프런 김영한님 Spring 로드맵 2번 강의

섹션5. 싱글톤 컨테이너 ~ 섹션9. 빈 스코프

---

스프링 핵심 원리 - 기본편 2

섹션5. 싱글톤 컨테이너

• 스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다.

• 대부분의 스프링 애플리케이션은 웹 어플리케이션이다.

• 웹 어플리케이션은 여러 고객이 동시에 요청을 한다.

• 고객이 요청할때마다 객체를 생성하면 애플리케이션에 부하를 줄 수 있다.

예제 1) 스프링 없는 순수 DI 컨테이너

- SingletonTest -

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

        assertThat(memberService1).isNotSameAs(memberService2);
    }
}

→ 이 경우 JVM메모리에 계속해서 객체가 생성되어 올라가게 됨.
그러므로 위의 결과와 같이 메모리 주소값이 다름을 확인할 수 있다.

• 고객이 1000명이면 객체도 1000개가 생성된다. => 메모리 낭비가 심함
• 그러므로 객체를 하나만 생성하여 공유하도록 한다. => 싱글톤 패턴

참고
테스트의 경우 반드시 검증을 통해 결과를 확인한다.
System.out.print() 등으로 눈으로 확인하더라도 반드시 검증과정을 거치자.

싱글톤

• 생성자를 private로 지정해 외부에서 new로 새로운 객체를 만들 수 없도록 한다.

- SingletonService -

public class SingletonService {

    private static final SingletonTest instance = new SingletonTest();

    public static SingletonTest getInstance(){
        return instance;
    }

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

1. static 영역에 객체 instance를 미리 하나 생성하여 올려둔다.
2. 이 객체 인스턴스가 필요할 때 getInstance()메서드를 통해서만 조회할 수 있다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로 생성자를 private로 만들어 외부에서 new키워드로 새로운 객체 인스턴스가 생성되는 것을 막는다.

→ 프로그램이 의도대로 사용되도록 의도하지 않은 사용을 컴파일 오류로 막아버리는 것이 가장 좋은 방법임.
싱글톤을 의도했더라도 외부에서의 객체생성을 막지 않는 경우 의도와 무관하게 사용될 수 있기 때문.

- SingletonService -

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

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

    Assertions.assertThat(singletonService1).isEqualTo(singletonService2);
}

→ 동일한 인스턴스가 반환됨을 확인할 수 있다.

객체를 생성하는데 드는 비용이 1000이라면 이미 있는 객체를 가져오는 것은 1정도의 비용이 든다고 생각하면 될 정도로 싱글톤 패턴은 효율적인 방법이다.

스프링 컨테이너 사용 시 기본적으로 객체를 싱글톤 패턴으로 관리해준다.

싱글톤 패턴의 문제점

• 싱글톤 구현에 사용될 코드가 필요
• 의존관계상 클라이언트가 구체 클래스에 의존하게 됨 => DIP를 위반
• 클라이언트가 구체 클래스에 의존하므로 OCP 원칙을 위반할 확률이 높다.
• 테스트가 어려움
• 내부 속성을 변경하거나 초기화하기 어려움
• 유연성이 떨어짐

=> 스프링 프레임워크를 사용하면 이러한 단점들을 모두 해결할 수 있다.

싱글톤 컨테이너

• 스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서 객체 인스턴스를 싱글톤으로 관리한다.
  • 싱글톤 패턴의 지저분한 코드가 들어가지 않아도 됨
  • DIP, OCP, 테스트, private 생성자로 부터 자유롭게 싱글톤을 사용할 수 있음
• 스프링 빈이 곧 싱글톤으로 관리되는 빈이다.
• 스프링 컨테이너가 싱글톤 컨테이너의 역할을 한다.
  싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라 한다.

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

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

    assertThat(memberService1).isSameAs(memberService2);
}

참고
스프링의 기본 빈 등록방식은 싱글톤이지만, 요청할 때 마다 새로운 객체를 반환하는 기능 역시 지원한다.
다만 스프링의 99%는 싱글톤 패턴을 이용한다고 보면 된다.

싱글톤 패턴의 주의점

!중요!

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

예제

userA, userB라는 두 고객이 차례로 주문을 했을 때 userA의 주문금액을 구한다.
이때 금액을 싱글톤 객체 내에서 관리하면 어떤 문제가 발생하는지 확인한다.

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

- StatefulServiceTest -

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton(){
        AnnotationConfigApplicationContext 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사용자 15000원 주문
        statefulService2.order("userB", 15000);

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

        assertThat(statefulService1.getPrice()).isEqualTo(15000);
    }

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

→ 내가 구하고 싶은 금액은 userA의 주문금액인 10000원이지만 두 고객은 같은 객체를 사용하므로 userA의 주문정보가 userB의 주문정보로 갱신되어버리는 문제가 발생한다.

고로 공유필드는 반드시 주의가 필요하다.
이를 해결하기 위해 공유되지 않는 지역변수를 활용하여 아래와 같이 예제를 변경한다.

- StatefulService -

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

- StatefulServiceTest -

@Test
void statefulServiceSingleton(){
    AnnotationConfigApplicationContext 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사용자 15000원 주문
    int userBprice = statefulService2.order("userB", 15000);

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

    assertThat(userAprice).isEqualTo(10000);
}

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

→ 지역변수에 user객체를 저장하도록 하면 두 고객을 따로 관리할 수 있다.

싱글톤 및 멀티스레드 문제가 실무에서 발생 시 쉽게 잡을 수도 없을뿐더러 수정에만 몇 개월이 걸릴 수 있다.
예를 들어 A가 접속했는데 B의 정보가 보인다거나 하는 문제가 이런 경우에 해당한다. (이 경우 일일히 로그를 확인하여 데이터를 복구해야 한다...)

공유 필드는 반드시 주의가 필요하다.
스프링 빈은 항상 무상태(stateless)로 설계하자!

@Configuration과 싱글톤

- AppConfig -

@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }
    @Bean
    public MemoryMemberRepository 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();
    }
}

객체 생성 시 호출하는 횟수를 직접 확인하기 위해 println()으로 출력하는 부분을 추가한다.

~ AppConfig에서의 의문점 ~

• memberService(), orderService()를 호출할 경우 결국 new MemoryMemberRepository()가 2번 실행되어 2개의 MemoryMemberRepository객체를 가지게 되는 것 아닌가??
  • 이렇게 될 경우 객체가 2개 생성되어 싱글톤 패턴이 깨지게 되는데, 과연??

테스트를 위해 OrderServiceImpl, MemberServiceImpl에 각각 아래 코드를 추가

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

→ 객체가 같은지 확인하기 위해 MemberRepository객체를 리턴하는 메서드를 OrderServiceImpl, MemberServiceImpl에 각각 추가한다.

- ConfigurationSingletonTest -

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

→ 테스트 클래스를 작성하여 돌려보면 세 인스턴스가 모두 동일하다는 것을 알 수 있다.

또한
memberService(), memberRepository(), orderService()를 차례로 호출했을 때 자바코드만 보면 memberRepository()가 3번 호출되어야 할 것 같은데 실제로는 한번만 호출되었음을 확인할 수 있다.
왜일까?
이유는 AppConfig클래스에 작성해둔 @Configuration어노테이션에 있다.

@Configuration과 바이트 조작의 마법

위의 테스트에서 AppConfig클래스의 @Configuration를 지우고 다시 실행해보자.
memberRepository()가 3번 호출되며 싱글톤 패턴이 깨진다.

→ memberRepository()가 3번 호출된다.
맨 아래 bean.getClass() = class hello.core.AppConfig는 실제 AppConfig클래스의 객체를 의미한다.

이번에는 다시 AppConfig클래스의 @Configuration를 붙여서 실행해보자.

→ 맨 아래 AppConfig의 객체 뒤에 뭔가 더 출력되는 것을 확인할 수 있다.
이는 @Configuration을 적용하면 생기는 변화, AppConfig클래스를 직접 스프링 빈으로 등록한 것이 아니라 CGLIB라는 바이트코드 조작 라이브러리를 이용해 AppConfig클래스를 상속받은 임의의 다른 클래스를 만들어 그 클래스를 스프링 빈으로 등록한 것이다.
이렇게 생성된 임의의 클래스가 싱글톤을 보장하는 구조이다.
그러므로 위의 예제에서 @Configuration을 삭제하자 싱글톤이 깨지며 동일한 객체를 3번 생성한 것.

~ 정리 ~
@Configuration이 있을 경우 @Bean이 붙은 메서드마다 스프링 빈이 존재하면 해당 빈을 반환하고, 없으면 생성하여 스프링 빈으로 등록하고 반환하는 코드가 동적으로 만들어진다.
따로 싱글톤에 대한 코드를 작성하지 않아도 싱글톤을 보장해주는 이유가 이 때문이다.

즉, 스프링 설정 정보에는 항상 @Configuration을 사용해야 한다.

섹션6. 컴포넌트 스캔

이번 섹션에서는 스프링을 사용할때마다 아무 생각없이 사용해왔던 @Autowired, @Component 어노테이션에 대한 내용을 다룬다.

※ 참고
항상 사용하는 @Service, @Controller, @Repository 에 @Component 이 포함되어 있다.

ComponentScan과 의존관계 자동 주입

• 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 ComponentScan이라는 기능을 제공한다.

• @ComponentScan은 @Component 어노테이션이 사용된 모든 클래스를 찾아 자동으로 스프링 빈으로 등록한다.

• 컴포넌트 스캔을 사용하려면 @ComponentScan 어노테이션을 설정 정보에 추가한다.

  • 기존과는 다르게 @Bean 어노테이션을 사용하지 않아도 자동으로 스프링 빈으로 등록된다.

자동으로 스프링 빈 등록 시 의존관계 주입을 직접 해줄 수 없게된다.
이때 @Autowired 어노테이션을 사용해 의존관계를 자동으로 주입하도록 한다.

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}

@Component
public class OrderServiceImpl implements OrderService{

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

@Component
public class MemberServiceImpl implements MemberService{

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

→ MemoryMemberRepository, RateDiscountPolicy, OrderServiceImpl, MemberServiceImpl 클래스에 @Component 어노테이션을 추가해 자동 스프링 빈 등록이 되도록 한다.
OrderServiceImpl, MemberServiceImpl 클래스의 생성자에 @Autowired 어노테이션을 추가해 자동 주입을 해주도록 한다.

public class AutoAppConfigTest {

    @Test
    void basicScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

→ 테스트 실행 시 memberService가 MemberService클래스의 인스턴스임을 확인할 수 있다.

※ java의 instanceof와 클래스, 인스턴스, 객체의 차이는 맨 아래 참고자료의 링크를 확인하자.

(작성중)

섹션7. 의존관계 자동 주입

섹션8. 빈 생명주기 콜백

섹션9. 빈 스코프

---

인텔리제이 단축키

window os 기준 단축키

🔗참고자료

java instanceof

[Java] 클래스, 객체, 인스턴스의 차이