-
[김영한 스프링] 22. 스프링 MVC 기본 기능 - 요청 매핑Spring/스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 2023. 7. 12. 02:33
요청 매핑
MappingControlle
package hello.springmvc.basic.requestmapping; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class MappingController { private Logger log = LoggerFactory.getLogger(getClass()); @RequestMapping("/hello-basic") public String helloBasic() { log.info("helloBasic"); return "ok"; } }
main/java/hello/springmvc/basic/requestmapping/MappingController 생성
- @RestController
- @Controller는 반환 값이 String이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 랜더링 된다.
- @RestController는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다. 따라서 실행 결과로 ok 메시지를 받을 수 있다. @ResponseBody와 관련이 있는데, 뒤에서 더 자세히 설명한다.
- @RequestMapping("/hello-basic")
- /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.
- 대부분의 속성을 배열[]로 제공하므로 다중 설정이 가능하다. {"/hello-basic", "/hello-go"}
실행
둘다 허용 - 스프링 부트 3.0 이전
다음 두가지 요청은 다른 URL이지만, 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다.
- 매핑 : /hello-basic
- URL 요청 : /hello-basic, /hello-basic/
스프링 부트 3.0 이후
스프링 부트 3.0부터는 /hello-basic, /hello-basic/는 서로 다른 URL 요청을 사용해야 한다.
기존에는 마지막에 있는 / (slash)를 제거했지만, 스프링 부트 3.0부터는 마지막의 / (slash)를 유지한다.
따라서 다음과 같이 다르게 매핑해서 사용해야 한다.
매핑 : /hello-basic URL 요청 : /hello-basic
매핑 : /hello-basic/ URL 요청 : /hello-basic/결과
HTTP 메서드
@RequestMapping에 method 속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 호출된다.
모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE
HTTP 메서드 매핑
@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET) public String mappingGetV1() { log.info("mappingGetV1"); return "ok"; }
HTTP 405 상태코드(Method Not Allowed) 반환
HTTP 메서드 매핑 축약
@GetMapping(value = "/mapping-get-v2") public String mappingGetV2() { log.info("mappingGetV2"); 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"; }
최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
- /mapping/userA
- /users/1
@RequestMapping은 URL 경로를 템플릿화 할 수 있는데, @PathVariable을 사용하면 매칭되는 부분을 편리하게 조회할 수 있다.
/** * PathVariable 사용 * 변수명이 같으면 생략 가능 * @PathVariable("userId") String userId -> @PathVariable userId */ @GetMapping("/mapping/{userId}") // public String mappingPath(@PathVariable("userId") String data) { public String mappingPath(@PathVariable String userId) { // log.info("mappingPath userId={}", data); log.info("mappingPath userId={}", userId); return "ok"; }
@PathVariable의 이름과 파라미터 이름이 같으면 생략할 수 있다.
PathVariable 사용 - 다중
/** * PathVariable 사용 다중 */ @GetMapping("/mapping/users/{userId}/orders/{orderId}") public String mappingPath(@PathVariable String userId, @PathVariable Long orderId) { log.info("mappingPath userId={}, orderId={}", userId, orderId); return "ok"; }
특정 파라미터 조건 매핑
/** * 파라미터로 추가 매핑 * params="mode", * params="!mode" * params="mode=debug" * params="mode!=debug" * params = {"mode=debug", "data=good"} */ @GetMapping(value = "/mapping-param", params = "mode=debug") public String mappingParam() { log.info("mappingParam"); return "ok"; }
특정 헤더 조건 매핑
/** * 특정 헤더로 추가 매핑 * headers="mode", * headers="!mode" * headers="mode=debug" * headers="mode!=debug" */ @GetMapping(value = "/mapping-header", headers = "mode=debug") public String mappingHeader() { log.info("mappingHeader"); return "ok"; }
미디어 타입 조건 매핑 - HTTP 요청 Content-Type, consume
/** * Content-Type 헤더 기반 추가 매핑 Media Type * consumes="application/json" * consumes="!application/json" * consumes="application/*" * consumes="*\/*" * MediaType.APPLICATION_JSON_VALUE */ @PostMapping(value = "/mapping-consume", consumes = "application/json") public String mappingConsumes() { log.info("mappingConsumes"); return "ok"; }
미디어 타입 조건 매핑 - HTTP 요청 Accept, produce
/** * Accept 헤더 기반 Media Type * produces = "text/html" * produces = "!text/html" * produces = "text/*" * produces = "*\/*" */ @PostMapping(value = "/mapping-produce", produces = "text/html") public String mappingProduces() { log.info("mappingProduces"); return "ok"; }
요청 매핑 - API 예시
회원 관리 API
- 회원 목록 조회 : GET /users
- 회원 등록 : POST /users
- 회원 조회 : GET /users/{userId}
- 회원 수정 : PATCH /users/{userId}
- 회원 삭제 : DELETE /users/{userId}
MappingClassController
main/java/hello/springmvc/basic/requestmapping/MappingClassController 생성
package hello.springmvc.basic.requestmapping; import org.springframework.web.bind.annotation.*; @RestController public class MappingClassController { /** * 회원 목록 조회 : GET /mapping/users * 회원 등록 : POST /mapping/users * 회원 조회 : GET /mapping/users/{userId} * 회원 수정 : PATCH /mapping/users/{userId} * 회원 삭제 : DELETE /mapping/users/{userId} */ @GetMapping("/mapping/users") public String user() { return "get users"; } @PostMapping("/mapping/users") public String addUser() { return "post user"; } @GetMapping("/mapping/users/{userId}") public String findUser(@PathVariable String userId) { return "get userId=" + userId; } @PatchMapping("/mapping/users/{userId}") public String updateUser(@PathVariable String userId) { return "update userId=" + userId; } @DeleteMapping("/mapping/users/{userId}") public String deleteUser(@PathVariable String userId) { return "delete userId=" + userId; } }
package hello.springmvc.basic.requestmapping; import org.springframework.web.bind.annotation.*; @RestController @RequestMapping("/mapping/users") public class MappingClassController { /** * 회원 목록 조회 : GET /mapping/users * 회원 등록 : POST /mapping/users * 회원 조회 : GET /mapping/users/{userId} * 회원 수정 : PATCH /mapping/users/{userId} * 회원 삭제 : DELETE /mapping/users/{userId} */ @GetMapping public String user() { return "get users"; } @PostMapping public String addUser() { return "post user"; } @GetMapping("/{userId}") public String findUser(@PathVariable String userId) { return "get userId=" + userId; } @PatchMapping("/{userId}") public String updateUser(@PathVariable String userId) { return "update userId=" + userId; } @DeleteMapping("/{userId}") public String deleteUser(@PathVariable String userId) { return "delete userId=" + userId; } }
중복으로 사용되는 "/mapping/users"을 공통으로 처리하도록 @RequestMapping("/mapping/users") 추가
출처 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1
'Spring > 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술' 카테고리의 다른 글
[김영한 스프링] 24. 스프링 MVC 기본 기능 - HTTP 요청 파라미터 (0) 2023.07.14 [김영한 스프링] 23. 스프링 MVC 기본 기능 - HTTP 요청 기본, 헤더 조회 (0) 2023.07.14 [김영한 스프링] 21. 스프링 MVC 기본 기능 - 로깅 간단히 알아보기 (0) 2023.07.11 [김영한 스프링] 20. 스프링 MVC 기본 기능 - 프로젝트 생성 & 세팅 (0) 2023.07.06 [김영한 스프링] 19. 스프링 MVC 구조 이해 - 시작하기 & 컨트롤러 통합 & 실용적인 방식 (0) 2023.07.06 - @RestController