빈 스코프

빈 스코프

🔹 빈이 존재할 수 있는 범위
1. 싱글톤
2. 프로토타입
3. 웹 스코프

🔹 컴포넌트 스캔 자동 등록

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

🔹 컴포넌트 스캔 수동 등록

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

프로토타입

🔹 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 짧은 범위의 스코프
🔹 프로토타입 스코프를 스프링 컨테이너에 조회하면 항상 새로운 인스턴스를 생성해서 반환한다.

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

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

프로토타입 스코프: 스프링 컨테이너는 프로토타입 빈을 생성하고 의존관계 주입과 초기화까지만 처리한다. 클라이언트에 빈을 반환하고 이후 생성된 프로토타입 빈을 관리하지 않는다. 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다. 그래서 스프링 빈 컨테이너가 종료될 때 @PreDestroy와 같은 종료 메서드는 호출되지 않는다.

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) 같은 인스턴스의 빈을 조회한다.
3) 종료 메서드까지 정상 호출된다.

웹 관련 스코프

🔹 웹 환경에서만 동작한다.
🔹 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.
1) request: 웹 요청이 들어오고 나갈 때까지 유지되는 스코프
2) session: 웹 세션이 생성되고 종료될 때까지 유지되는 스코프
3) application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프
4) websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프

🔸 MyLogger.java
🔹 동시에 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이런 경우 request 스코프를 사용하면 좋다.
🔹 로그 출력을 위한 MyLogger class
🔹 @Scope(value = "request")로 request 스코프 지정
🔹 빈이 생성되는 시점에 자동으로 초기화 메서드를 사용해서 uuid 생성 후 저장한다. 이 빈은 HTTP 요청 당 하나씩 생성되기 때문에 uuid를 저장해두면 구분할 수 있다.
🔹 requestURL은 빈이 생성되는 시점에는 알 수 없기 때문에 외부에서 setter로 입력 받는다.

@Component
@Scope(value = "request")
public class MyLogger{
	private String uuid;
    private String requestURL;
    
    public void log(String message){System.out.println("["+uudi+"]["+requestURL+"]"+message);}
    
    @PostConstruct
    public void init(){
    	uuid = UUID.randomUUID().toString();
        System.out.println("["+uudi+"] request scope bean create"+this);
    }
    
    @PreDestroy
    public void close(){
    	System.out.println("["+uudi+"] request scope bean close"+this);
    }
}

🔸 LogDemoController.java
🔹 로거가 제대로 작동하는지 확인하기 위한 테스트용 컨트롤러
🔹 requestURL 값을 myLogger에 저장
🔹 myLogger는 HTTP 요청 당 각각 구분되기 때문에 값이 섞이지 않는다.

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

🔸 LogDemoService.java
🔹 비지니스 로직이 있는 서비스 계층

@Service
@RequiredArgsConstructor
public class LogDemoService{
	private final MyLogger myLogger;
    
    public void logic(String id){
    	myLogger.log("service id = "+id);
    }
}

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

🔹 실행 시점에 오류 발생

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 스코프 빈은 아직 생성되지 않는다. request 스코프 빈은 실제 고객의 요청이 와야 생성할 수 있다.
💡 해결방안: Provider를 사용하면 해결할 수 있다. 이 내용은 다음 포스팅에 설명되어있다.