[스프링 기본] 빈 스코프 - 2

웹 스코프

웹 스코프의 특징

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

웹 스코프 종류

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

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

request 스코프 예제 만들기

웹 환경 추가 (build.gradle 에 추가)

implementation 'org.springframework.boot:spring-boot-starter-web'

MyLogger 클래스를 만들어 예제로 확인해본다.

@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로 입력 받는다.

Controller 도 만들어준다.

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

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의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

실제로 이 코드를 돌려보면 실행오류가 뜨게 된다.
이를 이제 수정해보도록 하자.

해결방안 1. 스코프와 Provider

ObjectProvider를 사용해서 해결할 수 있다.

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

public class LogDemoService {
 	private final ObjectProvider<MyLogger> myLoggerProvider;
 	public void logic(String id) {
 		MyLogger myLogger = myLoggerProvider.getObject();
 		myLogger.log("service id = " + id);
 	}
}

로 수정해주면 잘 돌아가는 것을 확인할 수 있다.

해결방안 2. 스코프와 프록시

프록시 방식을 사용해서 해결할 수 있다.

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

이런 식으로 proxyMode를 추가해주면 된다.
그리고 나머지 코드는 ObjectProvider를 사용하지 않는 오류가 났던 코드로 변경해주면 된다.

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

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

• @Scope 의 proxyMode =ScopedProxyMode.TARGET_CLASS) 를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
• 결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLogger$$EnhancerBySpringCGLIB 이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다.
• 그리고 스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.
• ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있
  다.
• 그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

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

• 가짜 프록시 객체는 내부에 진짜 myLogger 를 찾는 방법을 알고 있다.
• 클라이언트가 myLogger.log() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
• 가짜 프록시 객체는 request 스코프의 진짜 myLogger.log() 를 호출한다.
• 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

동작 정리

• CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
• 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
• 가짜 프록시 객체는 실제 request scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

특징 정리

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

주의점

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