Springcloud踩坑記---使用feignclient遠程調用服務404

公司項目進行微服務改造，由之前的dubbo改用SpringCloud，微服務之間通過FeignClient進行調用，今天在測試的時候，eureka注冊中心有相應的服務，但feignclient就是無法調通，一直報404錯誤，排查過程如下：

一、問題：

　　服務提供方定義的接口如下：

/**
 * 黑白名單查詢接口
 *
 * @author LiJunJun
 * @since 2018/10/18
 */
@Component(value = "blackAndWhiteListFeignClient")
@FeignClient(value = "pear-cache-service", path = "v1/cache/limitlist")
public interface IBlackAndWhiteListFeignClient {

    /**
     * 獲取黑白名單手機號分組編號
     *
     * @param trace 請求流水
     * @param phoneNum 電話號碼
     * @return 電話號碼所在分組
     */
    @RequestMapping(value = "/blackAndWhiteList", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    ResultData<String> blackAndWhiteList(@RequestHeader(name = "Trace") String trace, @RequestParam("phoneNum") String phoneNum);
}

接口實現類如下：

/**
 * 黑白名單controller
 *
 * @author LiJunJun
 * @since 2018/10/18
 */
@ProtectedLdApi
@RestController
@RequestMapping(value = "v1/cache/limitlist")
@Api(value = "黑白名單緩存", description = "黑白名單緩存相關接口")
public class BlacklAndWhiteListController extends AbstractController implements IBlackAndWhiteListFeignClient {

    /**
     * 日志記錄器
     */
    private final static Log LOGGER = new Log(BlacklAndWhiteListController.class);

    /**
     * 注入tedis
     */
    @Autowired
    private JedisSentinelPoolExt jedisSentinelPool;

    /**
     * 獲取黑白名單手機號分組編號
     *
     * @param trace 請求流水
     * @param phoneNum 電話號碼
     * @return 電話號碼所在分組
     */
    @Override
    @ApiOperation(value = "獲取黑白名單手機號分組編號", notes = "根據電話號碼從緩存中獲取黑白名單分組")
    @RequestMapping(value = "/blackAndWhiteList", method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_UTF8_VALUE, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    public ResultData<String> blackAndWhiteList(@RequestHeader(name = "Trace") String trace, @RequestParam("phoneNum") String phoneNum) {
      do something...
    }
}    

 調用方如下：

public class MessageListController {

    private static final Log LOGGER = new Log(MessageListController.class);

    @Autowired
    private IBlackAndWhiteListFeignClient blackAndWhiteListFeignClient;

    @RequestMapping(value = "/testBlackAndWhiteList", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    public ResultData<String> testBlackAndWhiteList() {

        LOGGER.info("開始調用緩存接口");

        ResultData<String> res = blackAndWhiteListFeignClient.blackAndWhiteList("asdqwezxxc", "B18037903086");

        LOGGER.info("調用結果：" + res.getResultData());

        return res;
    }

 

調用結果：

 華麗麗的404了，很頭疼，經過各種度娘，發現導致這個問題有兩個原因，以下是解決方法：

二、問題分析

經過百度，說將SpringBoot配置文件里面 server.servlet.context-path 注釋掉即可，抱着試一哈的態度，注釋了，重啟，調用，結果驚喜的發現，依舊報錯了，但仔細一看，錯誤代碼已經不是404，變成了415，這就相當於調通了，但是，Content-Type的類型不對，於是，返回去看代碼（此時已經肯定，今天能把feignclient接口調通），

仔細一看發現，接口上定義的@RequestMapping中，只定義了 produces = MediaType.APPLICATION_JSON_UTF8_VALUE，而實現類中，@RequestMapping定義了consumes、produces均為 "application/json;charset=UTF-8"

我們知道，consumes定義了方法接受的Http的請求類型，produces則定義了Http請求返回的類型；

然后我們說下FeignClient，它的底層實現，就是根據定義的FeignClient接口，來組裝Http請求進行遠程調用，而Http默認的Content-type是x-www-form-urlencoded類型化的，到這兒，問題就呼之欲出了：

再來回顧上面我們定義的接口，並沒有指定請求類型（consumes），那么FeignClient組裝的Http請求的類型就是默認的x-www-form-urlencoded類型，但我們的實現類上，卻定義了consumes=MediaType.APPLICATION_JSON_UTF8_VALUE，也就是說，僅接受json類型的請求，這就是為什么415的原因了；

三、解決方法

知道了問題的原因，解決起來就很簡單了，我們可以在FeignClient的接口定義上，指定consumes，這樣，FeignClient在組裝Http請求的時候，就會在header里面設置請求類型為application/json，這樣，問題就完美解決；

再來看調用結果：

完美返回！！！

四、總結

feignclient接口定義是一個模板化的，其組裝的Http請求完全按照你定義的接口去組裝，如你在參數中，用@RequestHeader去接收一個參數，其組裝請求時，就會將你傳入的參數放至Header中，你指定的consumes為json，其組裝的請求Content-Type就是 application/json類型的，完全不需要調用方感知，就像調用普通方法一樣，不得不說，很強大，只要生成的Http請求正確，服務提供方提供的Rest接口能和FeignClient組裝的Http請求，就能夠完成遠程調用。

五、遺留問題

為什么需要將服務提供方的server.servlet.context-path去掉才能實現調用，今天暫時沒有研究，但一定有解決方案，SpringCloud不會這么low的，解決方案研究出來會補上。