9. 빈 스코프

9. 빈 스코프

---

• 9. 빈 스코프
  • 핵심 정리
    • 핵심 요약:
    • 프록시 모드(Proxy Mode)와 동작 원리
      • 1. 프록시 모드의 동작 방식
      • 2. 프록시 객체의 동작 방식
      • 3. 프록시 모드의 장점
      • 4. 주의할 점
    • 핵심 키워드
  • 빈 스코프
  • 프로토타입 스코프
  • 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점
    • 프로토타입 빈 직접 요청
    • 싱글톤 빈에서 프로토타입 빈 사용
  • 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결
    • ObjectFactory, ObjectProvider
    • JSR-330 Provider
  • 웹 스코프
  • request 스코프 예제
    • 웹 환경 추가
    • request 스코프 예제 개발
  • 스코프와 Provider
  • 스코프와 프록시
    • 웹 스코프와 프록시 동작 원리

---

핵심 정리

핵심 요약:

1. 빈 스코프의 종류

   • 싱글톤: 기본적으로 스프링 컨테이너가 시작될 때부터 종료될 때까지 하나의 인스턴스만 유지하는 스코프. 빈이 요청될 때마다 같은 인스턴스를 반환하므로 메모리 사용을 절약하고 성능을 개선하는 효과가 있다.

   • 프로토타입: 매번 빈이 요청될 때마다 새로운 인스턴스를 생성. 빈이 생성된 후에는 스프링 컨테이너가 해당 빈을 관리하지 않기 때문에, 라이프사이클을 클라이언트가 직접 관리해야 한다.

   • 웹 스코프

     : 웹 애플리케이션에서 주로 사용되며, HTTP 요청에 따라 빈이 생성되고 요청이 종료되면 소멸되는

     요청 단위 스코프

     • Request 스코프: HTTP 요청 하나가 들어오고 나갈 때까지 빈이 유지된다.
     • Session 스코프: HTTP 세션과 동일한 생명주기를 가지며, 사용자 세션이 유지되는 동안 빈이 유지된다.
     • Application 스코프: 애플리케이션의 서블릿 컨텍스트와 동일한 생명주기를 가지며, 서버가 동작하는 동안 빈이 유지된다.
     • WebSocket 스코프: WebSocket 연결이 시작되고 종료될 때까지 빈이 유지된다.

@Scope("prototype")
@Component
public class HelloBean {}

1. 프로토타입 빈의 특성
   • 요청 시마다 새로운 객체가 생성되므로, 매번 새로운 상태를 가진 객체가 필요할 때 유용하다.
   • 스프링 컨테이너는 빈 생성 및 의존성 주입까지만 책임지며, 이후 빈의 라이프사이클(예: 소멸)은 스프링 컨테이너가 아닌 클라이언트가 관리한다. 이로 인해 @PreDestroy 같은 종료 메서드는 호출되지 않음.
   • 실무에서 프로토타입 빈은 자주 사용되지는 않으며, 주로 특정 요청 시마다 새로운 객체가 반드시 필요한 경우에만 사용된다.

@Scope("prototype")
static class PrototypeBean {
    @PostConstruct
    public void init() {
        System.out.println("PrototypeBean.init");
    }
    @PreDestroy
    public void destroy() {
        System.out.println("PrototypeBean.destroy");
    }
}

1. 싱글톤과 프로토타입 빈의 조합 문제
   • 싱글톤 빈은 애플리케이션 시작 시 한 번만 생성되고, 이후 요청이 와도 같은 인스턴스를 반환한다.
   • 싱글톤 빈에서 프로토타입 빈을 의존성 주입받을 때, 프로토타입 빈이 생성 시에만 주입되기 때문에, 사용할 때마다 새롭게 생성되지 않는 문제가 발생한다. 즉, 프로토타입 빈이 여러 번 사용될 때도 하나의 인스턴스만 사용되는 것이다.
   • 이를 해결하기 위해 프로토타입 빈을 사용할 때마다 새로운 인스턴스를 생성하는 방법이 필요하다.

@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

public int logic() {
    PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
    prototypeBean.addCount();
    return prototypeBean.getCount();
}

