@PathVariable注解,讓spring支持參數(shù)帶值功能的案例

更新時(shí)間：2021年02月23日 11:22:58 作者：Moshow鄭鍇

這篇文章主要介紹了@PathVariable注解,讓spring支持參數(shù)帶值功能的案例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧

@PathVariable的作用

獲取URL動(dòng)態(tài)變量，例如

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

@PathVariable的包引用

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

這是RESTful一個(gè)具有里程碑的方式，將springMVC的精華推向了高潮，那個(gè)時(shí)代，跟微信公眾號(hào)結(jié)合的開(kāi)發(fā)如火如荼，很多東西都會(huì)用到URL參數(shù)帶值的功能。

@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.

翻譯過(guò)來(lái)就是：

- 在SpringMVC中可以使用@PathVariable注解，來(lái)支持綁定URL模板參數(shù)(占位符參數(shù)/參數(shù)帶值)

- 另外如果controller的參數(shù)是Map(String, String)或者M(jìn)ultiValueMap(String, String)，也會(huì)順帶把@PathVariable的參數(shù)也接收進(jìn)去

@PathVariable的RESTful示范

前面講作用的時(shí)候已經(jīng)有一個(gè)，現(xiàn)在再提供多一個(gè)，別人訪(fǎng)問(wèn)的時(shí)候可以http://localhost:8080/call/窗口號(hào)-檢查編號(hào)-1

/**
   * 叫號(hào)
   */
  @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("叫號(hào)失敗,窗口號(hào),檢查者編號(hào)不能為空");
    }else {
      if(StringUtils.isBlank(status)) status ="1";
      try {
        lineService.updateCall(checkWicket,checkNum,status);
        return ApiReturnUtil.success("叫號(hào)成功");
      } catch (Exception e) {
        return ApiReturnUtil.error(e.getMessage());
      }
    }
  }

補(bǔ)充：解決@PathVariable接收參數(shù)帶點(diǎn)號(hào)時(shí)只截取點(diǎn)號(hào)前的數(shù)據(jù)的問(wèn)題

問(wèn)題：

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

本來(lái)fileName參數(shù)傳的是：userinfo.docx，

但結(jié)果接收到的是：userinfo

這顯然不是我想要的。

解決方法：

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

參數(shù)fileName這樣寫(xiě)，表示任何點(diǎn)（包括最后一個(gè)點(diǎn)）都將被視為參數(shù)的一部分：