요청 매핑

매핑 정보

@RestController

• @Controller는 반환 값이 String이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 렌더링 ㅗ딘다.
• @RestController는 반환 값으로 뷰를 찾는 것이 아니라 ,HTTP 메시지 바디에 바로 입력한다.

---

@RequestMapping("/hello-basic")

• /hello-basic : URL 호출이 오면 이 메서드가 실행되도록 매핑한다.
• 대부분의 속성을 배열[] 로 제공하기 때문에 다중 설정이 가능하다. ["/hello-basic", "/hello-go"]

참고

스프링 부트 3.0 이전

• 스프링은 다음 URL 요청들을 같은 요청으로 매핑
• 매핑 : /hello-basic
• URL 요청 : /hello-basic, /hello-basic/

---

스프링 부트 3.0 이후

• 마지막의 /를 유지한다.
• 매핑 : /hello-basic -> URL 요청 : /hello-basic
• 매핑 : /hello-basic/ -> URL 요청 : /hello-basic/

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";
 }

• 만약 여기에 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";
 }

• HTTP 메서드를 축약한 애노테이션을 사용하는 것이 더 직관적이다. 위의 코드를 확인해보면 @RequestMapping과 method를 지정해서 사용하는 것을 확인할 수 있다.

PathVariable(경로 변수) 사용

 /**
 * PathVariable 사용
 * 변수명이 같으면 생략 가능
 * @PathVariable("userId") String userId -> @PathVariable String 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 사용 - 다중

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

• url에서 넘어온 PathVariable을 위와같이 다중으로 사용해서 받아올 수 있다.

특정 파라미터 조건 매핑

/**
 * 파라미터로 추가 매핑
 * 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 헤더를 사용
• POSTMAN으로 테스트할 경우 편함. (아래의 코드도 모두 postman에서 테스트)> POSTMAN headers 정보에서 mode > debug를 추가하면 정상적으로 log가 찍히는 것을 확인할 수 있다.

미디어 타입 조건 매핑 - 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 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.
• 만약 맞지 않으면 HTTP 415 상태코드 (Unsupported Media Type)을 반환한다.

예시

consumes = "text/plain"
consumes = {"text/plain" "application/*"}
consumes = MediaType.TEXT_PLAIN_VALUE

미디어 타입 조건 매핑 - 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";
 }

• HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑한다.
• 만약 맞지 않으면 HTTP 406 상태코드 (Not Acceptable)을 반환한다.

예시

produces = "text/plain"
produces = {"text/plain", "application/*"}
produces = MediaType.TEXT_PLAIN_VALUE
produces = "text/plain;charset=UTF-8"

---

요청 매핑 - API 예시

• 회원 관리 API(예시)

API 목록	HTTP METHOD	URL
회원 목록 조회	GET	/users
회원 등록	POST	/users
회원 조회	GET	/users/{userId}
회원 수정	PATCH	/users/{userId}
회원 삭제	DELETE	/users/{userId}

@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {

    @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;
    }
}

이렇게 Spring에서 http 요청을 받았을때 어떻게 request요청을 받는지 그리고 request에 어떠한 제약을 부여하고 제약이 맞았을 경우에만 요청을 받아들일수 있는지, 기본적인 형태의 HTTP METHOD 요청이 오면 작동하는 API를 가볍게 만들어 보았다.

📭 Reference

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