[스프링 MVC] Request Mapping

MappingController

@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("hello-basic");
        return "ok";
    }
 }

 

매핑 정보

@RestController

- @Controller는 반환값이 String이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 렌더링 된다.

- @RestController는 반환값으로 뷰를 찾는 것이 아니라, HTTP 메세지 바디에 바로 입력한다. 따라서 실행 결과로 ok 메세지를 받을 수 있다. @ResponseBody와 관련이 있는데, 뒤에서 더 자세히 공부한다.

@RequestMapping("/hello-basic")

- /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.

- 대부분의 속성을 배열[]로 제공하므로 다중 설정이 가능하다. {"/hello-basic", "/hello-go"}

 

-> Postman으로 테스트 해보자.

 

둘 다 허용 - 스프링 부트 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 메서드 매핑

/**
 * 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("mappingGetV2");
    return "ok";
}

 

HTTP 메서드를 축약한 애노테이션을 사용하는 것이 더 직관적이다.

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

 

PathVariable(경로 변수) 사용

/**
 * PathVariable 사용
 * 변수명이 같으면 생략 가능
 * @PathVariable("userId") String userId -> @PathVariable userId
 * /mapping/userA
 */
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data){
    log.info("mappingPath userId={}", data);
    return "ok";
}

 

실행

http://localhost:8080/mapping/userA

 

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

 

실행 

http://localhost:8080/mapping/users/userA/orders/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

특정 파라미터가 있거나 없는 조건을 추가할 수 있다. 잘 사용하지는 않는다.

 

특정 헤더 조건 매핑

/**
 * 특정 헤더로 추가 매핑
 * 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

/**
 * consume은 요청헤더의 컨텐트 타입
 * Content-Type 헤더 기반 추가 매핑 Media Type
 * consumes="application/json"
 * consumes="!application/json"
 * consumes="application/*"
 * consumes="*\/*"
 * MediaType.APPLICATION_JSON_VALUE
 */
@PostMapping(value="/mapping-consume", consumes= MediaType.APPLICATION_JSON_VALUE)
public String mappingConsume() {
    log.info("mappingConsume");
    return "ok";
}

 

Postman으로 테스트 해야한다.

HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.

만약 맞지 않으면 HTTP 415 상태코드(Unsupported Media Type)를 반환한다.

 

예시) 

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

 

미디어 타입 조건 매핑 - HTTP 요청 Accept, produce

/**
 * produce는 요청헤더의 accept 기반 매핑
 * Accept 헤더 기반 Media Type
 * produces = "text/html"
 * produces = "!test/html"
 * produces = "text/*"
 * produces = "*\/*"
 */
@PostMapping(value="/mapping-produce", produces=MediaType.TEXT_HTML_VALUE)
public String mappingProduce() {
    log.info("mappingProduce");
    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"