22 Dec 2018

Toby's Spring Chap 13: 스프링 @MVC

스프링은 DispatcherServlet과 7가지 전략을 기반으로 한 MVC 프레임워크를 제공한다. 특히 2.5부터 시작하여 3.0에서 강화된 애너테이션을 활용한 전략은 컨트롤러 작성에 있어서 많은 변화를 가져왔다.

@RequestMapping 핸들러 매핑

@MVC의 가장 큰 특징은 핸들러 매핑과 핸들러 어댑터 대상이 컨트롤러 오브젝트가 아닌 메소드라는 점이다. 이전에는 특정 컨트롤러는 특정 인터페이스를 구현해야되는 구조로 인해, URL 당 하나의 컨트롤러 오브젝트가 매핑되고 그 인터페이스의 특정 메소드가 호출을 받을 수 있었다.

그러나 대상의 타입이나 코드에 영향을 받지 않는 애너테이션을 활용함으로써 메소드 레벨까지 세분화해서 매핑 및 호출할 수 있게 되었다.

DefaultAnnotationHandlerMapping (스프링 3.1부터는 RequestMappingHandlerMapping)은 핸들러 매핑 정보로 @RequestMapping 애너테이션을 활용한다.

@RequestMapping은 클래스나 메소드 둘다 붙일 수 있으므로, 스프링은 클래스에 정의된 @RequestMapping을 기준으로 삼아 메소드 레벨의 @RequestMapping 정보를 통해 더 세분화하여 요청 정보와 핸들러 간의 매핑을 적용한다.

@RequestMapping

DefaultAnnotationHandlerMapping (RequestMappingHandlerMapping)의 핵심은 핸들러 매핑 정보로 @RequestMapping 애너테이션을 활용한다는 점이다.

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
	String name() default "";

	@AliasFor("path")
	String[] value() default {};
	@AliasFor("value")
	String[] path() default {};

	RequestMethod[] method() default {};
	String[] params() default {};
	String[] headers() default {};

	String[] consumes() default {};
	String[] produces() default {};
}

다음은 @RequestMapping 애너테이션에서 사용 가능한 엘리먼트의 종류로, 이를 기반으로 매핑을 진행한다.

value: String 배열로 하나 이상의 URL 패턴을 지정, ANT 패턴을 사용할 수도 있다.
method: HTTP 메소드를 지정
params: HTTP의 쿼리 파라미터와 값을 추가적으로 매핑 정보로 활용한다.
headers: HTTP 헤더 정보를 매핑 정보로 활용한다.
consumes: HTTP 헤더의 Content-Type을 매핑 정보로 활용한다.
produces: HTTP 헤더의 Accepts를 매핑 정보로 활용한다.

여러 개의 @RequestMapping으로 정의한 것이 있고, 어떤 request 요청이 여러 매핑 조건에 대해 만족한다면 좀 더 많은 조건을 만족시키는 쪽으로 우선시되어 매핑된다.

@RequestMapping 정보는 상속되며, 서브 클래스에서 @RequestMapping을 재정의하면 상위에서 정의한 @RequestMapping은 무시된다.

파라미터

@Controller 애너테이션은 빈 스캔에 의해 자동 인식을 할 수 있게 하는 스테레오 타입의 애너테이션이지만, 이 말고도 컨트롤러 역할을 담당하는 메소드 정의를 자유롭게 지정할 수 있게 해준다.

개발자가 마음대로 필요한 파라미터와 리턴 값을 자유롭게 애너테이션과 결합하여 정의할 수 있다. 이를 가능케하는 핸들러 어댑터는 매우 복잡하다. 스프링은 파라미터와 리턴 값, 애너테이션이 어떻게 선언되어 있는지 살펴보고, 이를 이용해 적절한 파라미터 값을 준비하여 호출해준다.