1. 의존성 탐색(Dependency Lookup, DL)
   • DI(의존성 주입)은 스프링이 빈을 자동으로 주입하는 방식이지만, DL은 개발자가 필요한 시점에 빈을 직접 요청하여 주입받는 방식이다.
   • ObjectProvider와 같은 도구를 사용하면, 필요할 때마다 빈을 요청할 수 있으며, 이를 통해 프로토타입 빈이나 요청에 따라 매번 새로 생성해야 하는 빈을 적절히 활용할 수 있다. 이 방식은 스프링 컨테이너에 전적으로 의존하지 않고, 빈을 동적으로 관리할 수 있도록 도와준다.

@Autowired
private ObjectProvider<PrototypeBean> provider;

public int logic() {
    PrototypeBean prototypeBean = provider.getObject();
    prototypeBean.addCount();
    return prototypeBean.getCount();
}

1. 웹 스코프
   • Request 스코프: HTTP 요청마다 빈이 생성되고, 요청이 끝나면 빈이 소멸된다. 웹 애플리케이션에서 요청별로 데이터를 저장해야 할 때 사용된다.
   • Session 스코프: HTTP 세션이 유지되는 동안 하나의 빈 인스턴스가 유지되며, 사용자의 세션 정보를 관리하는 데 유용하다.
   • 프록시 모드(Scoped Proxy Mode)를 사용하면, 프록시 객체가 요청을 대신 처리하고, 실제 요청이 발생할 때만 빈을 생성하는 방식으로 빈을 사용할 수 있다. 이를 통해 스코프가 달라도 빈을 쉽게 주입받을 수 있다.

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
    private String uuid;
    private String requestURL;

    @PostConstruct
    public void init() {
        uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] request scope bean create: " + this);
    }

    @PreDestroy
    public void close() {
        System.out.println("[" + uuid + "] request scope bean close: " + this);
    }
}

1. 프록시 모드를 통한 웹 스코프 빈 사용 요약:
   • 프록시 객체는 빈의 생성 시점을 요청 시점으로 지연시키고, 개발자는 빈이 실제로 생성되었는지 신경 쓰지 않고도 싱글톤처럼 사용할 수 있습니다.
   • 특히 웹 환경에서 HTTP 요청마다 다른 빈을 사용해야 할 때 request 스코프와 함께 자주 사용되며, 요청이 끝나면 프록시 객체가 빈 소멸을 처리합니다.

프록시 모드(Proxy Mode)와 동작 원리

프록시 모드(Proxy Mode)는 스프링이 스코프가 다른 빈을 쉽게 사용할 수 있도록 도와주는 기법입니다. 이는 주로 웹 스코프 빈을 싱글톤 빈처럼 사용하거나, 실제 빈이 사용되기 전까지 그 생성을 지연시키는 데 활용됩니다.

1. 프록시 모드의 동작 방식

• 스프링 컨테이너는 실제 빈을 생성하지 않고, 대신 프록시 객체를 미리 만들어서 주입합니다. 이 프록시 객체는 실제 빈이 생성될 때까지 클라이언트 요청을 대신 처리합니다.
• 클라이언트는 프록시 객체를 사용하고, 프록시 객체는 실제 빈이 필요할 때(예: HTTP 요청이 들어올 때) 실제 빈을 생성하거나 요청하여 작업을 위임합니다.
• 프록시 객체는 원래 클래스와 동일한 메서드 구조를 가지기 때문에, 개발자는 실제 빈을 사용하는 것처럼 작업할 수 있으며, 프록시 객체의 존재를 인식하지 못해도 코드가 정상적으로 동작합니다.

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
    private String uuid;
    private String requestURL;

    @PostConstruct
    public void init() {
        uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] request scope bean create: " + this);
    }

    @PreDestroy
    public void close() {
        System.out.println("[" + uuid + "] request scope bean close: " + this);
    }
}

위 코드에서 proxyMode = ScopedProxyMode.TARGET_CLASS는 CGLIB이라는 라이브러리를 사용하여 프록시 객체를 생성하도록 설정합니다. CGLIB은 클래스 상속 기반의 프록시를 만들며, 프록시 객체는 실제 빈을 사용하기 전까지 동작을 대신 처리합니다. 인터페이스를 상속하는 경우에는 ScopedProxyMode.INTERFACES를 사용할 수 있습니다.

2. 프록시 객체의 동작 방식

• 실제 MyLogger 빈을 대신할 프록시 객체는 싱글톤처럼 동작하며, 빈의 생성이나 메서드 호출이 필요할 때만 실제 빈을 찾아 요청합니다. 이로 인해, 빈의 스코프와 관계없이 의존성 주입을 받을 수 있습니다.
• 예를 들어, 싱글톤 빈에 request 스코프 빈을 주입하는 경우, 실제로는 프록시 객체가 주입됩니다. 프록시 객체는 HTTP 요청이 올 때마다 실제 빈을 대신 생성하고 관리합니다.

