SpringBoot @PathVariable使用時遇到的問題及解決
@PathVariable使用時遇到的問題
第一個問題
接口:
/** * 查詢客戶詳細信息 * BY Oliver_Deng * @param userId 用戶id * @return */ @ApiOperation(value="查詢客戶詳細信息",notes = "根據傳入id查詢客戶詳細信息") @ApiResponses({@ApiResponse(code=400,message="請求參數沒填好")}) @ApiImplicitParam(paramType = "query", name = "userId", dataType = "Integer", required = true, value = "客戶id") @GetMapping("/findCustomerDetailByUserId/{userId}") public Result<Map<String,Object>> findCustomerByUserId(@PathVariable Integer userId){ //客戶信息 // CustomerListVo customerMessage = customerUserService.findCustomerByUserID(userId); //客戶車輛信息 // List<CustomerUserCar> cars = customerUserCarService.findCarByUserId(Integer.valueOf(userId)); //not finish yet //TODO 計次卡、儲值卡 return null; }
Swagger訪問:
解決辦法
將paramType 設置為path即可。
paramType:表示參數放在哪個地方
header
–>請求參數的獲取:@RequestHeader(代碼中接收註解)query
–>請求參數的獲取:@RequestParam(代碼中接收註解)path
(用於restful接口)–>請求參數的獲取:@PathVariable(代碼中接收註解)body
–>請求參數的獲取:@RequestBody(代碼中接收註解)form
(不常用)
第二個問題
接口:
/** * 查詢車輛品牌、車系、年款、車型信息 * BY Oliver_Deng * @param brandId 車輛品牌ID * @param familyId 車系ID * @param groupId 車輛年款ID * @return */ @ApiOperation(value="查詢車輛品牌、車系、年款、車型信息",notes = "查詢車輛品牌、車系、年款、車型信息,傳入子id時先將上級id清空,一次訪問隻能傳入一種id或者不傳id") @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "brandId", dataType = "String", required = false, value = "車輛品牌ID"), @ApiImplicitParam(paramType = "query", name = "familyId", dataType = "String", required = false, value = "車系ID"), @ApiImplicitParam(paramType = "query", name = "groupId", dataType = "String", required = false, value = "車輛年款ID") }) @ApiResponses({@ApiResponse(code=400,message="請求參數沒填好")}) @GetMapping("/findCarBrandMessage/{brandId}/{familyId}/{groupId}") public Result findCarBrandMessage(@PathVariable String brandId,@PathVariable String familyId,@PathVariable String groupId){ return customerUserCarService.findCarBrandMessage(brandId,familyId,groupId); }
Swageer訪問:
查詢成功,但是沒有數據,我們來DeBug看一下:
可以看到值竟然時這些,並不是為null,所以自然滿足瞭if條件,但功能並不是要如此。
解決辦法
把@ApiImplicitParam參數去掉,用@RequestParam()。
為什麼能用@RequestParam()?
RequestParam就是在url後面拼接的參數。
成功:
@PathVariable 404問題
跳轉頁面:
controller層:
之後console不報錯,但是
改變方法:
改正之後:
以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。
推薦閱讀:
- @PathVariable 如何自動填充入實例對象中
- 關於Swagger註釋API的使用說明
- SpringBoot中使用Swagger的超簡單方法
- Swagger中@ApiIgnore註解的使用詳解
- Spring中的PathVariable註釋解析