HttpServletRequest, HttpServletResponse: 해당 타입이 파라미터로 정의되어 있다면 해당 서블릿 오브젝트를 받을 수 있다.
HttpSession: HTTP 세션이 필요할 경우 사용. 멀티스레드 안정성이 보장되지 않으므로 핸들러 어댑터의 synchronizeOnSession 프로퍼티를 true로 설정한다.
WebRequest, NativeWebRequest: HttpServletRequest의 대부분 정보를 갖고 있는, 서블릿 API에 종속적이지 않은 오브젝트 타입이다.
Locale: java.util.Locale 타입으로 LocaleResolver가 결정한 Locale 오브젝트를 받을 수 있다.
InputStream, Reader: HttpServletRequest의 getInputStream으로 얻을 수 있는 스트림이나 Reader를 받을 수 있다.
OutputStream, Writer: HttpServletResponse의 getOutputStream으로 가져올 수 있는 스트림 또는 Writer를 받을 수 있다.
@PathVariable: @RequestMapping에 있는 {} 로 들어가는 PathVaraible의 값을 받는다.
@RequestParam: 쿼리 파라미터 값을 받는다. 만약 파라미터 이름을 지정하지 않고 Map 형식의 파라미터 타입을 지정하면 모든 파라미터를 Map 오브젝트로 받는다. 필수 여부나 디폴트 값을 지정할 수도 있다.
- 타입 변환 작업이 실패하면 예외가 발생한다.
@CookieValue: 쿠키 값을 받는다.
@RequestHeader: HTTP 헤더의 정보를 받는다.
Map, Model, ModelMap: 핸들러 어댑터는 모델에 정보를 추가하기 위해 사용하는 오브젝트를 미리 만들어 컨트롤러 메소드로 제공해줄 수 있다.
@ModelAttribute: 도메인 오브젝트의 프로퍼티에 쿼리 파라미터를 바인딩하여 한 번에 받을 수 있다. 스프링은 setter를 통해 프로퍼티에 값을 설정해준다.
- 컨트롤러가 리턴하는 모델 맵에 담기는 모델 오브젝트이다.
- 파라미터를 바인딩하기 전에 오브젝트를 생성하기 위해 디폴트 생성자가 반드시 필요하다.
- @SessionAttribute에 의해 세션에 저장된 모델 오브젝트가 있다면 새로 오브젝트를 생성하는 대신, 세션에 저장되어 있던 오브젝트를 사용한다.
- 사용자 요청 값에 대한 추가적인 검증 작업이 추가된다. 핸들러 어댑터는 검증 결과를 컨트롤러에게 제공해준다.
- @RequestParam과는 다르게 요청 값에 대한 타입 변환이 실패하였다고 해서 작업이 중지되지 않는다. 다만 BindingResult나 Error에 변환 결과가 같이 저장되어 컨트롤러로 전달된다.
- 변환 작업이나 검증에 실패했을 때, BindingResult나 Error 타입의 파라미터가 없다면 BindingException 예외가 발생한다.
Errors, BindingResult: @ModelAttribute가 정의된 파라미터 바로 뒤에 붙여서 사용해야 한다.
SessionStatus: 모델 오브젝트를 세션에 저장해두어 다음 request에도 활용할 수 있는데, 필요없게 될 경우 제거해야 한다. 이 때 필요한 것이 SessionStatus 타입 오브젝트이다.
@RequestBody: HTTP 요청의 바디 부분이 전달된다. 핸들러 어댑터는 미디어 타입과 파라미터 타입을 보고 결정한 HttpMessageConverter를 거쳐서 변환된 바디 내용을 전달해준다.
@Value: 시스템 프로퍼티나 다른 빈의 프로퍼티 값 등을 사용할 수 있다.
@Valid: 빈 검증기를 통해 모델 오브젝트를 검증하도록 지시하는 애노테이션이다. 보통 @ModelAttribute와 같이 사용한다.

리턴 타입의 종류

@MVC 컨트롤러 메소드는 리턴 타입도 자유롭게 지정할 수 있다.

컨트롤러가 DispatcherServlet에게 돌려줘야 하는 것은 모델과 뷰이다. 핸들러 어댑터를 통해 최종적으로 DispatcherServlet으로 리턴되는 것은 ModelAndView 타입이다. 물론 ModelAndView를 무시하고 HttpServletResponse에 직접 응답 값을 넣어줄 수도 있다.

리턴 타입은 기타 정보와 결합하여 최종적으로 ModelAndView로 만들어진다.

ModelAndView / Map / Model / ModelMap : 컨트롤러가 리턴하는 정보를 담는다.
String: 뷰 이름으로 사용된다.
void: 뷰 이름은 RequestToViewNameResolver 전략에 의해 자동으로 결정된다.
모델 오브젝트: 뷰 이름은 RequestToViewNameResolver를 통해 자동 생성하도록 하고, 모델 오브젝트가 하나 뿐이라면 Model이나 ModelAndView 대신 바로 모델 오브젝트를 리턴해도 된다. 스프링은 이를 모델에 자동으로 추가시켜 준다.
View: 뷰 이름 대신에 뷰 오브젝트를 리턴할 수도 있다.
@ResponseBody: 적절한 HttpMessageConverter를 통해 변환되어 HTTP 응답 바디로 전환된다. (HttpServletResponse의 출력 스트림)

Map 자체가 모델 오브젝트인 경우 바로 리턴해서는 안된다. 스프링이 모델 맵으로 인식하여 각 요소를 다시 개별적인 모델로 추가시키기 때문이다.

자동 추가 모델 오브젝트와 자동 생성 뷰 이름

