@RestController
public class MappingController {
private Logger log = LoggerFactory.getLogger(getClass());
/**
* 기본 요청
* 둘다 허용 /hello-basic, /hello-basic/
* HTTP 메서드 모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE
*/
@RequestMapping("/hello-basic")
public String helloBasic() {
log.info("helloBasic");
return "ok";
}
}
@RestController
@Controller
는 반환 값이 String
이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 랜더링 된다.@RestController
는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다. @RequestMapping("/hello-basic")
/hello-basic
URL 호출이 오면 이 메서드가 실행되도록 매핑한다.배열[]
로 제공하므로 다중 설정이 가능하다. {"/hello-basic", "/hello-go"}
HTTP 메서드
@RequestMapping
에 method
속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 호출된다. GET, HEAD, POST, PUT, PATCH, DELETE 모두 허용
HTTP 메서드 매핑
/**
* method 특정 HTTP 메서드 요청만 허용
* GET, HEAD, POST, PUT, PATCH, DELETE
*/
@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
public String mappingGetV1() {
log.info("mappingGetV1");
return "ok";
}
만약 "/mapping-get-v1"
uri로 POST 요청을 하면 스프링 MVC는 HTTP 405 상태코드(Method Not Allowed)를 반환한다.
HTTP 메서드 매핑 축약
/**
* 편리한 축약 애노테이션
* @GetMapping
* @PostMapping
* @PutMapping
* @DeleteMapping
* @PatchMapping
*/
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
log.info("mapping-get-v2");
return "ok";
}
PathVariable(경로 변수) 사용
/**
* PathVariable 사용
* 변수명이 같으면 생략 가능
* @PathVariable("userId") String userId -> @PathVariable userId
*/
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data) {
log.info("mappingPath userId={}", data);
return "ok";
}
/**
* PathVariable 사용 다중
*/
@GetMapping("/mapping/users/{userId}/orders/{orderId}")
public String mappingPath(@PathVariable String userId, @PathVariable Long orderId) {
return "ok";
}
최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
/mapping/userA
/users/1
@RequestMapping
은 URL 경로를 템플릿화 할 수 있는데, @PathVariable
을 사용하면 매칭 되는 부분을
편리하게 조회할 수 있다.
@PathVariable
의 이름과 파라미터 이름이 같으면 생략할 수 있다.
애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.
RequestHeaderController
@Slf4j
@RestController
public class RequestHeaderController {
@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
@RequestHeader("host") String host
required
defaultValue
@CookieValue(value = "myCookie", required = false) String cookie
required
defaultValue
스프링이 제공하는 @RequestParam
을 사용하면 요청 파라미터를 매우 편리하게 사용할 수 있다.
RequestParamController
/*
* @RequestParam 사용
* - 파라미터 이름으로 바인딩
* @ResponseBody 추가
* - View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
*/
@ResponseBody
@RequestMapping("/request-param-v2")
public String requestParamV2(
@RequestParam("username") String memberName,
@RequestParam int age,
String str) {
log.info("username={}, age={}", memberName, age);
return "ok";
}
@RequestParam
: 파라미터 이름으로 바인딩@RequestParam int age
: HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx")
생략 가능String str
: String , int , Integer
등의 단순 타입이면 @RequestParam
도 생략 가능@ResponseBody
: View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력@RequestParam의 name(value)
속성이 파라미터 이름으로 사용
이렇게 애노테이션을 완전히 생략해도 되는데, 너무 없는 것도 약간 과하다는 주관적 생각이 있다.
@RequestParam
이 있으면 명확하게 요청 파라미터에서 데이터를 읽는다는 것을 알 수 있따.
파라미터 필수 여부 - requestParamRequired
@RequestParam(required = true) String username
@RequestParam.required
true
)이다.실제 개발을 하면 요청 파라미터를 받아서 필요한 객체를 만들고 그 객체에 값을 넣어주어야 한다. 보통 다음과 같이 코드를 작성할 것이다.
@RequestParam String username;
@RequestParam int age;
HelloData data = new HelloData();
data.setUsername(username);
data.setAge(age);
스프링은 이 과정을 완전히 자동화해주는 @ModelAttribute
기능을 제공한다.
HelloData - 요청 파라미터를 바인딩 받을 객체
@Data
public class HelloData {
private String username;
private int age;
}
롬복
@Data
@Getter
,@Setter
,@ToString
,@EqualsAndHashCode
,@RequiredArgsConstructor
를 자동으로 적용해준다.
/**
* @ModelAttribute 사용
* 참고: model.addAttribute(helloData) 코드도 함께 자동 적용됨
*/
@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
log.info("username={}, age={}", helloData.getUsername(),
helloData.getAge());
return "ok";
}
스프링MVC는 @ModelAttribute
가 있으면 다음을 실행한다.
HelloData
객체를 생성한다.HelloData
객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter
를 호출해서 파라미터의 값을 입력(바인딩) 한다.username
이면 setUsername()
메서드를 찾아서 호출하면서 값을 입력한다.객체에 getUsername()
, setUsername()
메서드가 있으면, 이 객체는 username
이라는 프로퍼티를 가지고 있다.
username
프로퍼티의 값을 변경하면 setUsername()
이 호출되고, 조회하면 getUsername()
이 호출된다.
/**
* @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 로 지정해둔 타입 외)
요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우는 @RequestParam, @ModelAttribute
를 사용할 수 없다.
HttpEntity - requestBodyStringV3
/**
* HttpEntity: HTTP header, body 정보를 편리하게 조회
* - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
* - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
*
* 응답에서도 HttpEntity 사용 가능
* - 메시지 바디 정보 직접 반환(view 조회X)
* - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
*/
@PostMapping("/request-body-string-v3")
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) {
String messageBody = httpEntity.getBody();
log.info("messageBody={}", messageBody);
return new HttpEntity<>("ok");
}
스프링 MVC는 다음 파라미터를 지원한다.
HttpEntity
를 상속받은 다음 객체들도 같은 기능을 제공한다.
HttpMethod, url
정보가 추가, 요청에서 사용return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED)
스프링 MVC 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환해서 전달해주는데, 이때 HTTP 메시지 컨버터(
HttpMessageConverter
)라는 기능을 사용한다.
@RequestBody - requestBodyStringV4
/**
* @RequestBody
* - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
* - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
*
* @ResponseBody
* - 메시지 바디 정보 직접 반환(view 조회X)
* - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
*/
@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) {
log.info("messageBody={}", messageBody);
return "ok";
}
RequestBodyJsonController - @RequestBody 객체 변환
/**
* @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
* HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (content-type: application/json)
*
* @ResponseBody 적용
* - 메시지 바디 정보 직접 반환(view 조회X)
* - HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter 적용
(Accept: application/json)
*/
@ResponseBody
@PostMapping("/request-body-json-v5")
public HelloData requestBodyJsonV5(@RequestBody HelloData data) {
log.info("username={}, age={}", data.getUsername(), data.getAge());
return data;
}
@RequestBody 객체 파라미터
@RequestBody HelloData data
@RequestBody
에 직접 만든 객체를 지정할 수 있다.HttpEntity
, @RequestBody
를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.
HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해준다.
@RequestBody는 생략 불가능
@RequestBody
를 생략할 경우 HelloData data
가 String, int, Integer
같은 단순 타입이 아니므로, 스프링은 @ModelAttribute
를 적용한다. 그러면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.
주의
HTTP 요청시에 content-type이 application/json인지 꼭! 확인해야 한다. 그래야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다.
@RequestBody
요청@ResponseBody
응답스프링에서 응답 데이터를 만드는 방법은 크게 3가지이다.
src/main/resources/static
src/main/resources/templates
String을 반환하는 경우 - View or HTTP 메시지
@ResponseBody
가 없으면 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다.@ResponseBody
가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 문자가 입력된다.responseBodyJsonV2
@ResponseStatus(HttpStatus.OK)
@ResponseBody
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
HelloData helloData = new HelloData();
helloData.setUsername("userA");
helloData.setAge(20);
return helloData;
}
ResponseEntity
는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody
를 사용하면 이런 것을 설정하기 까다롭다.
@ResponseStatus(HttpStatus.OK)
애노테이션을 사용하면 응답 코드도 설정할 수 있다.
물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다. 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity
를 사용하면 된다.
@RestController
@Controller
대신에 @RestController
애노테이션을 사용하면, 해당 컨트롤러에 모두
@ResponseBody
가 적용되는 효과가 있다. 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름 그대로 Rest API(HTTP API)
를 만들 때 사용하는 컨트롤러이다.
뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.
@ResponseBody
를 사용viewResolver
대신에 HttpMessageConverter
가 동작StringHttpMessageConverter
MappingJackson2HttpMessageConverter
HttpMessageConverter가
기본으로 등록되어 있음참고: 응답의 경우 클라이언트의 HTTP Accept 해더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서
HttpMessageConverter
가 선택된다.
스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용한다.
@RequestBody
, HttpEntity(RequestEntity)
@ResponseBody
, HttpEntity(ResponseEntity)
HTTP 메시지 컨버터 인터페이스
org.springframework.http.converter.HttpMessageConverter
public interface HttpMessageConverter<T> {
boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
List<MediaType> getSupportedMediaTypes();
T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;
void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;
}
HTTP 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용된다.
canRead(), canWrite()
: 메시지 컨버터가 해당 클래스, 미디어 타입을 지원하는지 체크read(), wirte()
: 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능스프링 부트 기본 메시지 컨버터 (일부 생략)
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter
스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선 순위가 넘어간다.
주요한 메시지 컨버터
ByteArrayHttpMessageConverter
: byte[]
데이터를 처리한다.
byte[]
, 미디어 타입 : */*
@RequestBody byte[] data
@ResponseBoy return byte[]
쓰기 미디어타입 application/octet-stream
StringHttpMessageConverter
: String
문자로 데이터를 처리한다.
String
, 미디어 타입 : */*
@RequestBody String data
@ResponseBody return "ok"
쓰기 미디어 타입 text/plain
MappingJackson2HttpMessageConverter
: application/json
HashMap
, 미디어 타입 application/json
@RequestBody HelloData data
@ResponseBody return helloData
쓰기 미디어 타입 application/json
@RequestBody
, HttpEntity
파라미터를 사용한다.canRead()
를 호출한다.@RequestBody
의 대상 클래스 ( byte[] , String , HelloData
)text/plain , application/json , */*
canRead()
조건을 만족하면 read()
를 호출해서 객체 생성하고, 반환한다.@ResponseBody
, HttpEntity
로 값이 반환된다. canWrite()
를 호출한다.byte[] , String , HelloData
)text/plain , application/json , */*
canWrite()
조건을 만족하면 write()
를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.그렇다면 HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 것일까?
다음 그림에서는 보이지 않는다.
모든 비밀은 애노테이션 기반의 컨트롤러, 그러니까 @RequestMapping
을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter
(요청 매핑 핸들러 어뎁터)에 있다.
@RequestMapping
을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter
(요청 매핑 헨들러 어뎁터)에 있다.
RequestMappingHandlerAdaptor 동작 방식
ArgumentResolver
생각해보면, 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.
HttpServletRequest
, Model
은 물론이고, @RequestParam
, @ModelAttribute
같은 애노테이션 그리고 @RequestBody
, HttpEntity
같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다. 이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver
덕분이다.
애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter
는 바로 이 ArgumentResolver
를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다. 그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.
참고
스프링은 30개가 넘는
ArgumentResolver
를 기본으로 제공한다.
HandlerMethodArgumentResolver
줄여서 ArgumentResolver
라고 부른다.
public interface HandlerMethodArgumentResolver {
boolean supportsParameter(MethodParameter parameter);
@Nullable
Object resolveArgument(MethodParameter parameter,
@Nullable ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
@Nullable WebDataBinderFactory binderFactory) throws Exception;
}
ArgumentResolver
의 supportsParameter()
를 호출해서 해당 파라미터를 지원하는지 체크하고, 지원하면 resolveArgument()
를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.
ReturnValueHandler
줄여서 ReturnValueHandler
라 부른다. ArgumentResolver
와 비슷한데, 이것은 응답 값을 변환하고 처리한다.
컨트롤러에서 String
으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler
덕분이다.
참고
스프링은 10개가 넘는
ReturnValueHandler
를 기본으로 제공한다.
HTTP 메시지 컨버터 위치
HTTP 메시지 컨버터를 사용하는 @RequestBody
도 컨트롤러가 필요로 하는 파라미터의 값에 사용된다.
@ResponseBody
의 경우도 컨트롤러의 반환 값을 이용한다.
요청의 경우 @RequestBody
를 처리하는 ArgumentResolver
가 있고, HttpEntity
를 처리하는 ArgumentResolver
가 있다. 이 ArgumentResolver
들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.
응답의 경우 @ResponseBody
와 HttpEntity
를 처리하는 ReturnValueHandler
가 있다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.
스프링 MVC는
@RequestBody
@ResponseBody
가 있으면
RequestResponseBodyMethodProcessor
(ArgumentResolver)
HttpEntity
가 있으면
HttpEntityMethodProcessor
(ArgumentResolver)를 사용한다.
스프링은 다음을 모두 인터페이스로 제공한다. 따라서 필요하면 언제든지 기능을 확장할 수 있다.
HandlerMethodArgumentResolver
HandlerMethodReturnValueHandler
HttpMessageConverter
@Bean
public WebMvcConfigurer webMvcConfigurer() {
return new WebMvcConfigurer() {
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
//...
}
@Override
public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
//...
}
};
}