注解FeignClient使用規(guī)范

首先是對FeignClient里的常用屬性

• contextId：當有多個服務(wù)調(diào)用方法不想寫在一個接口里，就要使用到
• name：指定FeignClient的名稱，如果項目使用了Ribbon，name屬性會作為微服務(wù)的名稱，用于服務(wù)發(fā)現(xiàn)
• url：url一般用于調(diào)試，可以手動指定@FeignClient調(diào)用的地址
• fallback：定義容錯的處理類，當調(diào)用遠程接口失敗或超時時，會調(diào)用對應(yīng)接口的容錯邏輯，fallback指定的類必須實現(xiàn)@FeignClient標記的接口
• fallbackFactory：工廠類，用于生成fallback類示例，通過這個屬性我們可以實現(xiàn)每個接口通用的容錯邏輯，減少重復(fù)的代碼 
• path：定義當前FeignClient的統(tǒng)一前綴

使用FeignClient的原因

無非讓一個微服務(wù)的接口被另一個服務(wù)訪問，微服務(wù)的一個特點就是業(yè)務(wù)隔離，那就要盡量的做到數(shù)據(jù)庫隔離，雖 然不是真的隔離，但是要盡量在代碼上做隔離。

舉例，系統(tǒng)有一個file-server，是系統(tǒng)的公共服務(wù)，附件的下載，上傳，獲取內(nèi)容等接口實現(xiàn)。對應(yīng)操作的表是系統(tǒng)附件表。

現(xiàn)在客戶的信息里有附，正常是在客戶與附件之間做連表查詢，將附件信息拿到，但是在微服務(wù)里這樣子做是不合規(guī)的?，F(xiàn)在如果進行如下的引用

在controller類里定義的接口方法

//在controller類里定義的接口方法 ??
@RequestMapping(value = "/add" ,method = RequestMethod.GET)
public Integer add(@RequestParam Integer a, @RequestParam Integer b) {
?ServiceInstance instance = client.getLocalServiceInstance();
?Integer r = a + b;
?logger.info("/add, host:" + instance.getHost() + ", service_id:" + instance.getServiceId() + ", result:" + r);
?return r;
}

使用@FeignClient

@FeignClient("compute-service")
public interface ComputeClient {
? ? @RequestMapping(method = RequestMethod.GET, value = "/add")
? ? Integer add(@RequestParam(value = "a") Integer a, @RequestParam(value = "b") Integer b);
}

然后在另一個微服務(wù)里的controller層調(diào)用

@Autowired
ComputeClient computeClient;
@RequestMapping(value = "/add", method = RequestMethod.GET)
public Integer add() {
? ? return computeClient.add(10, 20);
}

只能說使用成功了，但是不規(guī)范，這是網(wǎng)上隨處可見的錯誤規(guī)范，一開始我也是錯誤的在controll層引用，但是被技術(shù)經(jīng)理叼了，反正就是不合規(guī)。

理由很簡單，給前端的接口不要重復(fù)。如果你這邊controller調(diào)用原來的服務(wù)，不管是哪個微服務(wù)的，前端是可以直接訪問的，那這樣子的意義何在。接口給你調(diào)用，是讓你用來獲取有用的信息來處理，然后返回給前端。

所以應(yīng)該在server層調(diào)用。

規(guī)范的使用@FignClient注解

以公共服務(wù)中的文件服務(wù)和客戶業(yè)務(wù)模塊進行服務(wù)間的通信為例

在文件服務(wù)的api模塊里寫如下

