HTTP Request - (1) (feat. Request Parameter)

1. Client에서 Server로 요청 데이터를 전달하는 경우 3가지

(1) GET - 쿼리 파라미터

• /url?username=hello&age=20
• 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
• ex) 검색, 필터, 페이징 등에서 많이 사용하는 방식

(2) POST - HTML Form

• content-type : application/x-www-urlencoded
• 메시지 바디에 쿼리 파라미터 형식으로 전달 username=hello&age=20
• ex) 회원 가입, 상품 주문, HTML Form 사용

(3) HTTP message body에 데이터를 직접 담아서 요청

• HTTP API에서 주로 사용, JSON, XML, TEXT
• 데이터 형식은 주로 JSON 사용
• POST, PUT, PATCH

 

2. HTTP 요청 파라미터 - 쿼리 파라미터, HTML Form

• 쿼리 파라미터와 HTML Form은 같은 형태로 요청이 들어오기 때문에 데이터 처리방식은 같다.

(1) @RequestParam

(i)

/**
* @RequestParam 사용
* - 파라미터 이름으로 바인딩
* @ResponseBody 추가
* - View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
*/
@ResponseBody
@RequestMapping("/request-param-v2")
public String requestParamV2(@RequestParam("username") String memberName, @RequestParam("age") int memberAge) {
    log.info("username={}, age={}, memberName, memberAge");
    return "ok";
}

• @RequestParam 파라미터 이름으로 바인딩
• @RequstParam("username") String memberName == String memberName = request.getParameter("username") 완전히 같다.

(ii)

/**
* @RequestParam 사용
* HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능
*/
@ResponseBody
@RequestMapping("/request-param-v3")
public String requestParamV3(@RequestParam String username, @RequestParam int age) {
    log.info("username={}, age={}, memberName, memberAge");
    return "ok";
}

• HTTP 파라미터 이름이 변수 이름과 같으면 파라미터 이름 생략 가능

(iii)

/**
* @RequestParam 사용
* String, int 등의 단순 타입이면 @RequestParam 도 생략 가능
*/
@ResponseBody
@RequestMapping("/request-param-v4")
public String requestParamV4(String username, int age) {
    log.info("username={}, age={}, memberName, memberAge");
    return "ok";
}

• String, int, Integer 등의 단순 타입이면 @RequestParam도 생략 가능

이렇게 어노테이션을 완전히 생략 가능하긴 하지만 @RequestParam이 있으면 명확하게 요청 파라미터에서 데이터를 읽는다는 것을 알 수 있기 때문에 완전한 생략은 지양한다. 

(2) @RequestParam.required, 

/**
* @RequestParam.required
* /request-param -> username이 없으므로 예외
*
* 주의!
* /request-param?username= -> 빈문자로 통과
*
* 주의!
* /request-param
* int age -> null을 int에 입력하는 것은 불가능, 따라서 Integer 변경해야 함(또는 다음에 나오는
defaultValue 사용)
*/
@ResponseBody
@RequestMapping("/request-param-required")
public String requestParamRequired(@RequestParam(required = true) String username, @RequestParam(required = false) Integer age) {
    log.info("username={}, age={}, memberName, memberAge");
    return "ok";
}

• @RequiredParam.required
  • 파라미터 필수 여부
  • 기본값이 (true)
• URL : /request-param 요청 시
  • username이 없으므로 400 예외 발생
• URL : /request-param?username=
  
  • 나이는 없으므로 자동으로 null이 들어간다.
  • int 자료형은 null이 들어갈 수 없으므로 Integer로 바꿔준다.

(3) @RequestPAram.defaultValue

/**
* @RequestParam
* - defaultValue 사용
*
* 참고: defaultValue는 빈 문자의 경우에도 적용
* /request-param?username=
*/
@ResponseBody
@RequestMapping("/request-param-default")
public String requestParamDefault(@RequestParam(required = true, defaultValue = "guest") String username, 
@RequestParam(required = false, defaultValue = "-1") int age) {
    log.info("username={}, age={}, memberName, memberAge");
    return "ok";
}

• 파라미터에 값이 없는 경우 defaultValue를 사용하면 기본 값을 적용할 수 있다.
• 이미 기본값이 있기 때문에 required는 의미가 없다.

(4) @RequestParam Map (파라미터 Map으로 조회하기)

/**
* @RequestParam Map, MultiValueMap
* Map(key=value)
* MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])
*/
@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";
}

• Map, MultiValueMap으로 조회할 수 있다.
• @RequestParam Map
  • Map(key=value)
• @RequestParam MultiValueMap
  • MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])

(5) @ModelAttribute

• 요청 파라미터를 받아서 필요한 객체를 만들고 그 객체에 값을 넣어주어야 한다.
• 스프링은 이 과정을 자동화해주는 @ModelAttribute 기능을 제공한다.

import lombok.Data;

@Data
public class HelloData {
    private String username;
    private int age;
}

/**
* @ModelAttribute 사용
* 참고: model.addAttribute(helloData) 코드도 함께 자동 적용됨, 뒤에 model을 설명할 때
자세히 설명
*/
@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
    log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
    return "ok";
}

• SpringMVC는 @ModelAttribute가 있으면 다음을 실행
  • HelloData 객체를 생성
  • 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩) 한다.
    • 파라미터 이름이 username이면 setUsername() 메서드를 찾아서 호출하면서 값을 입력
• @ModelAttribute 또한  생략 가능하다. 
  • Spring은 다음과 같은 기준으로 판단한다. 
    • String, int, Integer 같은 단순 타입 = @RequestParam 생략
    • argument resolver로 지정해둔 타입 외 = @ModelAttribute 생략