Path Variable과 Query Parameter (스프링의 @RequestParam과 @PathVariable)

간단하게 요약 정리만 했다.

출처

https://ryan-han.com/post/translated/pathvariable_queryparam/

https://elfinlas.github.io/2018/02/18/spring-parameter/

https://willbesoon.tistory.com/102

사용배경

• http에서는 요청 간 데이터를 보장해 주지 않는다.
• 연결 해 놓고 데이터를 주고받는 형식이 아니라, 필요할 때마다 연결한다.

공통점

• 데이터 전달을 위해 사용된다.
• URL을 통해 값을 전달한다.

Query Parameter 쿼리 매개변수 (스프링의 @RequestParam)

/users?id=123

• 파라미터의 이름과 값을 함께 전달하는 방식이다

Best Practice : 정렬 / 필터링을 할 때 사용한다.

• @RequestParam

  • 4가지 파라미터를 가질 수 있다

  • @RequestParam("id") : URL의 파라미터 중 id라는 이름의 값을 가져온다

  • @GetMapping("read")
    public void getId(@RequestParam("no") int id) 
    {
      //...    
    }

Path Variable 경로 변수 (스프링의 @PathVariable)

/users/123

• 이름처럼 경로를 변수로서 사용한다.

• 원하는 기능에 맞게 HTTP메소드를 변경한다.

• REST API에서 값을 호출할 때 주로 사용한다.

Best Practice : 어떤 리소스를 식별할 때 사용한다.

• @PathVariable()

  • URL에서 각 구분자에 들어오는 값을 처리한다

  • @PostMapping("delete/{id}")
    @ResponseBody
    public int getId(@PathVariable("id") int id) {
        return id;
    }

@RequestParam과 @PathVariable 함께 사용하기

둘 다 필요하면 둘 다 사용할 수도 있다.

@GetMapping("/user/{userIdx}/invoices")
public List<Invoice> listUsersInvoices(
    @PathVariable("userIdx") int user,
    @RequestParam(value = "date", required = false) Date dateOrNull
)
{
    // ...
}