<Spring> 빈 스코프

라모스·2022년 1월 30일

Spring☘️

목록 보기

9/18

빈 스코프?

스프링 빈(Bean): 스프링 컨테이너에서 관리하는 자바 객체. 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때까지 유지된다.
스코프: 빈이 존재할 수 있는 범위

스프링 빈은 기본적으로 싱글톤 스코프로 생성되기 때문에 스프링 컨테이너의 생명 주기를 함께한다. 이 때문에 스코프와 생명 주기에 대해 따로 신경 쓸 필요가 없는 경우가 많았다.
하지만, 빈 스코프를 어떻게 설정하느냐에 따라 스프링 빈의 생성과 소멸을 클라이언트에서 관리해줘야 하는 경우도 발생할 수 있고, 이에 맞춰 다양한 요구사항에 맞는 스코프를 지정해 사용해야 할 때가 있다.

스프링은 다음과 같은 다양한 스코프를 지원한다.

싱글톤: 기본 스코프로, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.
프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
웹 관련 스코프
- request: 웹 요청이 들어오고 나갈 때까지 유지되는 스코프
- session: 웹 세션이 생성되고 종료될 때까지 유지되는 스코프
- application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프

빈 스코프 사용 방법

컴포넌트 스캔 자동 등록

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

수동 등록

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

프로토타입 스코프

일반적으로 스프링 컨테이너에 등록된 스프링 빈은 싱글톤 스코프를 갖기 때문에, 빈을 조회하면 항상 같은 인스턴스의 스프링 빈을 반환한다.

싱글톤 빈 요청

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

프로토타입 스코프 빈 요청

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

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

정리하자면, 핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 것이다. 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다. 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다. 따라서 @PreDestroy같은 종료 메서드가 호출되지 않는다.

싱글톤 스코프 테스트

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

빈 초기화 메서드를 실행하고, 같은 인스턴스의 빈을 조회하고, 종료 메서드까지 정상 호출된 것을 확인할 수 있다.

프로토타입 스코프 테스트

package hello.core.scope;

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

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

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

public class PrototypeTest {
    
    @Test
    public void prototypeBeanFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
        
        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);
        
        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

프로토타입 빈 2개가 참조하는 인스턴스 참조 주소값이 다르다. 또한 스프링 컨테이너 종료시 소멸 메서드가 실행되지 않았다.

📌 프로토타입 빈의 특징 정리?

스프링 컨테이너에 요청할 때 마다 새로 생성된다.

프로토타입 스프링 빈은 스프링 컨테이너와 생명주기를 달리한다. 컨테이너가 빈의 생성, 의존관계 주입, 초기화까지만 관여함.

종료 메서드가 호출되지 않는다.

클라이언트가 프로토타입 빈을 직접 관리해야 한다.(소멸 메서드도 직접 호출해야 함)

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

스프링 컨테이너에 프로토타입 스코프 빈과 싱글톤 빈을 함께 사용할 때는 의도한대로 동작하지 않고 문제가 발생한다.

프로토타입 빈 직접 요청

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

결과적으로 프로토타입 빈(x01)의 count는 1이 된다.

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

결과적으로 프로토타입 빈(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은 의존관계 자동 주입을 사용. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환. 프로토타입 빈의 count 필드 값은 0

clientBean은 프로토타입 빈을 내부 필드에 보관한다. (참조값을 보관)

클라이언트 A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이기 때문에 항상 같은 빈이 반환된다.
3. 클라이언트 A는 clientBean.logic()을 호출
4. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. count 값은 1이 됨.

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

중요한 점은, clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 사용할 때 마다 새로 생성되는 것이 아니라 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성된 것이다.

클라이언트 B는 clientBean.logic()을 호출
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");
        }
    }
}

Provider로 문제 해결

싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 사용할 때 마다 항상 새로운 프로토타입 빈을 생성하는 방법은 무엇일까?

스프링 컨테이너에 요청

싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 방식이다.

public class PrototypeProviderTest {

    @Test
    void providerTest() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
        
        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int count1 = clientBean1.logic();
        asserThat(count1).isEqualTo(1);
        
        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        asserThat(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;
        }
    }

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

실행해보면 ac.getBean()을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

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

하지만, 이런식으로 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.

ObjectFactory, ObjectProvider

지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 대신 DL 정도의 기능만 제공하는 것이 바로 ObjectProvider이다. ObjectFactory에서 편의 기능을 추가한 것이 ObjectProvider이다.

