Spring BootのRestControllerの@PathVariableと@RequestParamの使い方

2019/1/19 spring boot

Spring BootのRestControllerの@PathVariableと@RequestParamの使い方

Spring BootでRest APIを作成するときにGETリクエストの場合、@PathVariableと@RequestParamを使うと思いますが、使い分けがわかりづらいので整理しておきます。

@PathVariable

Rest形式のurlに{age}というように含む場合は、@PathVariableを使用します。

@GetMapping(value = "/getMethod/{age}")
public Long get(@PathVariable("age") Long age) {
  return age;
}

@GetMapping(value = "/getMethod/{age}")

public Long get(@PathVariable("age") Long age) {

return age;

}

＠GetMappingアノテーションで指定するurlのうち、｛age｝で指定したものを@PathVariable(“age”)で取得して返却しています。

@RequestParam

Rest形式のurlに、「?a=1」というようにクエリ文字列を付加して、その値を取得する場合に@RequestParamを使用します。

@GetMapping(value = "/getMethod")
public Long get(@RequestParam("age") Long age) {
  return age;
}

@GetMapping(value = "/getMethod")

public Long get(@RequestParam("age") Long age) {

return age;

}

@GetMappingアノテーションで指定するurlに対して「?age=25」を付加した例です。

@PathVariableに日時(LocalDate)を使用する方法

@PathVariableにLocalDateを指定する場合は@DateTimeFormatをセットで使用する必要があります。

以下のように記述することでURLに日付を指定することができます。

例）http://xxx/getXX/20190101

getXX(@DateTimeFormat(pattern="yyyyMMdd" @PathVariable LocalDate targetDate) {
  // 〜何らかの処理
}

getXX(@DateTimeFormat(pattern="yyyyMMdd" @PathVariable LocalDate targetDate) {

// 〜何らかの処理

}

高橋

関西で140-170/80～120万から受け付けております^^
得意技はJS(ES6),Java,AWSの大体のリソースです
Python3.6,Djangoを勉強中です,Javaは少し飽きてしまってます–;
組込を社内で見習い勉強中です！
コメントはやさしくお願いいたします^^
座右の銘は、「狭き門より入れ」「願わくは、我に七難八苦を与えたまえ」です^^