🙆‍♂️ import 🙇‍♂️

파라메터(parameter) 어노테이션 및 객체 정보 및 설명[하늘을향해]

[Spring] @RequestBody, @ModelAttribute, @RequestParam의 차이[MangKyu's Diary]

쿼리 파라미터(@RequestParam)값 얻기[devkuma]

Spring에서 Controller에 원하는 Parameter나 Data를 Binding 시키는 방법은 여러 종류가 있다.

평소 개발할때 사용하던 코드에서 아무 생각없이 Binding을 하다보니 아래 해당 Binding 방법들에 대한 이해도가 부족하여 @RequestParam, @RequestBody, @ModelAttribute, MultiValueMap에 대해 한번 알아보려한다.

@RequestParam

@ReqeustParam은 해당 Request에 대한 Parameter들을 자동으로 Binding한다.

1개의 HTTP Request Parameter를 받기 위해서 주로 사용하며 @RequestParam은 필수 여부가 true이기 때문에 기본적으로 반드시 해당 Parameter가 전송되어야 한다.
해당 Parameter가 전송되지 않으면 400 Error 발생

그래서 required의 값을 false로 설정해 필수 여부를 조절할 수 있고, 해당 Parameter를 사용하지 않고 요청을 보낼 경우에 default로 받을 값을 defaultValue 옵션을 통해 설정할 수도 있다.

주의사항으로는 단일 값만 Binding가능하여 만약 List형태로 복수의 Paramter를 Request하면 첫번째 Data 값만 Binding된다.

아래와 같은 형태로 많이 사용된다.

@ReqeustParam HashMap<String,Object> params

//{id=gil, name=gillog}

MultiValueMap

MultiValueMap은 Spring에서 제공하는 Data Collection으로 List형태의 값들을 Value로 Binding할 수 있는 특징을 지닌다.

하나의 Parameter에 여러 Data를 전송받아야 할 때 주로 사용한다.

@ReqeustParam MultiValueMap<String, String> multiParams


//{id=[gil], name=[gillog, loadbear]}

@RequestBody

@RequestBody는 Client가 전송하는 Json(application/json) 형태의 HTTP Body 내용을 Java Object로 Binding시켜주는 역할을 한다.
HTTP Body가 존재하지 않는 Get method에 @RequestBody를 사용시 에러가 발생하게 된다.

@RequestBody로 받는 Data는 Spring에서 관리하는 MessageConverter들 중 하나인 MappingJackson2HttpMessageConverte를 통해 Java Object로 Binding된다.

@RequestBody는 Setter함수가 없어도 요청받은 데이터를 Binding할 수 있다.

@ModelAttribute

@ModelAttribute 는 Client가 전송하는 multipart/form-data 형태의 HTTP Body 내용과 Parameter들을 Setter를 통해 1:1로 Java Object에 Binding하기 위해 사용된다.

@ModelAttribute에는 Mapping 시키는 Parameter의 타입이 Object의 타입과 일치하는지를 포함한 다양한 검증(Validiation) 작업이 추가적으로 진행된다.
int형 index 변수에 "1번" 이라는 String형을 Binding시키려 하면, BindException이 발생하게 된다.

VS @RequestBody

@RequestBody는 Json이나 XML과 같은 형태의 데이터를 MessageConverter를 통해 Binding하고,
@ModelAttribute는 multipart/form-data 형태의 HTTP Body와 HTTP Parameter들을 Mapping시킨다.

@ModelAttribute는 Setter함수가 없다면 Binding이 되지 않는다.

특정 Paramter Binding

아래 예제 코드 처럼 특정 Parameter만 Binding 할 수도 있다.

@ModelAttribute('writer') String writer

//{ writer: 'gillog', contents : 'ModelAttributeStudy' }

JSP Forward

@ModelAttribute는 @RequestParam Annotattion과 달리 JSP로 Forward했을 때 Request로 받은 값을 별다른 Mapping 과정 없이 그대로 전달할 수 있다.

만약 아래 코드처럼 @RequestParam Annotation을 사용한다면,

@GetMapping(value = "/requestMapping")
public String requestParamMapping(@RequestParam HashMap<String, Object> params, Model model) {
	model.addAttribute("requestMapping", params);
	return "views/jsp/gillog";
}

Model을 이용, JSP로 Forward할 때 Binding 과정이 추가 된다.

하지만 @ModelAttribute Annotation을 사용하면 Binding 과정 없이 바로 JSP로 Parameter로 받은 Data를 Forward할 수 있다.

@GetMapping(value = "/requestMapping")
public String requestParamMapping(@ModelAttribute HashMap<String, Object> params) {
	return "views/jsp/gillog";
}

@SessionAttribute

@SessionAttributes는 Controller Class에 지정되는 Annotation으로 @ModelAttribute Annotation과 동일한 특징에, 해당 값을 Session에도 저장해 준다.

이때 @SessionAttributes Annotation에 정의한 Key와, 동일한 Key로 Model에 값을 Binding 되는 경우에 해당하고,
해당 Class, Controller 내에서만 @SessionAttributes Annotation으로 지정한 Session 값을 사용할 수 있다.

같은 Controller 안에서 다루는 특정 Model Data를 Session에 넣고 공유하는 용도로 사용된다.

@Controller
@SessionAttributes("gillog")
public class GillogController {
	@GetMapping(value = "/requestMapping")
	public String requestParamMapping(@RequestParam HashMap<String, Object> params, Model model) {
		model.addAttribute("requestMapping", params);
		return "views/jsp/gillog";
	}

	@GetMapping(value = "/requestMapping")
	public String requestParamMapping(@ModelAttribute HashMap<String, Object> params) {
		return "views/jsp/gillog";
	}
}