다음 네 가지는 메소드 리턴 타입과는 상관없이, 모델에 자동으로 추가된다.

@ModelAttribute 오브젝트: 해당 애너테이션이 붙거나, 단순 타입이 아니라 커맨드 오브젝트로 처리된 오브젝트는 자동으로 모델에 추가된다.
Map, Model, ModelMap 파라미터: 컨트롤러에서 별도로 ModelAndView 오브젝트를 만들어 리턴하는 경우라도 빠짐없이 모델에 추가된다.
@ModelAttribute 메소드: 메소드 레벨에 붙일 경우, 모델 오브젝트를 생성하는 메소드를 지정하기 위해 사용한다. @RequestMapping과 같이 사용해서는 안되며, 컨트롤러의 다른 메소드가 호출될 때 자동으로 해당 메소드가 만든 오브젝트를 모델에 추가시킨다.
BindingResult

모델 바인딩과 검증

컨트롤러 메소드에 @ModelAttribute가 지정된 파라미터가 있다면 다음 세 가지 작업이 자동으로 진행된다.

파라미터 타입의 오브젝트를 준비한다. 이를 위해 디폴트 생성자가 필요하다. 만약 @SessionAttribute에 의해 세션에 저장된 모델 오브젝트가 있다면 새 오브젝트를 생성하는 대신에 이를 사용한다.
모델 오브젝트의 프로퍼티에 요청 파라미터를 바인딩한다. 스프링에 준비되어 있는 디폴트 프로퍼티 에디터를 통해 필드 타입에 맞게 자동으로 변환한다. 전환이 불가능하면 BindingResult 오브젝트에 바인딩 오류를 저장하여 컨트롤러에 넘겨주거나 BindingException 예외를 발생시킨다.
모델의 값을 검증한다. 바인딩 단계에서 타입 검증은 끝났지만 이 외에 검증할 내용이 있다면 적절한 검증기(Validator)를 등록해서 모델의 내용를 검증할 수 있다.

바인딩

스프링에서 바인딩이라고 할 때는 오브젝트의 프로퍼티에 값을 넣는 것을 의미한다. 프로퍼티 바인딩은 프로퍼티의 타입에 맞게 주어진 값을 적절히 변환하고, 실제 프로퍼티의 setter를 호출하여 값을 넣는 두 가지 작업이 필요하다.

@ModealAttribute로 지정된 모델 오브젝트의 프로퍼티 뿐만 아니라 @RequestParam이나 @PathVariable 같은 단일 파라미터에 대한 바인딩도 적용된다.

PropertyEditor

기본적으로 제공하는 타입 변환 API로, 자바빈 표준에 정의된 인터페이스이다. 바인딩 과정에서는 변환할 파라미터 또는 모델 프로퍼티의 타입에 맞는 프로퍼티 에디터가 자동으로 선정되어 사용된다.

HTTP Request에서 타입 변환시 setAsText 메소드를 통해 String 타입의 문자열을 넣고, getValue 메소드를 통해 변환된 오브젝트를 가져온다. 반대로 오브젝트를 다시 문자열로 바꿀 때는 setValue 메소드로 오브젝트를 넣고 getAsText 메소드로 변환된 문자열을 가져온다. 구현해야 될 메소드는 setAsText와 getAsText이다.

프로퍼티 에디터를 만들 때는 PropertyEditor 인터페이스를 구현하는 것보다는 PropertyEditorSupport 클래스를 상속하여 필요한 메소드만 오버라이드하는 것이 좋다.

setXXX 메소드를 통해 한 번 저장하고, getXXX 메소드를 통해 가져오는 프로퍼티 에디터 방식은 값이 한 번은 프로퍼티 에디터에 저장된다는 것이다. 이 때문에 프로퍼티 에디터는 싱글톤으로 만들어 사용해서는 안된다. 만약 스프링에 의해 DI가 필요한 경우라면 프로토타입 스코프 빈으로 사용하거나 Converter를 사용한다.

@InitBindter

@MVC에는 스프링 컨테이너에 정의된 디폴트 프로퍼티 에디터만 등록되어 있다. 핸들러 어댑터는 @RequestParam이나 @ModelAttribute와 같은 파라미터 변수에 바인딩해주는 작업이 필요한 애너테이션을 만나면 먼저 WebDataBinder를 생성한다.

WebDataBinder는 여러가지 기능을 제공하는데, HTTP 요청으로부터 가져온 문자열을 파라미터 타입의 오브젝트로 변환하는 기능을 제공한다. 이 변환 작업 진행시 등록된 프로퍼티 에디터를 사용한다. 직접 만든 커스텀 프로퍼티 에디터를 적용하려면 스프링이 제공하는 WebDataBindier 초기화 메소드를 통해 WebDataBinder에 프로퍼티 에디터를 등록해야 한다.

