이글은 김영한님의 강의 스프링 핵심 원리 - 기본편에서 나온 빈의 생명주기와 스코프에 관한 내용을 정리한 글이며 강의 자료 및 링크는 가장 아래에서 확인할 수 있다.
빈의 생명주기
스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음 데이터를 사용할 수 있는 상태가 된다.
그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?
크게 3가지 방법이 있는데 여기선 그중 가장 최근에 많이 사용하는 방법인 @PostConstruct,@PreDestroy를 사용하여 살펴보도록 하자.
선수지식으로 스프링 빈의 이벤트 라이프사이클은 아래와 같다.
* 스프링 빈의 이벤트 라이프사이클
스프링 컨테이너 생성 → 스프링 빈 생성 → 의존관계 주입 → 초기화 콜백 → 사용 → 소멸전 콜백 → 스프링 종료
코드를 살펴보며 위 어노테이션을 적용하고, 생명주기를 알아보자
public class NetworkClient{
private String url;
public NetworkClient(){
System.out.println("생성자 호출 , url = " + url);
}
public void setUrl(String url){
this.url = url;
}
public void connect(){
System.out.println("connect:" + url);
}
public void call(String message){
System.out.println("call:" + url + " message = " + message);
}
public void disconnect(){
System.out.println("close:" + url);
}
@PostConstruct
public void init(){
System.out.println("NetworkClient.init");
connect();
call("초기화 연결 메시지");
}
@PreDestroy
public void close(){
System.out.println("NetworkClient.close");
disconnect();
}
}
위의 코드를 간략하게 요약하면 위 라이프 사이클중 초기화 콜백시 init()메서드를 호출하고 소멸 콜백시 close()메서드를 호출한다.
@Configuration
static class LifeCycleConfig {
@Bean
public NetworkClient networkClient() {
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("http://hello-spring.dev");
return networkClient;
}
}
위와 같이 Config클래스를 생성하여 networkClient를 생성한뒤 url을 변경시켜준다.
이제 아래의 테스트 코드를 실행시켜보면
@Test
public void lifeCycleTest() {
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
NetworkClient client = ac.getBean(NetworkClient.class);
ac.close(); //스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
}
결과는 아래와 같다.
정리해보면 다음과 같다.
다시 라이프사이클을 상기시켜보자.
스프링 컨테이너 생성 → 스프링 빈 생성 → 의존관계 주입 → 초기화 콜백 → 사용 → 소멸전 콜백 → 스프링 종료
1. 스프링 컨테이너 생성 → 스프링 빈 생성
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
스프링 컨테이너가 생성되고 우측에 Config클래스를 지정해두었으니 해당 Config클래스에 있는 Bean이 생성될것이다.
따라서 생성자가 호출되면서 url이 null인 상태임을 확인할 수 있다.
2. 의존관계 주입
networkClient.setUrl("http://hello-spring.dev");
위에서 의존관계 주입(수정자 주입)이 일어나고 있다.
3. 초기화 콜백
@PostConstruct
public void init(){
System.out.println("NetworkClient.init");
connect();
call("초기화 연결 메시지");
}
의존관계 주입이 완료된후 초기화 콜백을 요청한다.
connect() 호출 시점에 결과가 connect:http://hello-spring.dev 로 나타난것을 보면, 2번 의존관계 주입이 끝난 뒤에 호출된것을 확인할 수 있다.
4. 사용
NetworkClient client = ac.getBean(NetworkClient.class);
컨테이너에 있는 bean을 가져와서 사용한다.
5. 소멸전 콜백
ac.close()
스프링 컨테이너가 종료되고나서,
@PreDestroy
public void close(){
System.out.println("NetworkClient.close");
disconnect();
}
소멸전 콜백을 호출한다.
6. 종료
애플리케이션이 종료되는 시점이다.
모든 생명주기가 끝났다. 위 예제로 빈 생명주기는 객체를 먼저 생성하고 의존관계를 주입하는 것을 알수있으며, 사용자는 어노테이션을 사용하여 콜백 시점을 알수있다
* @PostConstruct, @PreDestroy 어노테이션의 특징
@PostConstruct, @PreDestroy 어노테이션은 최신 스프링에서 가장 권장하는 방법이며, 컴포넌트 스캔과 잘 어울린다. 또한 위 예제처럼 어노테이션 하나만 붙이면 되므로 매우 편리하다.
빈 스코프
빈 스코프는 말그대로 빈이 존재할수 있는 범위를 뜻한다.
스프링 빈은 기본적으로 싱글톤 스코프로 생성되기때문에 앞서 빈을 사용한 예제는 모두 싱글톤 스코프를 사용한 예제이다.
스프링은 크게 다음과 같은 스코프를 지원한다.
* 스프링의 다양한 스코프 지원
간단하게 빈 스코프는 다음과 같이 지정할 수 있다.
// 컴포넌트 스캔 자동 등록
@Scope("prototype")
@Component
public class HelloBean{}
// 수동 등록
@Scope("prototype")
@Bean
PrototypeBean HelloBean(){
return new HelloBean();
}
싱글톤 스코프와 프로토타입 스코프를 비교하며 프로토타입 스코프가 어떤것인지 살펴보자.
* 싱글톤 빈 요청과 프로토타입 빈 요청
1. 싱글톤 빈 요청
모든 클라이언트에게 동일한 빈을 반환하는 것을 확인할 수 있다.
2. 프로토타입 빈 요청
클라이언트의 요청마다 빈을 생성하고, 의존관계를 주입한뒤 반환하는 모습을 확인할 수 있다.
여기서 중요한점은 스프링 컨테이너는 프로토타입 빈의 경우 생성,의존관계 주입,초기화까지만 처리해준다.
즉, 프로토타입 빈의 관리책임은 빈을 받은 클라이언트에게 있으며 @PreDestroy와 같은 종료 메서드가 호출되지 않는다.
프로토타입은 싱글톤 빈과 함께 사용시 문제가 발생한다.
아래의 그림으로 살펴보자.
먼저, 싱글톤빈인 ClientBean이 프로토타입 빈을 주입받는다고 생각해보자.
스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환하므로, 프로토타입 빈의 count필드 값은 0이다.
클라이언트A가 clientBean을 컨테이너에 요청해서 받는다. 여기서 clientBean은 싱글톤이므로 항상 같은 빈이 반환된다.
클라이언트A는 프로토타입빈의 addCount()를 호출하여 빈의 count를 증가시켜 count값이 1이 되었다.
클라이언트B 또한 clientBean을 컨테이너에 요청해서 받는다. 싱글톤이므로 위와 동일한 빈이 반환된다.
여기서 clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다.
주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성된 것이며, 사용 할 때마다 새로 생성되는 것이 아니다.
따라서 클라이언트B는 프로토타입빈의 addCount()를 호출하여 프로토타입 빈의 count를 증가시켜 2가 된다.
위 예제와 동일하게 스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다.
싱글톤 빈은 생성시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는것이 문제다.
💡만약 여러 빈에서 같은 프로토타입 빈을 주입 받는다면?
만약 여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성된다.
예를 들어 clientA, clientB가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받는다.
clientA > prototypeBean@x01
clientB > prototypeBean@x02
물론 위와 동일하게 사용할 때 마다 새로 생성되는 것은 아니다.
따라서 스프링은 지정한 빈을 컨테이너에서 대신 찾아주는 DL(Dependency Lookup, 의존성 검색) 서비스를 제공한다.
제공하는 어노테이션은 @ObjectProvider와 @ObjectFactory가 있으며 @ObjectProvider는 @ObjectFactory에 편의 기능을 추가하여 나온 것이다.
위 어노테이션을 적용한 예제를 살펴보자.
public class PrototypeProviderTest {
@Test
void prototypeFind(){
AnnotationConfigApplicationContext ac= new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
ClientBean clientBean1 = ac.getBean(ClientBean.class);
int count1 = clientBean1.logic();
Assertions.assertThat(count1).isEqualTo(1);
ClientBean clientBean2 = ac.getBean(ClientBean.class);
int count2 = clientBean2.logic();
Assertions.assertThat(count2).isEqualTo(1);
}
static class ClientBean{
@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");
}
}
}
테스트 결과는 ClientBean1과 ClientBean2 모두 1로, 통과하며, 설명하자면 아래와 같다.
먼저, ClientBean에서 프로토타입빈이 ObjectProvider에 감싸진후 주입받는 모습을 확인할 수 있다.
따라서 위 코드를 실행해보면 prototypeBeanProvider.getObject()를 통해서 항상 새로운 프로토타입 빈이 생성되는것을 확인할 수 있다.
ObjectProvider의 getObject()를 호출하면 내부에서 컨테이너를 통해 해당 빈을 찾아서 반환(Dependency Lookup)하기 때문에 새로운 프로토타입 빈이 계속 생성되는 것이다.
여기서 알아둬야할 점은 호출할때 빈을 찾아서 반환하기 때문에 런타임까지 빈의 생성을 지연할 수 있다.
💡참고로 위 방법은 스프링에 의존하며 , 별도의 라이브러리가 필요없다. javax.inject.Provider라는 자바 표준을 사용하는 방법도 있는데 라이브러리를 추가해야한다.
위 내용을 정리해보자면 프로토타입 빈은 의존관계 주입이 완료된 새로운 객체가 필요할때 사용하면 된다는 사실을 알 수 있다. 그러나 실무에서 싱글톤 빈으로 대부분 문제를 해결할 수 있기때문에 사용하는 일은 매우 드물다고한다.
마지막으로 빈 스코프중 웹 스코프를 살펴보자.
웹 스코프는 웹 환경에서만 동작하고, 프로토타입과 다르게 종료시점까지 관리한다. 따라서 종료 메서드도 호출한다
* 웹 스코프 종류
* request 스코프
request 스코프는 HTTP 요청마다 생성되는 것을 확인할 수 있다.
웹 스코프 예제를 살펴보자.
먼저 웹 환경에서만 동작하므로 스프링 부트의 내장 서버인 톰캣이 작동하도록 해야한다.
따라서 build.gradle에 아래 코드를 추가해준다.
implementation 'org.springframework.boot:spring-boot-starter-web'
이제 main 메서드를 실행하면 웹 어플리케이션이 실행되고, 톰캣 서버를 활용할수 있게 된다.
💡스프링 부트가 웹 라이브러리가 없다면?
스프링 부트는 웹 라이브러리가 없다면 지금까지 예제로 살펴본
AnnotationConfigApplicationContext를 기반으로 어플리케이션을 구동한다.
웹 라이브러리가 추가되면 추가 설정과 환경들이 필요하므로
AnnotationConfigServletWebServerApplicationContext를 기반으로 어플리케이션을 구동한다.
예제 코드를 살펴보자.
1. 컨트롤러
@Controller
public class LogDemoController {
@Autowired
private final LogDemoService logDemoService;
@Autowired
private final MyLogger myLogger;
public LogDemoController(LogDemoService logDemoService, MyLogger myLogger){
this.logDemoService = logDemoService;
this.myLogger = myLogger;
}
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request){
String requestURL = request.getRequestURI().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}
2. 서비스
@Service
public class LogDemoService {
private final MyLogger myLogger;
public LogDemoService(MyLogger myLogger){
this.myLogger = myLogger;
}
public void logic(String id){
myLogger.log("service id = " + id);
}
}
3. MyLogger
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
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);
}
}
빈 스코프가 request인 빈은 request요청이 있을때 생성되기 때문에 위 상태에서 실행시키게 되면 없는 빈을 주입하게 되는것이나 마찬가지이기 때문에 오류가 발생하게 된다.
따라서 앞에서 사용한 ObjectProvider를 사용한다.
Controller와 Service에서 MyLogger를 주입받는부분을 ObjectProvider<MyLogger>로 변경해준다.
@Controller
public class LogDemoController {
@Autowired
private final LogDemoService logDemoService;
@Autowired
private final ObjectProvider<MyLogger> myLoggerProvider;
public LogDemoController(LogDemoService logDemoService, ObjectProvider<MyLogger> myLogger){
this.logDemoService = logDemoService;
this.myLoggerProvider = myLogger;
}
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request){
String requestURL = request.getRequestURI().toString();
MyLogger myLogger = myLoggerProvider.getObject();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}
@Service
public class LogDemoService {
private final ObjectProvider<MyLogger> myLoggerProvider;
public LogDemoService(ObjectProvider<MyLogger> myLogger){
this.myLoggerProvider = myLogger;
}
public void logic(String id){
MyLogger myLogger = myLoggerProvider.getObject();
myLogger.log("service id = " + id);
}
}
위와 같이 변경하고 실행하게 되면 아래와같이 정상출력이 되는것을 볼 수 있다.
원리는 다음과 같다.
ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
만약, Controller와 Service에서 각각 한번씩 따로 ObjectProvider.getObject()를 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.
위에서 한걸음더 나아가 프록시를 이용하는 방법이 있다.
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
}
```
위와 같이 스코프에 프록시모드를 설정하는것이다.
적용 대상이 인터페이스가 아니라면 TARGET_CLASS, 인터페이스면 INTERFACES를 선택한다.
이제 나머지 코드를 Provider 사용 이전으로 돌려두고 실행하게되면 잘 동작하는 것을 확인할 수 있다.
원리는 다음과 같다.
1.CGLIB 라이브러리로 클래스를 상속 받은 가짜 프록시 객체를 우선 만들어서 주입한다.
2.가짜 프록시 객체는 요청이 오면 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
3.이 가짜 프록시 객체는 실제 request 스코프와 관계가 없다. 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.
주의할점은 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 주의해서 사용해야 하며, 이런 scope는 꼭 필요한 곳에 최소화해서 사용한다. 무분별하게 사용하면 유지보수하기 어려워지기 때문이다.
마지막으로 위에서 자주언급한 DL(의존성 검색)을 정리해보자.
DL(Dependency Lookup,의존성 검색)
의존성 주입을 지연시켜 의존성을 검색해야 할때 사용한다.
예를 들어 프로토타입 빈이나 request 스코프빈을 사용할때 사용할수 있다.
위와같이 ObjectProvider를 사용하는 방법이 있으며, 이 방법은 .getObject()를 호출하기 전까지 빈의 생성을 지연시킨다.
* 강의자료
'Spring' 카테고리의 다른 글
Spring MVC 정리 3) 검증 (0) | 2023.11.06 |
---|---|
Spring MVC 정리 2)단계별로 구현하며 알아보는 스프링의 핵심 기술 (0) | 2023.10.25 |
Spring MVC 정리 1)웹 어플리케이션의 이해 (0) | 2023.10.20 |
의존성 주입으로 살펴보는 컴포넌트와 자동 주입 (0) | 2023.09.15 |
의존성 주입으로 살펴보는 스프링 컨테이너와 싱글톤 컨테이너 (0) | 2023.09.12 |