FeignClient(contextId = "fileService", value = ServicellaneConstants.FTLE_SERNVTCE，fallbackFactory=RenoteFileFallbackFactory.class)
public interface RemoteFileservice {
/**
*上傳文件*
* aparam file 文件信息*areturn結(jié)果
*/
@PostMapping(value = "/upload",consumes = MediaType.WULTIPART_FORN_DATA_VALUE)
public RcLong uplocad(CRequestParan("module ) String nodole ,ORequestParan("sunceId ) String souneId, OlequestFart(value = "file ") liltigartFile file);

此時在客戶業(yè)務(wù)板塊，即客戶需要和附件進行相關(guān)信息的1對多查詢，不能連表查詢，那就調(diào)用上面的RemoteFileservice ，一開始我在客戶模塊里寫了一個FileController，然后寫接口，接口里調(diào)用，直接NO。

應(yīng)該在業(yè)務(wù)層里調(diào)用就好了，用注解@Autowired，將你需要處理的數(shù)據(jù)獲取到并處理好。

接下來看看fallbackFactory，主要是為降級處理就是出錯了應(yīng)該返回什么。

代碼僅供參考，可能還會有其它 的寫法

//注意FallbackFactory<你注解對應(yīng)的接口類名>
@component
public class RemoteFileFallbackFactory implements FallbackFactory<RemoteFileService>
private static final Logger log = LoggerFactory.getLogger(RemoteFileFallbackFactory.class);
0verride
public RemoteFileservice create(Throwable throwable){
//打印出錯日志
log.error("文件朋務(wù)調(diào)用失敗:{}", throwable.getHessage());return new RemoteFileserviceo
{
Override
public R<Long> upload(String module,String sourceId,MultipartFile file){
return R.fail("上傳失敗:" + throwable.getMessage(o);
}
0verride
public byte[ ] getFileBytes(Long fileId) { return new byte[0];}
@0verride
public R getURL(Long[] ids) { return R.fail("獲取文件URL失敗:" + throwable.getHessage());}
@0verride
public R<List<SysFileApivo>> getURL(List<Long> ids) {
return R.fail("獲取文件URL失敗:" + throwable.getMessage());
}
};

想要怎么用，就動手實踐吧

@FeignClient注解使用的常見問題

Feign 是一個聲明式的 Web 服務(wù)，通過定義一個添加相應(yīng)注解的接口，即可完成一個 Web 服務(wù)的接口。SpringCloud 對 Feign 進行了封裝以后，其開始能夠支持 Spring MVC 標準注解，同時在 SpringCloud 架構(gòu)上結(jié)合 Eureka 和 Ribbon，還能夠支持負載均衡。

既然是一個 Web 服務(wù)，必然服務(wù)端模塊與客戶端模塊都加入 Feign 依賴以及對接的 api 接口，這是 Feign 服務(wù)的基本前提。因此雙方引入的 Feign 接口都要保持一致，包括服務(wù)地址、入?yún)⒍x、返回值等。

基本配置

要啟用 @FeignClient 接口，首先需要引入 Feign 依賴：

<dependency>
? ? <groupId>org.springframework.cloud</groupId>
? ? <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

在父 pom.xml 里還需要引入 SpringCloud 依賴，這樣使用 FeignClient 才有意義。

在啟動類上添加啟動注解 @EnableFeignClients：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.feign.EnableFeignClients;
?
@SpringBootApplication
@EnableFeignClients
public class FeignDemoApp {
? ? public static void main(String[] args) {
? ? ? ? SpringApplication.run(FeignDemoApp.class, args);
? ? }
}

然后定義 Feign 客戶端提供的服務(wù)接口，示例代碼如下：

import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
?
import com.demo.feign.model.request.FeignDemoDetailRequest;
import com.demo.feign.model.response.FeignDemoDetailResponse;
import com.demo.feign.model.response.FeignDemoListResponse;
@FeignClient("spring-boot-feign-demo")
public interface FeignDemoClient {
?
? ? @RequestMapping(value="/demo/list", method=RequestMethod.GET)
? ? public FeignDemoListResponse queryListByCode(@PathVariable("code") String code);
? ? ?
? ? @RequestMapping(value="/demo/detail", method=RequestMethod.POST)
? ? public FeignDemoDetailResponse queryDetail(@RequestBody FeignDemoDetailRequest request);
}

這里定義的 FeignDemoDetailRequest，F(xiàn)eignDemoDetailResponse 和 FeignDemoListResponse 是定義的實體類，具體就不展示了。

常見問題

Feign 的 maven 依賴報紅，或者主啟動類上@EnableFeignClients不識別，一直報紅，或者 feign 接口注入到控制器報紅。

可能的原因及處理方案：

• maven 包沒有成功導(dǎo)入，或者 maven 包下載不完整，可以從倉庫刪掉依賴包后重新下載導(dǎo)入；
• 版本沖突，或者無法獲取適當版本，此時可以在 maven 包導(dǎo)入時指定版本號，嘗試其他可用的版本。

項目 Application 啟動時，使用 @Autowired 自動注入的 FeignClient 接口被告知對應(yīng)的 Bean 無法尋獲

***************************
APPLICATION FAILED TO START
***************************
 
Description:
Field feignDemoClient in com.xxx.xxx.service.impl.DemoServiceImpl required a bean of type 'com.xxx.xxx.feign.FeignDemoClient' that could not be found.
The injection point has the following annotations:
    - @org.springframework.beans.factory.annotation.Autowired(required=true)
 
Action:
Consider defining a bean of type 'com.xxx.xxx.feign.FeignDemoClient' in your configuration.
Disconnected from the target VM, address: '127.0.0.1:51645', transport: 'socket'
Process finished with exit code 1

可能的原因及處理方案：

• 服務(wù)所在模塊沒有在 pom.xml 引入 spring-cloud-starter-openfeign 這個 maven 依賴，補上這個依賴重新構(gòu)建項目即可。
• 項目啟動沒有掃描 FeignClient 接口所在的包。項目通過啟動類啟動時默認會掃描同目錄及同目錄下級目錄的類文件。所以，Spring注入第三方包或者其他模塊的包，需要掃描需要注入的包。這種情況，只需要在啟動類的注解中指定需要掃描的包路徑即可，如：

// 開啟Feign客戶端，指定掃描 FeignClient 接口類所在的包
@EnableFeignClients("com.xxx.xxx.feign")
@SpringBootApplication

正確添加 Feign 依賴，啟動類掃描 api 接口所有包路徑，但注入接口仍然報紅

這種情況現(xiàn)在比較少見，但是在一段時間以前出現(xiàn)比較頻繁，主要是在 SpringBoot 2.0 版本后優(yōu)化了相關(guān)邏輯。在 SpringBoot 2.0 之前，如果你的 Feign 接口使用 GetMapping 注解，那么注入該接口都會報紅，無法注入。相應(yīng)的，修改成 RequestMapping 或者 PostMapping 就能注入了。

處理方案：

1、采用合適的注解形式定義 Feign 接口。目前可行的定義方式基本有以下幾種：

@FeignClient("spring-boot-feign-demo")
public interface FeignDemoClient {
? ??
? ? // 使用RequestMapping指定Get方法，入?yún)蝹€傳入
? ? @RequestMapping(value="/demo/list", method=RequestMethod.GET)
? ? public FeignDemoListResponse queryListByCode(@PathVariable("code") String code);
? ? ?
? ? // 使用RequestMapping指定Post方法，傳入實體使用注解@RequestBody
? ? @RequestMapping(value="/demo/detail", method=RequestMethod.POST)
? ? public FeignDemoDetailResponse queryDetail(@RequestBody FeignDemoDetailRequest request);
? ??
? ? // 使用PostMapping，傳入實體使用注解@RequestBody
? ? @PostMapping("/demo/seq")
? ? public FeignDemoSeqResponse querySeq(@RequestBody FeignDemoSeqRequest request);
}

通過 FeignClient 發(fā)起 Get 請求報 405 錯誤

通過在服務(wù)端斷點捕獲異?？梢园l(fā)現(xiàn)，報 405 錯誤的直接原因，其實是因為定義為 Get 的 Feign 接口，接收到 Post 方法的調(diào)用。但是在調(diào)用方調(diào)用時大多數(shù)也是采用 Get 方法，那么到底是什么原因呢？

暫且預(yù)設(shè) Feign 接口的定義如下：

@FeignClient("spring-boot-feign-demo")
public interface FeignDemoClient {
? ? // 服務(wù)方接收到的請求是Post方法，而不是Get方法
? ? @GetMapping(value="/demo/list")
? ? public Response queryList(Request request);

實際上，通過斷點跟蹤接口調(diào)用時的調(diào)用路徑，就會發(fā)現(xiàn) FeignClient 最后是通過 HttpURLConnection 發(fā)起的網(wǎng)絡(luò)連接，在發(fā)起的過程中，Connection 會判斷自身請求的 body 是否為空。如果 body 不為空，則將 Get 方法轉(zhuǎn)換成 Post 方法。因為 body 形式的數(shù)據(jù)只能方法 RequestBody 內(nèi)以流的形式進行傳輸，而根據(jù) Http 協(xié)議 param 形式的數(shù)據(jù)可以直接放在 URL 上進行傳輸和獲取。

之所以 FeignClient 在網(wǎng)絡(luò)請求時會出現(xiàn)這種轉(zhuǎn)換，這跟它的初始化規(guī)則有關(guān)。在項目啟動過程中，@FeignClient 直接的類會被初始化一個動態(tài)代理的類，并通過一個 RequestTemplate.Factory 的工廠類生成請求模板，具體規(guī)則如下：

• 如果基本類型參數(shù)有 @RequestParam 注解，則會將參數(shù)作為 key 放入 RequestTemplate.Factory 中，通過 urlIndex 記錄數(shù)組索引。在進行解析時，通過 key 從數(shù)組中獲取具體的參數(shù)值，拼接在 url 后面。
• 如果參數(shù)沒有任何注解，或者有 @RequestBody 注解，那么初始化時會使用 bodyIndex 維護參數(shù)索引，并通過 bodyType 記錄參數(shù)的具體類型。

需要注意的是，@RequestParam 只能用于對單個基本類型參數(shù)的注解，不能用來注解一個實體類。使用實體類作為入?yún)⒊鰠r，建議還是使用 Post 方法進行請求。

如果在開發(fā)中覺得維護以上的對應(yīng)關(guān)系不方便的話，還有另外一種修改方法可供使用，基本原理就是使用 Apache 的 HTTP Client 替換 Feign 原生的 Http Client，替換后 Get 方法也可以用一個實體類作為請求參數(shù)而不用擔心請求被轉(zhuǎn)換成 Post 方法了。具體修改方式如下：

引入 http client 依賴

<dependency>
? ? <groupId>org.apache.httpcomponents</groupId>
? ? <artifactId>httpclient</artifactId><br> ? ?
? ? <version>4.5.2</version>
</dependency>
<dependency>
? ? <groupId>com.netflix.feign</groupId>
? ? <artifactId>feign-httpclient</artifactId>
? ? <version>8.18.0</version>
</dependency>

開啟 Feign 對 httpClient 的設(shè)置

feign.httpclient.enabled=true

完成配置修改后，內(nèi)部就可以使用 Apache 的 http client。Feign 接口的定義是相同的，但是由于 Get 方法支持了自定義實體類，與 Post 有類似的處理方式，因此參數(shù)的傳輸需要我們額外指定其類型，以確保 JSON 序列化與反序列化的正常進行。

這里給出一個示例接口定義：

@FeignClient("spring-boot-feign-demo")
public interface FeignDemoClient {
? ? @PostMapping(value="/demo/detail", consumes = MediaType.APPLICATION_JSON_VALUE)
? ? public Response<List<ResultDTO>> query(@RequestBody FeignQueryRequest request,?
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?@PathVariable("page") Integer page,?
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?@PathVariable("page_size") Integer pageSize);
}

JSON 反序列化失敗

Error while extracting response for type [com.xxx.xxx.feign] and content type [application/json].Can not deserialize instance of java.util.ArrayList out of START_OBJECT token

翻譯過來的意思大致就是，F(xiàn)eign 接口的返回值無法通過 application/json 的格式解析出來，也就是調(diào)用方返回值的定義就服務(wù)方不一致（結(jié)構(gòu)不同）。

處理方案：

確保雙方引入的接口 api 完全一致，可通過將接口所在模塊打包成 jar 包，雙方引用同一個 jar 等方式以保證接口定義一致。

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論