@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

실행해보면 prototypeBeanProvider.getObject()을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
ObjectProvider의 getObject()를 호출하면 내부에선 스프링 컨테이너를 통해 해당 빈을 찾아 반환한다.(DL)
스프링이 제공하는 기능을 사용하지만, 기능이 단순해서 단위테스트를 만들거나 mock 코드를 만들기 훨씬 쉬워지는 효과가 있다.

ObjectFactory: 기능이 단순하고, 별도의 라이브러리가 필요 없다. 스프링에 의존적.
ObjectProvider: ObjectFactory를 상속함. 옵션, 스트림 처리 등 편의 기능이 많고 별도의 라이브러리가 필요 없다. 스프링에 의존적.

JSR-330 Provider

스프링 의존성을 해소하는 방법은 javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법이다.

javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다.

build.gradle에 라이브러리 추가

...

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    implementation 'javax.inject:javax.inject:1'
    ...
}

테스트 코드 변경

package javax.inject;
public interface Provider<T> {
    T get();
}

static class ClientBean {
    @Autowired
    private Provider<PrototypeBean> prototypeBeanProvider;
    
    public int logic() {
        PrototypeBean prototypeBean = prototypeBeanProvider.get();
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
    }
}

provider.get()을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
위 메소드를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아 반환한다.(DL)
자바 표준이고, 기능이 단순하기에 단위테스트도 가능하고 mock 코드를 만들기도 쉬워진다.
별도의 라이브러리가 필요하다.
자바 표준이라 스프링이 아닌 다른 컨테이너에서도 사용 가능하다.

프로토타입 빈을 사용하는 시기?

매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다. 실무에서 웹 애플리케이션을 개발하다보면, 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.

📌 JSR-330 Provider vs ObjectProvider?
자바 표준과 스프링이 제공하는 기능 중에 선택해야 한다면, 대부분 스프링이 더 다양하고 편리한 기능을 제공하기 때문에 특별한 이유가 없다면 이를 사용하면 된다.

웹 스코프

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

종류

request: HTTP 요청이 들어오고 나갈때까지 유지되는 스코프. 각각의 요청마다 별도의 빈 인스턴스가 생성되고 관리됨.
session: HTTP Session과 동일한 생명주기를 가지는 스코프
application: 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가지는 스코프
websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프

네 종류 모두 범위만 다르지 동작 방식은 비슷하다.

request 스코프 예제

웹 스코프 범위에서 로그가 남도록 하는 빈을 만들어보자.

Format: [UUID][requestURL]{message}

UUID를 사용해서 HTTP 요청을 구분하고, requestURL 정보로 어떤 URL을 요청해서 남은 로그인지 확인하는 예제이다.

1. `build.gradle`에 web 환경 추가

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

📌 참고

위 라이브러리를 추가하면 스프링 부트는 내장 톰캣 서버를 활용하여 웹 서버와 스프링을 함께 실행한다.

해당 라이브러리가 없다면 지금까지처럼 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동한다.

웹 라이브러리가 추가되면 웹 관련 기능 및 설정이 필요하기 때문에 AnnotationConfigServletWebServerApplicationContext를 기반으로 애플리케이션을 구동한다.

2. 코드 작성

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 요청과 구분할 수 있게 된다.
빈이 생성되는 시점에는 requestURL을 알수 없어 외부에서 setter로 입력 받는다.

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

MyLogger가 제대로 작동하는지 확인하는 클래스(테스트용 컨트롤러)
HttpServletRequest를 통해 요청 URL을 받아 setter로 저장
컨트롤러에 controller test 로그를 남기고 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 score의 MyLogger 덕분에 코드와 게층을 깔끔하게 유지할 수 있다.
웹과 관련 없는 서비스계층에 웹과 관련된 정보가 넘어간다.(requestURL)
웹과 관련된 부분은 컨트롤러까지만 사용되고 서비스 계층에서는 웹 기술에 종속되지 않는게 좋다.

3. 실행 및 결과

기대하는 출력은 다음과 같다.

