📗Spring MVC Study [ HTTP 요청 ]

기본, 헤더 조회

• 애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.

@Slf4j
@RestController
public class RestHeaderController {

    @RequestMapping("/headers")
    public String headers(HttpServletRequest request, HttpServletResponse response,
                          HttpMethod httpMethod,
                          Locale locale,
                          @RequestHeader MultiValueMap<String, String> headerMap,
                          @RequestHeader("host") String host,
                          @CookieValue(value = "myCookie", required = false) String cookie) {

        log.info("request={}", request);
        log.info("response={}", response);
        log.info("httpMethod={}", httpMethod);
        log.info("locale={}", locale);
        log.info("headerMap={}", headerMap);
        log.info("header host={}", host);
        log.info("myCookie={}", cookie);
        return "ok";

    }
}

• HttpServletRequest
• HttpServletResponse
• HttpMethod : HTTP 메서드를 조회한다. org.springframework.http.HttpMethod
• Locale : Locale 정보를 조회한다.
• @RequestHeader MultiValueMap<String, String> headerMap
  • 모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.
• @RequestHeader("host") String host
  • 특정 HTTP 헤더를 조회한다.
  • 속성
    • 필수 값 여부 : required
    • 기본 값 속성 : defaultValue
• @CookieValue(value = "myCookie", required = false) String cookie
  • 특정 쿠키를 조회한다.
  • 속성
    • 필수 값 여부 : required
    • 기본 값 : defaultValue

MultiValueMap

• Map과 유사한데, 하나의 키에 여러 값을 받을 수 있다.
• HTTP header, HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용한다.
  • keyA=value1&keyA=value2 > key A에 2개의 value가 담김

 MultiValueMap<String, String> map = new LinkedMultiValueMap();
 map.add("keyA", "value1");
 map.add("keyA", "value2");
 //[value1,value2]
 List<String> values = map.get("keyA");

@Slf4j

• 이전 포스트에서 자세히 작성했었지만 쉽게 이야기하면 개발자가 편리하기 log를 사용하게 해주는 것을 도와준다.
• 아래 코드를 자동으로 생성하여 로그를 선언해준다.

private static final org.slf4j.Logger log = 
org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class);

참고

• @Controller의 사용 가능한 파라미터 목록은 아래의 공식 메뉴얼 확인
• https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-methods/arguments.html

---

쿼리 파라미터, HTML Form

HTTP 요청 데이터 조회 - 개요

• 클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 다음 3가지 방법을 사용
  • /url?username=hello&age=20
  • 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
  • EX) 검색, 필터, 페이징등에서 많이 사용하는 방식
• POST - HTML Form
  • content-type : application/x-www-form-urlencoded
  • 메시지 바디에 쿼리 파라미터 형식으로 전달 username=hello&age=20
  • 예) 회원 가입, 상품 주문, HTML Form 사용
• HTTP message body에 데이터를 직접 담아서 요청
  • HTTP API에서 주로 사용, JSON, XML, TEXT
  • 데이터 형식은 주로 JSON 사용
  • POST, PUT, PATCH

HttpServletRequest의 request.getParameter()를 사용하면 다음 두가지 요청 파라미터를 조회할 수 있다.


GET, 쿼리 파라미터 전송

• http://localhost:8080/request-param?username=hello&age=20

POST, HTML Form 전송

• POST /request-param ...
   content-type: application/x-www-form-urlencoded
   username=hello&age=20 

GET 쿼리 파라미터 전송 방식이든, POST HTML Form 전송 방식이든 둘다 형식이 같으므로 구분없이 조회할 수 있다.

• 이것을 간단하게 요청 파라미터 (request parameter) 조회라고 한다.

---

이제부터 스프링으로 요청 파라미터를 조회해 보자.

/**
 * 반환 타입이 없으면서 이렇게 응답에 값을 직접 넣으면, view 조회 X
 */
@RequestMapping("/request-param-v1")
public void requestParamV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
	String username = request.getParameter("username");
    int age = Integer.parseInt(request.getParameter("age"));

    log.info("username:{}, age:{}", username, age);

    response.getWriter().write("ok");
}

• request.getParameter()
  • 여기서는 단순히 HttpServletRequest가 제공하는 방식으로 요청 파라미터를 조회

---

