Spring 요청 데이터 4

JSON

Json은 @RestController 에서 가장 많이 사용되는 데이터 형식이다. 현재 대부분의 API는 Request, Response 모두 JSON 형태로 통신한다.

Json 형태로 Data를 전송할 때는 Request Header의 content-type이 꼭 application/json 이여야 한다,

1. HttpServletRequest 사용

@Data
public class Tutor {
	private String name;
	private int age;
}

@RestController
public class JsonController {
	
	private ObjectMapper objectMapper = new ObjectMapper();

	@PostMapping("/v1/request-body-json")
	public void requestBodyJsonV1(
				HttpServletRequest request, 
				HttpServletResponse response
	) throws IOException {

		// request body message를 Read
		ServletInputStream inputStream = request.getInputStream();
		// UTF-8 형식의 String으로 변환한다.
		String requestBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

		// String requestBody를 ObjectMapper를 사용하여 변환 "{\"name\":\"wonuk\", \"age\":10}"
		Tutor tutor = objectMapper.readValue(requestBody, Tutor.class);
		
		// 응답
		response.getWriter().write("tutor" + tutor);
	}
}

• Postman
  Content-Type 헤더 확인 : application/json
  

• HttpServletRequest를 사용하여 HTTP Message Body 데이터를 Read하여 문자로 변환한다.
• 문자로 만들어진 JSON을 Jackson 라이브러리의 objectMapper를 사용하여 Object로 변환
  

2. @RequestBody 사용

@RestController
public class JsonController {
	
	private ObjectMapper objectMapper = new ObjectMapper();

	@PostMapping("/v2/request-body-json")
  public String requesBodytJsonV2(@RequestBody String requestBody) throws IOException {

      Tutor tutor = objectMapper.readValue(requestBody, Tutor.class);

      return "tutor.getName() = " + tutor.getName() + "tutor.getAge() = " + tutor.getAge();
  }
    
}

• Postman
  
• @RequestBody를 사용하여 HTTP Request Body의 Data에 접근한다.

3. ObjectMapper 제거

@RestController
public class JsonController {
	
	@PostMapping("/v3/request-body-json")
	public String requestBodyJsonV3(@RequestBody Tutor tutor) {
		
		Tutor requestBodyTutor = tutor;

		return "tutor = " + requestBodyTutor;
	}
}

-Postman

- 위 Controller가 동작하는 이유

• @RequestBody
  - @RequestBody 어노테이션을 사용하면 Object를 Mapping할 수 있다.
  - HttpEntity<>, @RequestBody를 사용하면 HTTPMessageConverter가 Request Body의 Data를 개발자가 원하는 String이나 Object로 변환해준다.
  - JSON to Object의 Mapping 또한 가능하다.
  - MappingJackson2HttpMessageConverter 의 역할
  
  쉽게 설명하면 HTTP Message Converter가 ObjectMapper를 대신 실행한다.

4. @RequestBody는 생략할 수 없다.

@RequstParam, @ModelAttribute는 생략이 가능하다.

@Slf4j
@RestController
public class JsonController {
	
	@PostMapping("/v4/request-body-json")
  public String requestBodyJsonV4(Tutor tutor) { // @RequestBody 생략시 @ModelAttribute가 된다.

      Tutor requestBodyTutor = tutor;

      return "tutor.getName() = " + requestBodyTutor.getName() + " tutor.getAge() = " + requestBodyTutor.getAge();
  }
	
}

• Postman
  
• 생략하면 @ModelAttribute가 된다.
  • 요청 파라미터를 처리하도록 설정된다.
• Request Header의 contentType은 꼭 application/json 이여야 한다.
  • 위 설정 정보를 기반으로 MessageConverter가 실행된다.

HttpEntity 사용

@RestController
public class JsonController {
	
	@PostMapping("/v5/request-body-json")
  public String requestBodyJsonV5(
          HttpEntity<Tutor> httpEntity
  ) {
      // 값을 꺼내서 사용해야한다!
      Tutor tutor = httpEntity.getBody();

      return "tutor.getName() = " + tutor.getName() + " tutor.getAge() = " + tutor.getAge();
  }
	
}

• Postman
  

• HttpEntity<Tutor>
  • Generic Type으로 Tutor가 지정되어 있기 때문에 해당 Class로 반환된다.

@ResponseBody

@Controller
public class JsonController {
	
	@ResponseBody // @RestController = @Controller + @ResponseBody
	@PostMapping("/v6/request-body-json")
    public Tutor requestJson(@RequestBody Tutor tutor) {
        return tutor;
  }
	
}

• Postman
  
• View를 조회하지 않고 Response Body에 Data를 입력해서 직접 반환한다.
• 요청 뿐만이 아니라 응답에도 HttpMessageConverter가 동작한다.
  • MaapingJackson2HttpMessageConverter 적용
  • 응답 객체인 Tutor가 JSON으로 변환되어 반환된다.
• HttpEntity를 사용해도 된다.

- 요약

1. 요청 데이터는 @RequestBody를 사용해서 바인딩 하면 된다.
2. @RequestBody 는 생략이 불가능하다.
   - @ModelAttribute가 적용되기 때문
3. HttpMessageConverter 가 요청 응답 데이터를 모두 변환할 수 있다.
   - JSON은 MappingJackson2HttpMessageConverter 를 사용한다.
   - Request Header의 Content-Type은 application/json 이어야 한다.
   - Header로 어떤 Converter가 동작할지 판별한다.
   

HTTPMessageConverter

Spring Framework에서 HTTP 요청과 응답을 변환하는 인터페이스이다. 클라이언트와 서버 간에 데이터를 주고받을 때, 요청 데이터를 자바 객체로 변환하거나 자바 객체를 응답 본문으로 변환하는 역할을 수행한다.

MappingJackson2HttpMessageConverter는 JSON을 처리하는 대표적인 HTTPMessageConverter의 구현체이다.

• @RequestBody
  • 요청 데이터 + Request Header를 참고하여 Object로 변환한다.
    • HTTP Request Body(JSON Data) → Converter(Jackson) → Object
    • Reqeust Header → Content-Type : application/json(전달할 데이터 형식)
• @ResponseBody
  • 응답 데이터 + Accept Header를 참고하여 원하는 데이터 형식으로 변환한다.
    • Object → Converter(Jackson) → HTTP Response Body(JSON Data)
    • Request Header → Accept : application/json(허용할 데이터 형식)