[스프링MVC 기본 기능 1] 요청 매핑

요청매핑이란, 요청이 왔을 때 어떤 컨트롤러가 호출되어야하는지를 매핑하는 것이다. 단순하게 URL로 매핑하는 방법 뿐 아니라, 여러가지 요소들을 조합하여 매핑할 수 있다.

 

---

• @RestController
  • @Controller는 반환 값이 String이면 뷰 이름으로 인식돼서 뷰를 찾고 뷰가 랜더링 된다. 반면, @RestController는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다. 따라서 실행 결과로 ok 메세지를 그대로 받을 수 있다. (@ResponseBody와 관련있음)

---

@RestController
public class MappingController {
    private Logger log = LoggerFactory.getLogger(getClass());
    /**
     * 기본 요청
     * method 속성 지정 안하면, HTTP 메서드 모두 허용 
     */
    @RequestMapping("/hello-basic")
    public String helloBasic() {
        log.info("helloBasic");
        return "ok";
    }

    ...

• @RequestMapping("/hello-basic")
  • /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.
  • 대부분의 속성을 배열[] 로 제공하므로 다음과 같이 다중 설정이 가능하다.
    • @RequestMapping{"/hello-basic", "/hello-go"}
  • 다음 두가지 요청은 다른 URL이지만, 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다. (둘다 허용)
    • 매핑: /hello-basic
    • URL 요청: /hello-basic , /hello-basic/
  • @RequestMapping 에 method 속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 무조건 호출된다.
    • HTTP 메서드 모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE

 

---

• HTTP 메서드 매핑

/**
 * method 특정 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

/**
 * HTTP 메서드 매핑 축약 
 */
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
    log.info("mapping-get-v2");
    return "ok";
}

• 코드를 보면 내부에서 @RequestMapping 과 method 를 지정해서 사용하는 것을 확인할 수 있다.

 

---

• PathVariable(경로 변수) 사용

/**
 * PathVariable(경로 변수) 사용
 */
@GetMapping("/mapping/{userId}")    //템플릿화 //리소스 경로에 식별자(파라미터)
/*public String mappingPath(@PathVariable("userId") String data) {
    log.info("mappingPath userId={}", data);
    return "ok";
}*/ /**변수명이 같으면 생략 가능*/
public String mappingPath(@PathVariable String userId) {
    log.info("mappingPath userId={}", userId);
    return "ok";
}

• 최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일
  • /mapping/userA
  • /users/1

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

//@PathVariable("userId") String userId 
@PathVariable String userId

 

---

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

특정 파라미터가 있어야 호출된다

 

 

---

• 특정 헤더 조건 매핑 (잘 사용하지 않음)
  • 파라미터 매핑과 비슷하지만, HTTP 헤더를 사용

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

/**
 * Content-Type 헤더 기반 추가 매핑 Media Type
 * consumes="application/json"
 * consumes="!application/json"
 * consumes="application/*"
 * consumes="*\/*"
 */
@PostMapping(value = "/mapping-consume", consumes = "application/json")
//@PostMapping(value = "/mapping-consume", consumes = MediaType.APPLICATION_JSON_VALUE)
public String mappingConsumes() {
    log.info("mappingConsumes");
    return "ok";
}

 

• 예시
  • consumes = "text/plain"
  • consumes = {"text/plain", "application/*"}
  • consumes = MediaType.TEXT_PLAIN_VALUE

 

---

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

/**
 * Accept 헤더 기반 Media Type
 * produces = "text/html"
 * produces = "!text/html"
 * produces = "text/*"
 * produces = "*\/*"
 */
@PostMapping(value = "/mapping-produce", produces = "text/html")
//@PostMapping(value = "/mapping-produce", produces = MediaType.TEXT_HTML_VALUE)
public String mappingProduces() {
    log.info("mappingProduces");
    return "ok";
}

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

 

---