System.out.println("myLogger = " + myLogger.getClass());

위 코드를 통해 출력된 프록시 객체의 클래스 정보를 확인하면, 실제 빈이 아닌 프록시 객체임을 알 수 있습니다.

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

3. 프록시 모드의 장점

• 프록시 객체는 싱글톤 빈처럼 행동하지만, 실제 빈은 요청이 있을 때마다 생성되므로 빈의 스코프와 상관없이 편리하게 사용할 수 있습니다.
• 스코프 빈의 생성을 지연시키므로, 애플리케이션의 메모리 사용량을 최적화할 수 있으며, 필요할 때만 실제 빈을 사용할 수 있습니다.
• 복잡한 설정 없이 간단한 애노테이션만으로 빈의 라이프사이클을 관리할 수 있어, 코드를 깔끔하게 유지할 수 있습니다.

4. 주의할 점

• 프록시 모드는 가짜 객체를 먼저 생성해놓고 실제 객체와의 상호작용을 지연시키는 방식이므로, 디버깅이나 문제 해결 시 주의해야 합니다. 특히, 프록시 객체와 실제 객체의 차이를 인식하지 못한 채 사용할 경우, 예상치 못한 동작이 발생할 수 있습니다.
• 진짜 빈이 생성되기 전까지는 프록시 객체가 동작하므로, 특정 시점에 빈이 반드시 존재해야 하는 경우에는 프록시 사용이 적절하지 않을 수 있습니다.
• 프록시 모드는 특정 스코프에서만 사용하는 것이 좋으며, 무분별하게 사용하면 코드 유지보수가 어려워질 수 있습니다

핵심 키워드

1. 빈 스코프: 싱글톤, 프로토타입, 웹 스코프 등 빈이 존재하는 범위.
2. 프로토타입 빈: 요청마다 새로운 인스턴스를 생성하고 관리하지 않는 빈.
3. 의존성 탐색(Dependency Lookup, DL): 빈을 주입받는 것이 아니라, 필요할 때마다 요청하여 가져오는 방식.
4. 프록시 모드: 빈이 사용되기 전까지 실제 객체의 생성을 지연시키는 방식.
5. ObjectProvider와 JSR-330 Provider: 의존성 주입이 아닌, 동적 탐색을 위한 도구.

빈 스코프

빈 스코프 : 빈이 존재할 수 있는 범위

종류

• 싱글톤 : 기본 스코프. 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프. 싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다.
• 프로토타입 : 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프. 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.
• 웹 스코프
  • REQUEST : HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다
  • SESSION : HTTP Session과 동일한 생명주기를 가지는 스코프
  • APPLICATION : 서블릿 컨텍스트( ServletContext )와 동일한 생명주기를 가지는 스코프
  • WEBSOCKET : 웹 소켓과 동일한 생명주기를 가지는 스코프

빈 스코프 지정 방법

• 컴포넌트 스캔 자동 등록

@Scope("prototype")
@Component
public class HelloBean {}

• 수동 등록

@Scope("prototype")
@Bean
PrototypeBean HelloBean() {
    return new HelloBean();
}

프로토타입 스코프

프로토타입 빈의 특징 정리

• 스프링 컨테이너에 요청할 때 마다 새로 생성된다.
• 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다. 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다. @PreDestroy 같은 종료 메서드가 호출되지 않는다.
• 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

사용하는 경우

매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용.

하지만 실무에서는 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.

싱글톤 빈 요청

1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청
2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환
3. 이후 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈 반환

프로토타입 빈 요청1

1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청
2. 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계 주입

프로토타입 빈 요청2

3. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환
4. 이후 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환

싱글톤 스코프 빈 테스트

package hello.core.scope;

import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

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

public class SingletonTest {

    @Test
    public void singletonBeanFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SingletonBean.class);
        SingletonBean singletonBean1 = ac.getBean(SingletonBean.class);
        SingletonBean singletonBean2 = ac.getBean(SingletonBean.class);
        System.out.println("singletonBean1 = " + singletonBean1);
        System.out.println("singletonBean2 = " + singletonBean2);
        assertThat(singletonBean1).isSameAs(singletonBean2);

        ac.close(); //종료
    }

    @Scope("singleton")
    static class SingletonBean {

        @PostConstruct
        public void init() {
            System.out.println("SingletonBean.init");
        }

        @PreDestroy
        public void destroy() {
            System.out.println("SingletonBean.destroy");
        }
    }
}