/**
 * @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 : 파라미터 이름으로 바인딩
• @ResponseBody : View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력

RequestParam의 name(value) 속성이 파라미터 이름으로 사용

• @RequestParam("username") String memberName
• -> request.getParameter("username")

---

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

• HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx")생략 가능

---

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

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

주의

• @RequestParam 애노테이션을 생략하면 스프링 MVC는 내부에서 required=false를 적용한다.

---

참고

• 애노테이션을 완전히 생략해도 상관은 없지만, 너무 없는 것도 약간 과하다는 이야기를 들었다.
• @RequestParam이 있으면 명확하게 요청 파라미터에서 데이터를 읽는 다는 것을 파악할 수 있다.
• 스프링에 익숙하지 않은 사람일 경우 보자마자 이해를 하지못할 수도 있으니 주의해서 사용하자.

---

파라미터 필수 여부 - requestParamRequired

 /**
  * @RequestParam.required /request-param-required -> username이 없으므로 예외
  * <p>
  * 주의!
  * /request-param-required?username= -> 빈문자로 통과
  * <p>
  * 주의!
  * /request-param-required
  * 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={}", username, age);
    return "ok";
}

• @RequestParam.required
  • 파라미터 필수 여부
  • 기본 값이 파라미터 필수(true)이다.
• /request-param-required 요청
  • username이 없으므로 400예외 발생

주의! 파라미터 이름만 사용

• /request-param-required?username=
• 파라미터 이름만 있고 값이 없는 경우 -> 빈 문자로 통과

주의! - 기본형(primitive)에 null 입력

• /request-param요청
• @RequestParam(required = false) int age
• null을 int에 이볅하는 것은 불가능 (500 예외 발생) 따라서 null을 받을 수 있는 Integer로 변경하거나, 또는 defaultValue를 사용하자.

/**
 * @RequestParam
 * - defaultValue 사용
 *
 * 참고: defaultValue는 빈 문자의 경우에도 적용
 * /request-param-default?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={}", username, age);
 		return "ok";
 }

파라미터에 값이 없는 경우 defaultValue를 사용하면 기본 값을 적용할 수 있다. 이미 기본 값이 있기 때문에 required는 의미가 없다. defaultValue는 빈 문자의 경우에도 설정한 기본 값이 적용된다. /request-param-default?username 이런식으로 보내면 default값이 적용되어 request를 보내게 된다.

파라미터를 Map으로 조회하기 - requestParamMap

 /**
 * @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])

파라미터의 값이 1개가 확실하다면 Map을 사용해도 되지만, 그렇지 않다면 MultiValueMap을 사용하자. 하지만 거의 1개일 경우가 많기 때문에 Map을 주로 사용한다.

---

HTTP 요청 파라미터 - @ModelAttribute

• 실제 개발을 하게 될 경우 요청 파라미터를 받아서 필요한 객체를 만들고 객체에 값을 넣어주어야 한다.
• 스프링은 이 과정을 완전히 자동화 해주는 @ModelAttribute 기능을 제공한다.

실습에 앞서 요청 파라미터를 바인딩 받을 객체 생성

//HelloData
import lombok.Data;
@Data
public class HelloData {
	private String username;
	private int age;
 }

• 롬복 @Data
  • @Getter, @Setter,@ToString, @EqualsAndHashCode, @RequiredArgsConstructor 를 자동으로 적용해준다.

@ModelAttribute 적용 - modelAttributeV1

/**
 * @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";
}

• 실행해보면 자동으로 HelloData 객체가 생성되고, 요청 파라미터의 값도 모두 들어가 있는것을 확인할 수 있다.

• 스프링 MVC는 @ModelAttribute가 있으면 다음을 실행한다.

  • HelloData객체를 생성한다.
  • 요청 파라미터의 이름으로 HelloData객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩)한다.
  • EX) 파라미터의 이름이 username이면 setUsername() 메서드를 찾아서 호출하면서 값을 입력

프로퍼티

• 객체에 getUsername(), setUsername() 메서드가 있으면, 이 객체는username 이라는 프로퍼티를 가지고 있음.
• username 프로퍼티 값을 변경하면 setUsername()이 호출되고, 조회하면 getUsername()이 호출된다.

class HelloData{
	getUsername();
    setUsername();
}

바인딩 오류

• age=abc 처럼 숫자가 들어가야 할 곳에 문자를 넣으면 BindException발생

@ModelAttribute 생략 - modelAttributeV2

/**
 * @ModelAttribute 생략 가능
 * String, int 같은 단순 타입 = @RequestParam
 * argument resolver 로 지정해둔 타입 외 = @ModelAttribute
 */
@ResponseBody
@RequestMapping("/model-attribute-v2")
public String modelAttributeV2(HelloData helloData) {
	log.info("username={}, age={}", helloData.getUsername(), 
	helloData.getAge());
	return "ok";
}

• @ModelAttribute는 생략할 수 있다.
• 그런데 @RequestParam도 생략할 수 있으니 혼란이 발생할 수 있다.

스프링은 해당 생략시 다음과 같은 규칙을 적용

• String, int, Integer 같은 단순 타입 = @RequestParam
• 나머지 = @ModelAttribute (argument resolver로 지정해둔 타입 외)

📭 Reference

• 인프런 김영한 강사님의 스프링 MVC
• 링크 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1