[Spring MVC] 03. @RequestMapping, HTTP 요청 메세지와 HTTP 응답 메세지

@RequestMapping

@Controller // 내부에 @Component 애노테이션이 있어서 컴포넌트 스캔의 대상이 된다
public class SpringMemberFormControllerV1 {
    @RequestMapping("/springmvc/v1/members/new-form") // 요청정보를 매핑한다
    public ModelAndView process() { // 모델과 뷰의 정보를 담아서 반환한다
        return new ModelAndView("new-form");
    }
}

RequestMappingHandlerMapping은 스프링 빈 중에서 @RequestMapping 또는 @Controller 가 클래스 레벨에 붙어 있는 경우에 매핑 정보로 인식한다.

 

클래스 레벨에 다음과 같이 @RequestMapping 을 두면 메서드 레벨과 조합이 된다.

@Controller
@RequestMapping("/springmvc/v2/members")
public class SpringMemberControllerV2 {}

클래스 레벨 @RequestMapping("/springmvc/v2/members")
메서드 레벨 @RequestMapping("/new-form") ➡️ /springmvc/v2/members/new-form

 

@RequestMapping 속성

✔️  HTTP 메서드 매핑

@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)

@GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping으로 변경 가능

✔️ PathVariable 사용

@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data) { // 변수명이 같으면 @PathVariable 생략 가능
}

// 다중 사용 가능
@GetMapping("/mapping/users/{userId}/orders/{orderId}")
public String mappingPath(@PathVariable String userId, @PathVariable Long orderId) {
}

✔️  특정 헤더 조건 매핑

@GetMapping(value = "/mapping-header", headers = "mode=debug")

✔️  미디어 타입 조건 매핑 - Content-Type, consume

@PostMapping(value = "/mapping-consume", consumes = "application/json")

✔️  미디어 타입 조건 매핑 - Accept, produces

@PostMapping(value = "/mapping-produce", produces = "text/html")

---

 

 

HTTP 요청 메세지

@RequestParam

쿼리 파라미터 형식이나 POST(HTML Form)형식으로 데이터를 전달 받았을 때 파라미터 이름으로 input parameter에 바인딩해주는 어노테이션

@RequestParam("username") String memberName ➡️ request.getParameter("username")

• HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능
• String , int , Integer 등의 단순 타입이면 @RequestParam 도 생략 가능
  • @RequestParam 애노테이션을 생략하면 스프링 MVC는 내부에서 required=false 를 적용한다. 기본값은 true이다.
  • 이렇게 애노테이션을 완전히 생략해도 되는데, 너무 없는 것도 약간 과하다는 이야기도 있다.

 

✔️ @RequestParam.required

• 기본값은 true
• /request-param?username=처럼 파라미터 이름은 있고 값은 없는경우 빈문자로 취급해서 required가 true여도 통과된다
• 기본형(primitive)에 null을 입력하는 경우 required가 false여도 null을 기본형에 입력하는건 불가능하기 때문에 예외 발생

✔️ @RequestParam.defaultValue

파라미터에 값이 없는 경우 defaultValue 를 사용하면 기본 값을 적용할 수 있다. 이미 기본 값이 있기 때문에 required 는 의미가 없다. defaultValue 는 빈 문자의 경우에도 설정한 기본 값이 적용된다.

✔️ @RequestParam Map<String, Object> paramMap

파라미터를 Map, MultiValueMap으로 조회할 수 있다.

 

 

@ModelAttribute

@ModelAttribute HelloData helloData

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

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

 

@ModelAttribute 는 생략할 수 있다. 그런데 @RequestParam 도 생략할 수 있으니 혼란이 발생할 수 있다. 그래서 스프링은 생략시 다음과 같은 규칙을 적용한다.

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

 

추가 기능

• Model에 @ModelAttribute로 지정한 객체를 자동으로 넣어준다. 
• 만약 @ModelAttribute의 이름을 생략하면 모델에 저장될 때 클래스명을 사용해 저장한다(클래스의 첫글자만 소문자로 변경)

/*
	@ModelAttribute("item") Item item
	model.addAtribute("item", item);  자동추가
*/

/*
	@ModelAttribute HelloData hd
	model.addAtribute("helloData", hd);  자동추가
*/

 

@RequestBody

요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 데이터가 넘어오는 경우는 @RequestParam , @ModelAttribute 를 사용할 수 없다

@PostMapping("/request-body-json-v1")
public void requestBodyJsonV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
    // 1. ServletInputStream을 이용해서 직접 읽는 방법
    ServletInputStream inputStream = request.getInputStream();
    String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

    // 문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다.
    HelloData data = objectMapper.readValue(messageBody, HelloData.class);
}

@PostMapping("/request-body-string-v3")
// HttpEntity: HTTP header, body 정보를 편리하게 조회할 수 있는 객체
// 3. HttpEntity<String>를 이용해서 조회하는 방법
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) {
    String messageBody = httpEntity.getBody();
    return new HttpEntity<>("ok");
}

@ResponseBody // 메시지 바디 정보 직접 반환
@PostMapping("/request-body-json-v2")
// 4. @RequestBody`를 이용해서 바디 정보를 조회하는 방법
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
    HelloData data = objectMapper.readValue(messageBody, HelloData.class);
    return "ok";
}

1. ServletInputStream
2. InputStream(input parameter로 바로 받음)
3. HttpEntity<String>
4. @RequestBody

참고
@RequestBody는 생략 불가능하다.
스프링은 @ModelAttribute , @RequestParam 생략시 다음과 같은 규칙을 적용한다

String , int , Integer 같은 단순 타입 = @RequestParam
나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)
따라서 이 경우 HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버린다.

HelloData data ➡️ @ModelAttribute HelloData data
따라서 생략하면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.

---

 

 

HTTP 응답 메세지

정적 리소스

해당 파일을 변경 없이 그대로 서비스하는 것을 말한다.

스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
/static , /public , /resources , /META-INF/resources

다음 경로에 파일이 들어있으면 src/main/resources/static/basic/hello-form.html
웹 브라우저에서 다음과 같이 실행하면 된다. http://localhost:8080/basic/hello-form.html

뷰 템플릿

뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다.

뷰 템플릿 경로 : src/main/resources/templates

// 직접 modelAndView를 반환하는 경우 
@RequestMapping("/response-view-v1")
public ModelAndView responseViewV1() {
    ModelAndView mav = new ModelAndView("response/hello").addObject("data", "hello!");
    return mav;
}

// @ResponseBody 가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다
// 여기서는 뷰의 논리 이름인 response/hello 를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있다.
// 실행: templates/response/hello.html
@RequestMapping("/response-view-v2")
public String responseViewV2(Model model) {
    model.addAttribute("data", "hello!!");
    return "response/hello";
}

메시지 바디에 직접 응답

@ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다.

@RestController

@Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용되는 효과가 있다
@Controller 는 반환 값이 String 이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 랜더링 된다. @RestController 는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.

 

👍 Reference

https://inf.run/AZq1