@PathVariable註解,讓spring支持參數帶值功能的案例

Posted on by

@PathVariable的作用

獲取URL動態變量，例如

  @RequestMapping("/users/{userid}")
  @ResponseBody
  public String getUser(@PathVariable String userid){
    return "userid=" + userid; 
  }

@PathVariable的包引用

spring自從3.0版本就引入瞭org.springframework.web.bind.annotation.PathVariable，

這是RESTful一個具有裡程碑的方式，將springMVC的精華推向瞭高潮，那個時代，跟微信公眾號結合的開發如火如荼，很多東西都會用到URL參數帶值的功能。

@PathVariable的PathVariable官方doc解釋

– Annotation which indicates that a method parameter should be bound to a URI template variable. Supported for RequestMapping annotated handler methods in Servlet environments.

– If the method parameter is Map<String, String> or MultiValueMap<String, String> then the map is populated with all path variable names and values.

翻譯過來就是：

– 在SpringMVC中可以使用@PathVariable註解，來支持綁定URL模板參數(占位符參數/參數帶值)

– 另外如果controller的參數是Map(String, String)或者MultiValueMap(String, String)，也會順帶把@PathVariable的參數也接收進去

@PathVariable的RESTful示范

前面講作用的時候已經有一個，現在再提供多一個，別人訪問的時候可以http://localhost:8080/call/窗口號-檢查編號-1

/**
   * 叫號
   */
  @PutMapping("/call/{checkWicket}-{checkNum}-{status}")
  public ApiReturnObject call(@PathVariable("checkWicket") String checkWicket,@PathVariable("checkNum") String checkNum,
      @PathVariable("status") String status) {
    if(StringUtils.isBlank(checkWicket) || StringUtils.isBlank(checkNum)) {
      return ApiReturnUtil.error("叫號失敗,窗口號,檢查者編號不能為空");
    }else {
      if(StringUtils.isBlank(status)) status ="1";
      try {
        lineService.updateCall(checkWicket,checkNum,status);
        return ApiReturnUtil.success("叫號成功");
      } catch (Exception e) {
        return ApiReturnUtil.error(e.getMessage());
      }
    }
  }

補充：解決@PathVariable接收參數帶點號時隻截取點號前的數據的問題

問題：

@RequestMapping(value = "preview/{fileName}", method = RequestMethod.GET)
public void previewFile(@PathVariable("fileName") String fileName, HttpServletRequest req, HttpServletResponse res) {
 officeOnlinePreviewService.previewFile(fileName, req, res);
}

本來fileName參數傳的是：userinfo.docx，

但結果接收到的是：userinfo

這顯然不是我想要的。

解決方法：

@RequestMapping(value = "preview/{fileName:.+}", method = RequestMethod.GET)
public void previewFile(@PathVariable("fileName") String fileName, HttpServletRequest req, HttpServletResponse res) {
 officeOnlinePreviewService.previewFile(fileName, req, res);
}

參數fileName這樣寫，表示任何點（包括最後一個點）都將被視為參數的一部分：

{fileName:.+}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。如有錯誤或未考慮完全的地方，望不吝賜教。

推薦閱讀：