이 포스팅은 토비의 스프링 3.1을 읽고 일부분을 요약정리한 글입니다.
스프링 컨트롤러에서 받아서 사용할 수 있는 파라미터를 알아보자.
HttpServletRequest, HttpServletResponse
- ServletRequest, ServletResponse 타입도 가능하다.
HttpSession
- HttpServletRequest를 통해 가져올 수도 있다.
- 세션만 필요한 경우라면 직접 받는것이 낫다.
@PathVariable
- URL에 들어가는 패스변수를 받는다.
@RequestMapping("/user/view/{id}")
public String view(@PathVariable("id") int id) { ... }- 여러개의 패스 변수를 받을 수도 있다.
@RequestMapping("/member/{memberCode}/order/{orderId}")
public String lookup(@PathVariable("memberCode") String code,
@PathVariable("orderId") int orderId) { ... }- 파라미터 타입은 URL의 내용이 적절히 변환될 수 있는 것을 사용해야 한다.
- 타입이 일치하지 않으면 예외가 발생하며 클라이언트에 400 코드가 전달될 것이다.
@RequestParam
- 단일 HTTP요청 파라미터를 메소드 파라미터에 넣어주는 애노테이션
- 요청 파라미터의 값은 메소드 파라미터의 타입에 따라 적절하게 변환된다.
public void view(@RequestParam("id") int id) { ... }- 하나 이상의 파라미터에 적용할 수 있다. 스프링의 내장 변환기가 다룰 수 있는 모든 타입을 지원한다.
public void view(@RequestParam("id") int id,
@RequestParam("name") String name,
@RequestParam("file") MultipartFile file) { ... }- 파라미터 이름을 지정하지 않고
Map<String, String>타입으로 선언하면 모든 요청 파라미터를 담은 맵으로 받을 수 있다. 파라미터의 이름은 맵의 키에, 파라미터 값은 맵의 값에 담겨 전달된다.
public void add(@RequestParam Map<String, String> params) { ... }@RequestParam을 사용했다면 해당 파라미터가 반드시 있어야만 한다. 없다면400 - Bad Request를 받게 될 것이다. 파라미터를 선택적으로 제공하게 하려면required엘리먼트를false로 설정해주면 된다. 요청 파라미터가 존재하지 않을 때 사용할 디폴트 값도 지정할 수 있다.
public void view(@RequestParam(value="id", required=false, defaultValue-"-1" int id) { ... }- 메소드 파라미터의 이름과 요청 파라미터의 이름이 일치한다면
value를 생략할 수 있다.
public void view(@RequestParam int id) { ... }- String, int와 같은 단순 타입인 경우는
@RequestParam을 아예 생략할 수도 있다. 하지만 파라미터의 개수가 많고 종류가 다양하면 코드를 이해하는 데 불편할 수도 있다. 단순한 메소드가 아니라면 명시적으로@RequestParam을 부여해주는 것을 권장한다.
CookieValue
- HTTP 요청과 함께 전달된 쿠키 값을 받을 수 있다.
- 애노테이션의 기본 값에 쿠키의 이름을 지정해주면 된다.
public String check(@CookieValue("auth") String auth) { ... }- 메소드 파라미터 이름과 쿠키 값이 동일하다면 쿠키 이름은 생략할 수 있다.
- 지정된 쿠키 값이 존재하지 않으면 예외가 발생한다.
- 쿠키 값이 없을 때 예외가 발생하지 않게 하려면
required엘리먼트를false로 선언해줘야 한다. 또한defaultValue로 디폴트 값을 선언할 수도 있다.
@RequestHeader
- 요청 헤더정보를 메소드 파라미터에 넣어주는 애노테이션이다.
- 헤더값이 반드시 존재해야하므로, 설정이 필요하면
required와defaultValue를 이용할 수 있다.
public void header(@RequestHeader("Host") String host,
@RequestHeader("Keep-Alive") long keepAlive) { ... }Map, Model, ModelMap
Model과ModelMap은 모두addAttribute()메소드를 제공해준다.- 일반적인 맵의
put()처럼 이름을 지정해서 오브젝트 값을 넣을 수 있다. model.addAttribute(user)는model.addAttribute("user", user)와 동일하다.ModelMap과Model의addAllAttribute()메소드를 사용하면 Collection에 담긴 모든 오브젝트를 자동 이름 생성 방식을 적용해서 모두 모델로 추가해준다.
@ModelAttribute
- 메소드 파라미터에도 부여할 수 있고, 메소드 레벨에 적용할 수도 있다.
- 모델 맵에 담겨서 뷰에 전달되는 모델 오브젝트의 한가지
- 하나 이상의 값을 가진 오브젝트 형태로 만들 수 있는 구조적인 정보를 담는다.
- 요청 파라미터나 폼데이터를 도메인 오브젝트나 DTO의 프로퍼티에 요청 파라미터를 바인딩해서 한번에 받을 수 있다.
@RequestMapping("/user/search")
public String serarch(@RequestParam int id,
@RequestParam String name,
@RequestParam int level,
@RequestParam String email) { ... }- 위와 같은 컨트롤러를 클래스를 이용하여 아래와 같이 바꿀 수 있다.
public class UserSearch {
int id;
String name;
int level;
String email;
// 수정자, 접근자 생략
}
@RequestMapping("/user/search")
public String serarch(@ModelAttribute UserSearch userSearch) { ... }- 생략 가능하며, 스프링은
@ModelAttribute와@RequestParam이 생략된 파라미터를 보고String, int와 같은 단순타입이면@RequestParam으로 간주하고, 그 외의 복잡한 오브젝트는 모두@ModelAttribute로 간주한다. - 무분별 생략은 위험할 수 있으므로 명시하는것을 권장한다.
- 또한 컨트롤러가 리턴하는 모델에 파라미터로 전달한 오브젝트를 자동으로 추가해준다. 즉,
@ModelAttribute애노테이션을 사용하면 뷰에서 필요하다고 해서 코드에서 추가해줄 필요가 없다.
Errors, BindingResult
- 바로 앞의 파라미터 오브젝트를 바인딩하다가 발생한 변환 오류와 모델 검증기를 통해 검증하는 중에 발견한 오류가 저장된다.
@RequestMapping(value="add", method=RequestMethod.Post)
public String add(@ModelAttribute User user, BindingResult bindingResult) { ... }BindingResult대신Errors타입으로 선언할 수 있다.- 반드시
@ModelAttribute파라미터 뒤에 나와야 한다. 자신의 바로 앞에 있는@ModelAttribute파라미터의 검증 작업에서 발생한 오류만을 전달해주기 때문이다.
@RequestBody
- HTTP 요청의 본문 부분이 그대로 전달된다.
- 보통
@ResponseBody와 함께 사용된다.
@Value
- 빈의 값 주입에서 사용하던
@Value애노테이션도 컨트롤러 메소드 파라미터에 부여할 수 있다.
@Valid
- 빈 검증기를 이용해 모델 오브젝트를 검증하도록 지시하는 지시자.
- 보통
@ModelAttribute와 함께 사용된다.
going up