[Spring] HTTP 요청에서 값 받아오기 - @RequestParam

이 글은 공부를 하면서 알게 된 내용들을 기록하는 글 입니다. 오류나 고쳐야 할 사항들이 있다면 지적 부탁드립니다!

 

⛅️ @RequestParam을 사용하는 때

✅ request parameter(요청 파라미터) 조회

• @RequestParam은 GET 요청 파라미터 전송 방식, HTML Form 전송 방식을 사용할 때에 조회할 수 있는 방법 중 하나이다.
• 이를 request parameter 조회라고 한다.

 

✅ GET vs POST

• GET 방식과 POST 방식 모두 웹 브라우저가 서버에 요청하는 방법 중 하나이다.
• GET 방식은 요청 시 데이터를 message body에 담지 않고, query string(쿼리 스트링)에 담아서 전달하는 방법이다.

 

---

⛅️ @RequestParam 사용 방법

✅ @RequestParam 선언 방법

@RequestParam("파라미터 이름") 자료형 변수명

• 만일 파라미터 이름과 변수명이 같은 경우에는, ("파라미터 이름")을 생략할 수 있다.
  ex) @RequestParam String username
• url에 담긴 query string(쿼리 스트링)에 담긴 값을 변수에 담을 수 있다.

@ResponseBody
@RequestMapping("/request-param")
public String requestParam(@RequestParam String username, @RequestParam int age) {
	log.info("username={}, age={}", username, age);
	return "ok";
}

만일 url이 localhost:8080/request-param?username=userA&age=20 이라면

@RequestParam을 통해 변수 username에는 userA가, 변수 age에는 20이 들어갈 것이다.

 

@RequestParam은 Servlet의 response.getParam()과 동일한 역할을 한다.

response.getParam()의 return형은 String이어서 Integer.ParseInt()함수를 통해 형 변환을 해주어야 했다.

반면 @RequestParam은 형변환을 알아서 한 후, 변수에 넣어주기 때문에 개발자가 형 변환을 하지 않아도 된다.

 

 

✅ 파라미터들을 Map으로 조회하기

@RequestParam Map<Key, Value> 변수명
@RequestParam MultiValueMap<Key, Value> 변수명

• 파라미터 값들을 변수를 따로 설정하여 받지 않고 Map, MultiValueMap을 통해서도 값을 받을 수 있다.
• Map은 Key 당 하나의 Value값이 오는 형태의 자료구조이고,
  MultiValueMap은 이름에서 알 수 있듯이 Key 당 여러 개의 Value값이 올 수 있는 형태의 자료구조이다.
• Key에는 String이, Value에는 Object에 들어간다.
• 원하는 파라미터의 값을 찾고 싶을 때에는 변수명.get("파라미터 값")을 통해 접근할 수 있다.

// Map을 통한 Parameter 값 얻기
@ResponseBody
@RequestMapping("/request-param-map")
public String requestParamMap(@RequestParam Map<String, Object> paramMap) {
	log.info("username={}, age={}", paramMap.get("username"), paramMap.get("age"));
	return "ok";
}

// 값이 여러 개인 경우 MultiValueMap을 통해 Parameter 값 얻기
@ResponseBody
@RequestMapping("/request-param-map")
public String requestParamMap(@RequestParam MultiValueMap<String, Object> paramMap) {
	log.info("username={}, age={}", paramMap.get("username"), paramMap.get("age"));
	return "ok";
}

 

---

⛅️ @RequestParam의 다양한 옵션들

✅ required = false

@RequestParam(required=false) Integer age

• required는 파라미터의 값이 필수인지의 여부를 나타내는 옵션이다.
• 기본 값은 required=true이다. 따라서 파라미터 값이 전달되지 않는다면 Exception이 발생한다.
  required=false인 경우 파라미터의 값이 전달되지 않는다면 null 값이 들어간다.
• Tip! 
  required의 값이 false일 때 값이 전달되지 않는다면 null 값이 들어간다.
  자료형 int는 null 값을 담을 수 없기 때문에, int 대신 Integer를 사용하자.

@ResponseBody
@RequestMapping("/request-required")
public String requestParamRequired(@RequestParam(required=false) Integer id) {
	// 파라미터 값이 있다면 해당 값을, 없다면 null을 출력
	log.info("id = {}", id);
	return "ok";
}

 

✅ defaultValue = " "

@RequestParam(defaultValue="guest") String username

• 파라미터에 값이 없는 경우 설정한 기본값을 적용하는 옵션이다.
• 이 옵션을 사용하면 required 옵션은 의미가 없다. (값이 없는 경우 defaultValue에 설정한 값이 들어갈 것이므로)

@ResponseBody
@RequestMapping("/request-defaultValue")
public String requestParamDefault(@RequestParam(defaultValue="guest") String username) {
	// 파라미터 값이 있다면 해당 값을, 없다면 guest를 출력
	log.info("username = {}", username);
	return "ok";
}