Spring @RequestParam vs @PathVariable 애노테이션 비교

@PathVariable

• 목적: URI 경로의 변수 값을 추출할 때 사용
• 예시: /users/{userId} → userId 파라미터 추출
• 특징:
  • URL의 경로 일부로 사용되며 필수값으로 처리됨
  • RESTful 리소스 식별에 적합 (예: 특정 사용자 조회)

@GetMapping("/users/{userId}")
public User getUser(@PathVariable String userId) {
    //
}

 

 

@RequestParam

• 목적: 쿼리 스트링(?key=value)의 파라미터 추출
• 예시: /users?role=admin → role 값 추출
• 특징:
  • 선택적 파라미터 처리 가능 (required=false)
  • 필터링, 정렬, 페이징 등 부가 기능에 적합

@GetMapping("/users")
public List<User> getUsers(@RequestParam(required = false) String role) {
    //
}

 

요청 값을 처리 시 인코딩 방식 차이

@PathVariable
URL 경로에서 값을 추출할 때 인코딩되지 않은 원본 값을 그대로 가져온다. 예를 들어, URL에 ab+c가 포함되어 있으면 그대로 ab+c를 반환한다.

• http://localhost:8080/spring-mvc-basics/foos/ab+c
• 결과: ID: ab+c

@RequestParam:
쿼리 스트링의 경우, URL 디코딩 과정을 거치기 때문에 ab+c가 ab c로 변환되어 반환된다.

• http://localhost:8080/spring-mvc-basics/foos?id=ab+c
• 결과: ID: ab c

따라서, 인코딩 이슈가 발생할 수 있는 상황에서는 어떤 애노테이션을 사용할지 신중히 선택해야 한다.

 

선택적 값 처리

두 애노테이션 모두 선택적(optional) 값 처리가 가능하다.

• @PathVariable의 선택적 사용
  Spring 4.3.3부터는 required 속성을 사용하여 선택적 경로 변수 처리가 가능하다.

@GetMapping({"/myfoos/optional", "/myfoos/optional/{id}"})
@ResponseBody
public String getFooByOptionalId(@PathVariable(required = false) String id){
    return "ID: " + id;
}

• 호출 예시
  • URL: http://localhost:8080/spring-mvc-basics/myfoos/optional/abc → 결과: ID: abc
  • URL: http://localhost:8080/spring-mvc-basics/myfoos/optional → 결과: ID: null

• @RequestParam의 선택적 사용
  @RequestParam 또한 required 속성을 사용하여 필수 여부를 지정할 수 있다.단, 경로에서 생길 수 있는 충돌이나 애플리케이션 로직 상의 고려사항에 주의해야 한다.

선택적 값 처리는 유연한 API 설계에 도움을 주지만, 경로 충돌이나 데이터 누락 시 발생할 수 있는 문제에 대해 충분한 검증이 필요하다.

주요 차이점 비교

특성	@PathVariable	@RequestParam
위치	URI 경로 내 (/{value})	쿼리 스트링 (?key=value)
필수 여부	기본값 required=true	required=false로 선택적 설정 가능
사용 사례	리소스 식별 (예: ID 기반 조회)	필터링, 정렬, 검색 조건
URL 구조	RESTful 계층 구조 반영	기능적 파라미터 전달
인코딩	값이 디코딩되지 않음(예:ab+c→ab+c)	값이 자동 디코딩 됨(예:ab+c→ab c)

 

 

정리 

@PathVariable과 @RequestParam은 각각의 특징에 맞춰 클라이언트의 요청 데이터를 추출하는 도구이다.

• @PathVariable은 URI 경로 자체에서 데이터를 추출할 수 있어 RESTful API 설계 시 자연스러운 URL 구성이 가능하다.
• @RequestParam은 쿼리 스트링을 통해 데이터를 전달받을 때 유용하며, URL 디코딩 처리가 기본으로 이루어진다.
• 인코딩 이슈가 우려되는 경우(예: 값에 +나 공백 등의 특수문자가 포함되어 원본 그대로의 값이 필요할 때)는 @PathVariable을 사용하고, 일반적인 쿼리 파라미터의 경우에는 @RequestParam을 사용하는 것이 적절하다.

 

참고 자료 : 

https://www.baeldung.com/spring-requestparam-vs-pathvariable