最近項(xiàng)目中大量使用了Spring Cloud Feign來對(duì)接http接口，踩了不少坑，也產(chǎn)生了一些對(duì)RESTFUL接口設(shè)計(jì)的想法，特此一篇記錄下。

SpringMVC的請(qǐng)求參數(shù)綁定機(jī)制

了解Feign歷史的朋友會(huì)知道，Feign本身是Netflix的產(chǎn)品，Spring Cloud Feign是在原生Feign的基礎(chǔ)上進(jìn)行了封裝，引入了大量的SpringMVC注解支持，這一方面使得其更容易被廣大的Spring使用者開箱即用，但也產(chǎn)生了不小的混淆作用。所以在使用Spring Cloud Feign之前，筆者先介紹一下SpringMVC的一個(gè)入?yún)C(jī)制。預(yù)設(shè)一個(gè)RestController，在本地的8080端口啟動(dòng)一個(gè)應(yīng)用，用于接收http請(qǐng)求。

@RestControllerpublic class BookController { @RequestMapping(value = "/hello") // <1> public String hello(String name) { // <2> return "hello " + name; }}

這個(gè)接口寫起來非常簡(jiǎn)單，但實(shí)際springmvc做了非常多的兼容，使得這個(gè)接口可以接受多種請(qǐng)求方式。

<1> RequestMapping代表映射的路徑，使用GET,POST,PUT,DELETE方式都可以映射到該端點(diǎn)。

<2> SpringMVC中常用的請(qǐng)求參數(shù)注解有(@RequestParam,@RequestBody,@PathVariable)等。name被默認(rèn)當(dāng)做@RequestParam。形參String name由框架使用字節(jié)碼技術(shù)獲取name這個(gè)名稱，自動(dòng)檢測(cè)請(qǐng)求參數(shù)中key值為name的參數(shù)，也可以使用@RequestParam(“name”)覆蓋變量本身的名稱。當(dāng)我們?cè)趗rl中攜帶name參數(shù)或者form表單中攜帶name參數(shù)時(shí)，會(huì)被獲取到。

POST /hello HTTP/1.1Host: localhost:8080Content-Type: application/x-www-form-urlencodedname=formParam

或

GET /hello?name=queryString HTTP/1.1Host: localhost:8080

Feign的請(qǐng)求參數(shù)綁定機(jī)制

上述的SpringMVC參數(shù)綁定機(jī)制，大家應(yīng)該都是非常熟悉的，但這一切在Feign中有些許的不同。

我們來看一個(gè)非常簡(jiǎn)單的，但是實(shí)際上錯(cuò)誤的接口寫法：

//注意：錯(cuò)誤的接口寫法@FeignClient("book")public interface BookApi { @RequestMapping(value = "/hello

總結(jié)

以上是生活随笔為你收集整理的feignclient注解使用_从 Feign 使用注意点到 RESTFUL 接口设计规范的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。