실행 결과

SingletonBean.init
singletonBean1 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd
singletonBean2 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd
org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing SingletonBean.destroy

1. 빈 초기화 메서드를 실행
2. 같은 인스턴스의 빈을 조회
3. 종료 메서드까지 정상 호출

프로토타입 스코프 빈 테스트

package hello.core.scope;

import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Scope;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

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

public class PrototypeTest {

    @Test
    public void prototypeBeanFind() {

        // 1
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
        // 2
        System.out.println("find prototypeBean1");
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        System.out.println("find prototypeBean2");
        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        System.out.println("prototypeBean1 = " + prototypeBean1);
        System.out.println("prototypeBean2 = " + prototypeBean2);
        assertThat(prototypeBean1).isNotSameAs(prototypeBean2);
        // 3
        ac.close(); //종료
    }

    @Scope("prototype")
    static class PrototypeBean {

        @PostConstruct
        public void init() {
            System.out.println("PrototypeBean.init");
        }
        @PreDestroy
        public void destroy() {
            System.out.println("PrototypeBean.destroy");
        }
    }
}

실행 결과

find prototypeBean1
PrototypeBean.init
find prototypeBean2
PrototypeBean.init
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@13d4992d
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@302f7971
org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing

1. 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행되는 반면, 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메서드도 실행

2. 프로토타입 빈을 2번 조회했으므로 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행

3. 싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화 까지만 관여하고, 더는 관리하지 않는다. 따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드가 전혀 실행되지 않는다.

프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점

프로토타입 빈 직접 요청

스프링 컨테이너에 프로토타입 빈 직접 요청 1

1. 클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x01)한다. 해당 빈의 count 필드 값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출하면서 count 필드를 +1 한다.
4. 결과적으로 프로토타입 빈(x01)의 count는 1이 된다.

스프링 컨테이너에 프로토타입 빈 직접 요청 2

1. 클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x02)한다. 해당 빈의 count 필드 값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출하면서 count 필드를 +1 한다.
4. 결과적으로 프로토타입 빈(x02)의 count는 1이 된다.

코드로 확인

public class SingletonWithPrototypeTest1 {

    @Test
    void prototypeFind() {
        AnnotationConfigApplicationContext ac = new
        AnnotationConfigApplicationContext(PrototypeBean.class);
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        prototypeBean1.addCount();
        assertThat(prototypeBean1.getCount()).isEqualTo(1);

        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        prototypeBean2.addCount();
        assertThat(prototypeBean2.getCount()).isEqualTo(1);
    }

    @Scope("prototype")
    static class PrototypeBean {

        private int count = 0;

        public void addCount() {
            count++;
        }

        public int getCount() {
            return count;
        }

        @PostConstruct
        public void init() {
            System.out.println("PrototypeBean.init " + this);
        }

        @PreDestroy
        public void destroy() {
            System.out.println("PrototypeBean.destroy");
        }
    }
}

싱글톤 빈에서 프로토타입 빈 사용

clientBean이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예

싱글톤에서 프로토타입 빈 사용 1

clientBean 은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한다.

1. clientBean 은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean 에 반환한다. 프로토타입 빈의 count 필드 값은 0이다.
3. 이제 clientBean 은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관한다.)

싱글톤에서 프로토타입 빈 사용 2

클라이언트 A는 clientBean 을 스프링 컨테이너에 요청해서 받는다.싱글톤이므로 항상 같은 clientBean 이 반환된다.

3. 클라이언트 A는 clientBean.logic() 을 호출한다.
4. clientBean 은 prototypeBean의 addCount() 를 호출해서 프로토타입 빈의 count를 증가한다. count값이 1이 된다.

싱글톤에서 프로토타입 빈 사용 3

클라이언트 B는 clientBean 을 스프링 컨테이너에 요청해서 받는다.싱글톤이므로 항상 같은
clientBean 이 반환된다.
여기서 중요한 점이 있는데, clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는 것이 아니다!

5. 클라이언트 B는 clientBean.logic() 을 호출한다.
6. clientBean 은 prototypeBean의 addCount() 를 호출해서 프로토타입 빈의 count를 증가한다. 원래 count 값이 1이었으므로 2가 된다.

