SpringCloud 如何使用feign時的復雜參數傳遞

Posted on by

Feign傳參註意

最近在用SpringCloud嘗試重構以前的項目，使用Feign客戶端組件來調用微服務，經常出現參數傳不過去變成null的問題，網上查瞭一下發現feign在參數上的使用還是有一定的限制的，主要是要註意：

1. 當參數比較復雜時，feign即使聲明為get請求也會強行使用post請求

2. 不支持@GetMapping類似註解聲明請求，需使用

@RequestMapping(value = "url",method = RequestMethod.GET)

3. 使用@RequestParam註解時必須要在後面加上參數名

寫瞭一個簡單案例，同時傳輸一個對象和一個字符串作為請求參數，主要關註參數的聲明，其餘比如eureka和feign的依賴和配置和後續使用相關的知識請另行查閱。僅供參考

服務端（生產者）

準備：

1. 已經配置將服務註冊在eureka，服務名為“item-service”

2. service層和dao層已經實現好瞭

邏輯：ItemController接收參數，調用service層，service中為商品Item對象添加詳情desc，然後調用dao保存Item對象，返回Result結果封裝對象

@RestController
public class ItemController { 
    @Autowired
    private ItemService itemService;
 
    /**
     * 添加
     * @param item
     * @param desc
     * @return
     */
    @RequestMapping("/item/save")
    public Result addItem(@RequestBody Item item, @RequestParam("desc") String desc){
        return itemService.addItem(item, desc);
    }
}

客戶端（消費者）

準備： 已經配置註冊到eureka

邏輯：

聲明ItemFeignClient調用eureka上名為”item-service”的服務，返回Result對象

使用Post請求，傳遞兩個參數：

1. TbItem對象，使用@RequestBody來聲明

2. String字符串，使用@RequestParam(“xxx”)來聲明

@FeignClient("item-service")
public interface ItemFeignClient {
 
    /**
     * 添加
     * @param item
     * @param desc
     * @return
     */
    @RequestMapping(value = "/item/save",method = RequestMethod.POST)
    Result addItem(@RequestBody TbItem item, @RequestParam("desc") String desc);

SpringCloud feign參數傳遞問題記錄

對象傳遞 @RequestBody(required = false)

不支持多對象傳遞,至少我目前發現是這樣的,如有錯誤或者改進的方法請提出

API層

@FeignClient(value = "transaction-feign")
    public interface TransactionApiService {
        /**
         * 交易流水查詢 可分頁
         *
         * @param param
         * @param pageNum
         * @param pageSize
         * @return
         */
        @RequestMapping(value = "/dealflow/list", method = RequestMethod.POST)
        JsonResultDO dealFlowList(@RequestBody(required = false) DealFlowDo param
                , @RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum
                , @RequestParam(value = "pageSize", defaultValue = "20") Integer pageSize);
    }

接口層

/**
 * 交易流水查詢 可分頁
 * @return JsonResultDO
 */
@RequestMapping(value = "/dealflow/list", method = RequestMethod.POST)
public Page<DealFlowDo> dealFlowList(@RequestBody(required = false) DealFlowDo param
        , @RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum
        , @RequestParam(value = "pageSize", defaultValue = "20") Integer pageSize
        , @RequestParam(value = "userId") Long userId){
    JsonResultDO resultDO = new JsonResultDO();
    Page<DealFlowDo> page = (Page<DealFlowDo> )dealFlowService.queryDealFlowList(userId, param, pageNum, pageSize);
    return page;
}

單個或多個參數傳遞 @RequestParam/@PathVariable/***

   /**
     * 根據商戶號獲取商戶信息
     *
     * @param merNo
     * @return
     */
    @RequestMapping(value = "/merchant/{merNo}", method = RequestMethod.GET)
    String getMerchantByMerNo(@PathVariable("merNo") String merNo);

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：