[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

실제로는 다음과 같이 실행 시점에 오류가 발생한다.

Error creating bean with name 'myLogger': Scope 'request' is not active for the
current thread; consider defining a scoped proxy for this bean if you intend to
refer to it from a singleton;

스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않고 실제 고객의 요청이 와야 생성할 수 있기 때문이다.

해당 프로젝트가 구동될 때 스프링 빈들이 컴포넌트 스캔이 되며 등록 및 의존관게 주입이 되는데, 여기서 웹 스코프인 MyLogger 빈의 경우 HTTP request 요청이 올 때 생성되는 빈이기 때문에 스프링 구동단계에선 아직 생성이 안된다. 따라서 해당 에러가 발생하게 된다.

스코프와 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.servelt.http.HttpServletRequest;

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    
    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider;
    
    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURL = request.getRequestURL().toString();
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.setRequestURL(requestURL);
        
        myLogger.log("controller test");
        logDemoService.logic("testId");
        return "OK";
    }
}

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;
    
    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.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를 사용해 getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
ObjectProvider.getObject()를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리됨.
ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각각 한번씩 따로 호출해도 같은 HTTP 요청일 경우 같은 스프링 빈이 반환된다.

스코프와 프록시

스코프 속성을 활용해 스프링 빈을 프록시 객체로 만들어 줄 수 있다.

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

proxyMode = ScopedProxyMode.TARGET_CLASS 속성을 활용한다는 점이 핵심이다.
- 적용대상이 인터페이스가 아닌 클래스이기 때문에 TARGET_CLASS를 선택
- 적용대상이 인터페이스일 경우 INTERFACES 선택
이 결과, MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래슬르 다른 빈에 미리 주입해둘 수 있다.

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

myLogger의 클래스를 다음과 같이 출력해보면 hello.core.common.MyLogger가 출력되지 않고 이를 상속한 임의의 객체가 생성되는 것을 확인할 수 있다.

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

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

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

@Scope의 proxyMode를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용하여, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
스프링 컨테이너에는 이 프록시 객체가 등록된다. 그 결과 ac.getBean()으로 조회해도 해당 프록시 객체가 조회된다.
의존관계 주입도 이 가짜 프록시 객체가 주입된다.

가짜 프록시 객체는 요청이 오면 그 때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.

가짜 프록시 객체는 원본 클래스를 상속받아 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다.(다형성)
Provider를 사용하든, 프록시를 사용하든 핵심은 객체 조회를 꼭 필요한 시점까지 지연로딩하는 점이다.
애노테이션 속성 추가만으로 원본 객체를 프록시 객체로 대체할 수 있는데, 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강점이다.

📌 주의점?

마치 싱글톤을 사용하는 것 같으나, 다르게 동작하기 때문에 주의해서 사용해야 한다.

이런 특별한 scope는 꼭 필요한 곳에서만 최소화해서 사용하자. 무분별하게 사용하면 유지보수하기 어려워진다.

References

김영한님의 스프링 핵심원리 - 기본편

라모스

Step by step goes a long way.

이전 포스트

<Spring> 빈 생명주기 콜백

다음 포스트

<Spring> 빈 스코프

Spring☘️

빈 스코프?

빈 스코프 사용 방법

프로토타입 스코프

싱글톤 빈 요청

프로토타입 스코프 빈 요청

싱글톤 스코프 테스트

프로토타입 스코프 테스트

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

프로토타입 빈 직접 요청

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

Provider로 문제 해결

ObjectFactory, ObjectProvider

JSR-330 Provider

프로토타입 빈을 사용하는 시기?

웹 스코프

종류

request 스코프 예제

1. `build.gradle`에 web 환경 추가

2. 코드 작성

3. 실행 및 결과

스코프와 Provider

스코프와 프록시

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

References

<Spring> 빈 생명주기 콜백

<Spring> ThreadLocal

0개의 댓글

<Spring> 빈 스코프

Spring☘️

빈 스코프?

빈 스코프 사용 방법

프로토타입 스코프

싱글톤 빈 요청

프로토타입 스코프 빈 요청

싱글톤 스코프 테스트

프로토타입 스코프 테스트

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

프로토타입 빈 직접 요청

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

Provider로 문제 해결

ObjectFactory, ObjectProvider

JSR-330 Provider

프로토타입 빈을 사용하는 시기?

웹 스코프

종류

request 스코프 예제

1. build.gradle에 web 환경 추가

2. 코드 작성

3. 실행 및 결과

스코프와 Provider

스코프와 프록시

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

References

<Spring> 빈 생명주기 콜백

<Spring> ThreadLocal

0개의 댓글

1. `build.gradle`에 web 환경 추가