테스트 코드

package hello.core.scope;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

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

public class SingletonWithPrototypeTest1 {

    @Test
    void singletonClientUsePrototype() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);

        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int count1 = clientBean1.logic();
        assertThat(count1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        assertThat(count2).isEqualTo(2);
    }

    static class ClientBean {

        private final PrototypeBean prototypeBean;

        @Autowired
        public ClientBean(PrototypeBean prototypeBean) {
        this.prototypeBean = prototypeBean;
        }

        public int logic() {
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
        }
    }

    @Scope("prototype")
    static class PrototypeBean {

        private int count = 0;

        public void addCount() {
            count++;
        }

        public int getCount() {
            return count;
        }

        @PostConstruct
        public void init() {
            System.out.println("PrototypeBean.init " + this);
        }

        @PreDestroy
        public void destroy() {
            System.out.println("PrototypeBean.destroy");
        }
    }
}

스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다. 그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다.

-> 프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라, 사용할 때 마다 새로 생성해서 사용

참고: 여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성된다. 예를 들어서 clientA, clientB가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받는다.
clientA -> prototypeBean@x01
clientB -> prototypeBean@x02
물론 사용할 때 마다 새로 생성되는 것은 아니다.

프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결

싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 사용할 때마다 항상 새로운 프로토타입 빈을 생성

의존관계 조회(탐색) (Dependency Lookup (DL)) : 의존관계를 외부에서 주입(DI) 받는게 아니라 직접 필요한 의존관계를 찾는 것

ObjectFactory, ObjectProvider

ObjectProvider : 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공

• ObjectFactory: 기능이 단순, 별도의 라이브러리 필요 없음, 스프링에 의존
• ObjectProvider: ObjectFactory 상속, 옵션, 스트림 처리등 편의 기능이 많고, 별도의 라이브러리 필요
  없음, 스프링에 의존

public class PrototypeProviderTest {

    @Test
    void providerTest() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);

        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int count1 = clientBean1.logic();
        assertThat(count1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        assertThat(count2).isEqualTo(1);
    }

    static class ClientBean {

        //@Autowired
        //private ApplicationContext ac;

        //public int logic() {
        //    PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
        //    prototypeBean.addCount();
        //    int count = prototypeBean.getCount();
        //    return count;
        //}
        // ac.getBean() 을 통해서 항상 새로운 프로토타입 빈이 생성
        // 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.

        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;

        public int logic() {
            PrototypeBean prototypeBean = prototypeBeanProvider.getObject(); 
            prototypeBean.addCount();
            int count = prototypeBean.getCount();
            return count;
        }
    }

    @Scope("prototype")
    static class PrototypeBean {

        private int count = 0;

        public void addCount() {
        count++;
        }

        public int getCount() {
        return count;
        }

        @PostConstruct
        public void init() {
        System.out.println("PrototypeBean.init " + this);
        }

        @PreDestroy
        public void destroy() {
        System.out.println("PrototypeBean.destroy");
        }
    }
}

• prototypeBeanProvider.getObject() -> 항상 새로운 프로토타입 빈이 생성

• ObjectProvider 의 getObject() 를 호출하면 내부에서는 스프링 컨테이너를 통해 프로토타입 빈을 찾아서 반환한다. (DL)

• 스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.

JSR-330 Provider

특징

• get() 메서드 하나로 기능이 매우 단순하다.
• 별도의 라이브러리가 필요하다.
• 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

사용 시 라이브러리 추가

• 스프링부트 3.0 미만 : javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다.
• 스프링부트 3.0 이상 : jakarta.inject:jakarta.inject-api:2.0.1 라이브러리를 gradle에 추가해야 한다.

스프링 부트 3.0은 jakarta.inject.Provider 사용

@Autowired
private Provider<PrototypeBean> provider;

public int logic() {
    PrototypeBean prototypeBean = provider.get();
    prototypeBean.addCount();
    int count = prototypeBean.getCount();
    return count;
}

실행해보면 provider.get() 을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환(DL)하기에, 항상 새로운 프로토타입 빈이 생성

ObjectProvider vs JSR-330 Provider

ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다.

만약 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용

웹 스코프

웹 스코프의 종류

• REQUEST : HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다
• SESSION : HTTP Session과 동일한 생명주기를 가지는 스코프
• APPLICATION : 서블릿 컨텍스트( ServletContext )와 동일한 생명주기를 가지는 스코프
• WEBSOCKET : 웹 소켓과 동일한 생명주기를 가지는 스코프

