스프링 MVC 1 - 요청 매핑

요청 매핑

요청이 왔을 때 어떤 컨트롤러가 호출이 되어야 하는지를 매핑하는 것이다.
단순하게 URL을 가지고 매핑하는 방법만 사용하는 것이 아니라 여러 정보를 조합해서 매핑할 때 사용한다.

MappingController

@RestController
@Slf4j
public class MappingController {

    @RequestMapping("/hello-basic")
    public String helloBasic() {
        log.info("hello basic");
        return "ok";
    }
}

• @RestController
  • @Controller는 반환 값이 String이면 뷰 이름으로 인식한다.
    • 뷰를 찾고 뷰가 렌더링 된다.
  • @RestController는 반환 값으로 뷰를 찾는 것이 아니라 HTTP 메시지 바디에 그대로 입력한다.
    • 실행 결과로 ok 메시지를 받을 수 있다.
• @RequestMapping("/hello-basic")
  • /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.
  • 대부분의 속성을 배열[] 로 제공하므로 다중 설정이 가능하다.
    • @RequestMapping({"/hello-basic", "/hello-go"})

둘 다 허용

다음 두가지 요청은 다른 URL이지만, 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다.

• 매핑 : /hello-basic
• URL 요청 : /hello-basic , /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";
  }

만약 여기에 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 메서드를 축약한 애노테이션을 사용하는 것이 더 직관적이다.

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://localhost:8080/mapping/userA로 실행하면 로그 결과를 확인할 수 있다.
2022-08-13 00:58:37.559 INFO 61173 --- [nio-8080-exec-1] h.s.b.requestmapping.MappingController : mappingPath userId=userA

최근 HTTP API는 리소스 경로에 식별자를 넣는 스타일을 선호한다.

• /mapping/userA
• /user/1
• @RequestMapping은 URL 경로를 템플릿화 할 수 있는데, @Pathvariable을 사용하면 매칭 되는 부분을 편리하게 조회할 수 있다.
• @PathVariable 의 이름과 파라미터 이름이 같으면 생략할 수 있다.
  • @PathVariable("userId") String userId == @PathVariable userId

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

2022-08-13 01:01:16.152 INFO 61368 --- [nio-8080-exec-1] h.s.b.requestmapping.MappingController : mappingPath userId=userA, orderId=100

특정 파라미터 조건 매핑

/**
* 파라미터로 추가 매핑
* 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";
}

http://localhost:8080/mapping-param?mode=debug
쿼리 파라미터로 params에서 지정한 값이 있어야 해당 메서드를 실행한다.

http://localhost:8080/mapping-param로 접속하면 400 에러가 뜬다.

특정 헤더 조건 매핑

/**
*특정 헤더로 추가 매핑
* 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으로 실험해보자.

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

consume은 컨트롤러가 소비하는 입장에서 사용한다.

Content-Type을 지정해야 할 때는 헤더 매핑이 아니라 미디어 타입 조건 매핑을 이용해야 한다.
Postman으로 실험해보자.

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

produces는 컨트롤러가 소비하는 입장에서 사용한다.

Accept를 지정해야 할 때 사용한다.

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

예시

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

출처 : 인프런 김영한 지식 공유자님 강의 - 스프링 MVC 1편 백엔드 웹 개발 핵심 기술