@InitBinder
public void initBinder(WebDataBinder binder) {
    binder.registerCustomEditor(CustomType.class, new CustomTypePropertyEditor())
}

위와 같이 컨트롤러 클래스에 @InitBinder 애너테이션을 부여한 메소드를 등록시키면 메소드 파라미터를 바인딩하기 전에 자동으로 호출되는데, WebDataBinder에 커스텀 프로퍼티 에디터를 등록시켜 커스텀 프로퍼티 에디터를 통한 바인딩 작업이 일어나게 할 수 있다.

@InitBinder에 의해 등록된 커스텀 에디터는 같은 컨트롤러 메소드에 HTTP 요청을 바인딩하는 모든 작업에 적용된다. 적용 대상은 @RequestParam, @CookieValue, @RequestHeader, @PathVariable, @ModelAttribue의 프로퍼티이다.

@ModelAttribute로 지정된 오브젝트의 필드에 바인딩 적용할 때 프로퍼티 이름을 지정하여 특정 이름을 가진 프로퍼티에만 적용하게 할 수도 있다.

WebBindingInitializer

@InitBinder 메소드를 통해 등록한 커스텀 프로퍼티 에디터는 해당 메소드가 있는 컨트롤러 클래스 안에서만 동작한다. 모든 컨트롤러에 적용하고자 할 때는 WebBindingInitializer를 사용한다

Converter

바인딩할 때마다 매번 새로운 오브젝트를 만들어야 한다는 단점을 가지는 PropertyEditor 대신에 Converter를 사용하면 싱글톤 빈으로 등록하여 타입 변환을 진행할 수 있다.

public interface Converter<S, T> {
    T convert(S source);
}

위와 같이 메소드가 한 번만 호출되어 바로 변환된 값을 받을 수 있기 때문에 싱글톤 빈으로도 등록 가능하다. 단 프로퍼티 에디터와는 다르게 단방향만 지원하므로, 양방향 변환하려면 Converter를 두 개 등록해야 한다.

모델의 일생

HTTP 요청으로부터 컨트롤러 메소드까지

@ModelAttribute 메소드 파라미터
- 컨트롤러 메소드의 모델 파라미터와 @ModelAttribute로부터 모델 이름, 모델 타입 정보를 가져온다.
@SessionAttribute 세션 저장 대상 확인
- 모델 이름과 동일한 것이 있다면 HTTP 세션에 저장해둔 것이 있는지 확인한다. 만약 있다면 모델 오브젝트를 새로 만드는 대신, 세션에 저장된 것을 사용한다.
PropertyEditor / ConversionService
- WebBindingInitializer나 @InitBinder 메소드를 통해 등록된 변환 기능 오브젝트를 통해 모델의 프로퍼티에 맞도록 요청 파라미터를 변환한다.
- 커스텀 프로퍼티 에디터 > 컨버전 서비스 > 디폴트 프로퍼티 에디터 순으로 우선순위가 정해진다.
- 타입 변환 실패시 BindingResult 오브젝트에 필드 에러가 등록된다.
Validator
- WebBindingInitializer나 @InitBinder 메소드를 통해 등록된 Validator로 모델을 검증한다. 검증 결과는 BindingResult에 등록된다.
ModenAndView의 모델 맵
- 모델 오브젝트는 컨트롤러 메소드가 호출되기 전 임시 모델 맵에 저장된다.
- 컨트롤러가 처리를 하면서 추가로 등록된 모델 오브젝트와 함께 ModelAndView에 담겨 DispatcherServlet으로 전달된다.
컨트롤러 메소드 및 BindingResult
- HTTP 요청을 담은 모델 오브젝트가 파라미터로 전달되면서 컨트롤러 메소드가 실행된다.
- BindingResult는 ModelAndView의 모델 맵에 자동 추가된다.

컨트롤러 메소드부터 뷰까지

MessageCodeResolver
- 바인딩 또는 검증 결과로 등록된 에러 코드를 확장해서 메시지 코드 후보 목록을 만든다.
MessageSource / LocaleResolver
- LocaleResolver에 의해 결정된 지역 정보와 MessageCodeResolver가 생성한 메시지 코드 후보 키 목록을 이용해 MesssageSource가 뷰에 출력할 에러 메시지를 결정한다.
@SessionAttribute 세션 저장 대상 확인
- @SessionAttribute에 지정한 이름과 동일한 모델 오브젝트가 있다면 HTTP 세션에 저장된다.
뷰
- 뷰 오브젝트로 모델 맵에 포함된 모델 오브젝트 및 에러 메시지가 전달된다.

Stats:

0 comments