웹 스코프의 특징

웹 스코프는 웹 환경에서만 동작한다.
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료 시점까지 관리한다. 따라서 종료 메서드가 호출된다.

HTTP request 요청 당 각각 할당되는 request 스코프

request 스코프 예제

웹 환경 추가

웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가

//build.gradle에 web 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-web'

참고: spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.

참고: 스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 학습한 AnnotationConfigApplicationContext 을 기반으로 애플리케이션을 구동한다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

request 스코프 예제 개발

request 스코프를 사용하면, 동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 쉽다.

다음과 같이 로그가 남도록 request 스코프를 활용해서 추가 기능을 개발

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

• 기대하는 공통 포멧: [UUID][requestURL] {message}
• UUID를 사용해서 HTTP 요청을 구분하자.
• requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인하자.

MyLogger

package hello.core.common;

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;

@Component
@Scope(value = "request")
public class MyLogger {

    private String uuid;
    private String requestURL;

    public void setRequestURL(String requestURL) {
        this.requestURL = requestURL;
    }

    public void log(String message) {
        System.out.println("[" + uuid + "]" + "[" + requestURL + "] " + message);
    }

    @PostConstruct
    public void init() {
        uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] request scope bean create: " + this);
    }

    @PreDestroy
    public void close() {
        System.out.println("[" + uuid + "] request scope bean close: " + this);
    }
}

• 로그를 출력하기 위한 MyLogger 클래스이다.
• @Scope(value = "request") 를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
• 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
• 이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
• requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.

LogDemoController

package hello.core.web;

import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final MyLogger myLogger;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURL = request.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logDemoService.logic("testId");

        return "OK";
    }
}

• 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러다.
• 여기서 HttpServletRequest를 통해서 요청 URL을 받았다.
  • requestURL 값 http://localhost:8080/log-demo
• 이렇게 받은 requestURL 값을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
• 컨트롤러에서 controller test라는 로그를 남긴다.

참고: requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다.

LogDemoService

package hello.core.logdemo;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

    public void logic(String id) {
        myLogger.log("service id = " + id);
    }
}

• request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다. 더 문제는 requestURL 같은 웹과 관련된 정보가 웹과 관련 없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
• request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버 변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

스코프와 Provider

LogDemoController - Provider 추가

package hello.core.web;

import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider; // ObjectProvider 추가

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURL = request.getRequestURL().toString();
        MyLogger myLogger = myLoggerProvider.getObject(); // ObjectProvider.getObject() 추가
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logDemoService.logic("testId");

        return "OK";
    }
}

LogDemoService - Provider 추가

package hello.core.logdemo;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider; // ObjectProvider 추가

    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.getObject(); // ObjectProvider.getObject() 추가
        myLogger.log("service id = " + id);
    }
}

호출 결과

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

• ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
• ObjectProvider.getObject() 를 호출하시는 시점에는 HTTP 요청이 진행 중이므로 request scope 빈의 생성이 정상 처리된다.
• ObjectProvider.getObject() 를 LogDemoController , LogDemoService 에서 각각 한 번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!

스코프와 프록시

@Component
// @Scope(value = "request")
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
}

• proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가해주자.
  • 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS 를 선택
  • 적용 대상이 인터페이스면 INTERFACES 를 선택
• 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

웹 스코프와 프록시 동작 원리

동작 정리

1. CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
2. 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.

가짜 프록시 객체는 실제 request scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

특징 정리

• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.
• 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.
• 단지 애노테이션 설정 변경 만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강점이다.
• 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

주의점

• 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
• 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기
  어려워진다.

주입된 myLogger를 확인

System.out.println("myLogger = " + myLogger.getClass());

출력 결과

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

동작 상세 프로세스

1. CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.

   • @Scope 의 proxyMode = ScopedProxyMode.TARGET_CLASS) 를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체(MyLogger$$EnhancerBySpringCGLIB)를 생성 및 스프링 컨테이너에 등록한다.

   • ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.

   • 그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

2. 가짜 프록시 객체에 요청이 오면 진짜 빈을 요청하는 위임 로직이 수행된다.

   • 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.

   • 클라이언트가 myLogger.logic() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.

   • 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 를 호출한다.

   • 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

Reference

• 인프런 김영한 강의 - 스프링 핵심 원리 - 기본편