Spring , RequestParam과 PathVariable 구분

 

`@RequestParam`과 `@PathVariable`은 Spring Framework에서 웹 애플리케이션에서 클라이언트로부터 받은 데이터를 처리하기 위한 어노테이션입니다. 

둘 다 URL에서 파라미터 값을 추출하는데 사용되지만 사용 방식과 목적이 약간 다릅니다.

 

1. @RequestParam

  `@RequestParam` 어노테이션은 메서드의 매개변수에 사용되며, URL의 쿼리 파라미터를 추출할 때 사용

 @GetMapping("/example")
 public String exampleMethod(@RequestParam String parameterName) {
     // 메서드 내용
 }

 

- 주로 검색 필터, 페이지 번호, 정렬 기준 등과 같은 요청 파라미터를 받을 때 사용

 

2. @PathVariable

`@PathVariable` 어노테이션은 URL의 일부를 변수로 사용할 때 사용.

즉, URL 경로에 있는 일부 값을 메서드의 매개변수로 전달받을 수 있습니다.
   - **예시:**

 @GetMapping("/example/{id}")
 public String exampleMethod(@PathVariable Long id) {
     // 메서드 내용
 }

- 주로 리소스의 식별자(예: 데이터베이스의 레코드 ID)를 경로에 포함하여 RESTful한 API에서 사용

 

 

혼합 사용

@GetMapping("/example")
public String exampleMethod(@RequestParam String parameterName, @PathVariable Long id) {
    // 메서드 내용
}

 

 

이 두 어노테이션을 적절히 조합하여 다양한 요청을 처리할 수 있습니다. 

예를 들어, `/example/1?parameterName=value`와 같은 요청에서 `@RequestParam`과 `@PathVariable`을 함께 사용하여 

파라미터와 경로 변수를 추출할 수 있습니다.

 

 

차이점 요약

`@RequestParam`은 쿼리 파라미터를 추출할 때 사용되며, 메서드의 매개변수로 지정됩니다.
`@PathVariable`은 URL의 일부를 매개변수로 사용할 때 쓰이며, 해당 부분은 중괄호 `{}`를 사용하여 표시됩니다.

 

 

---

 

사용기준

`@RequestParam`과 `@PathVariable`을 구분하여 사용하는 기준은 주로 '클라이언트에서 전달되는 데이터의 위치와 형태에 따라 결정'됩니다. 

 

1. 쿼리 파라미터 사용 시

   - 클라이언트가 데이터를 URL의 쿼리 파라미터로 전달하는 경우, `@RequestParam`을 사용

 @GetMapping("/example")
 public String exampleMethod(@RequestParam String parameterName) {
     // 메서드 내용
 }

   - 클라이언트 요청: `/example?parameterName=value`

 

2. 경로 변수 사용 시

   - 클라이언트가 데이터를 URL의 일부로 전달하는 경우, 즉, RESTful한 경로에 데이터가 포함된 경우, `@PathVariable`을 사용
   

@GetMapping("/example/{id}")
public String exampleMethod(@PathVariable Long id) {
     // 메서드 내용
 }

   - 클라이언트 요청: `/example/123`

 

3. 혼합 사용 시

   - 경우에 따라 쿼리 파라미터와 경로 변수를 함께 사용해야 할 수 있습니다. 이때는 두 어노테이션을 함께 사용하면 됩니다.

@GetMapping("/example/{id}")
 public String exampleMethod(@PathVariable Long id, @RequestParam String parameterName) {
     // 메서드 내용
 }

   - 클라이언트 요청: `/example/123?parameterName=value`

 

4. **기타 고려 사항:**

   - URL의 구조, 프로젝트의 URI 설계, RESTful API의 규칙 등에 따라 선택할 수 있습니다.
   - `@RequestParam`은 선택적인 파라미터를 처리하는 데 더 유용할 수 있습니다.
   - `@PathVariable`은 주로 고유 식별자나 리소스 식별을 위해 사용됩니다.

 

 

기본적으로는 RESTful한 API에서 `@PathVariable`을 사용하여 리소스 식별에 중점을 두고,
기타 요청 파라미터는 `@RequestParam`을 통해 처리하는 것이 일반적

 

 

---

 

예제

아래는 `@RequestParam`과 `@PathVariable`을 사용한 간단한 Spring MVC 예제입니다.

1. @RequestParam 사용 예제

@RestController
@RequestMapping("/api")
public class ExampleController {

    @GetMapping("/example")
    public String exampleWithRequestParam(@RequestParam String parameterName) {
        return "Received parameter: " + parameterName;
    }
}

클라이언트에서 `/api/example?parameterName=value`로 요청하면 `parameterName`의 값을 받아와서 응답으로 반환합니다.

 

 

2. @PathVariable 사용 예제

@RestController
@RequestMapping("/api")
public class ExampleController {

    @GetMapping("/example/{id}")
    public String exampleWithPathVariable(@PathVariable Long id) {
        return "Received ID: " + id;
    }
}

클라이언트에서 `/api/example/123`로 요청하면 `id`의 값을 받아와서 응답으로 반환합니다.

 

3. 혼합 사용 예제

@RestController
@RequestMapping("/api")
public class ExampleController {

    @GetMapping("/example/{id}")
    public String exampleWithMixedParams(@PathVariable Long id, @RequestParam String parameterName) {
        return "Received ID: " + id + ", Received parameter: " + parameterName;
    }
}

클라이언트에서 `/api/example/123?parameterName=value`로 요청하면 `id`와 `parameterName`의 값을 받아와서 응답으로 반환합니다.