Java | 使用OpenFeign管理多個第三方服務呼叫

Ygria發表於2021-04-28
Java

背景

最近開發了一個統一排程類的專案，需要依賴多個第三方服務，這些服務都提供了HTTP介面供我呼叫。

元件架構

服務多、介面多，如何進行第三方服務管理和呼叫就成了問題。

常用的服務間呼叫往往採用zk、Eureka等註冊中心進行服務管理（SpringBoot常使用SpringCloud）。OpenFeign也是SpringCloud的解決方案之一。我們單獨使用OpenFeign， 無需對原有第三方服務進行改動，本服務開發時的引入也很輕量。

下面給出我的用法。

應用

maven依賴

引入maven依賴：

       <dependency>
           <groupId>io.github.openfeign</groupId>
           <artifactId>feign-core</artifactId>
           <version>10.2.3</version>
       </dependency>
       <dependency>
           <groupId>io.github.openfeign</groupId>
           <artifactId>feign-gson</artifactId>
           <version>10.2.3</version>
       </dependency>
       <dependency>
           <groupId>io.github.openfeign.form</groupId>
           <artifactId>feign-form</artifactId>
           <version>3.8.0</version>
       </dependency>
       <dependency>
           <groupId>io.github.openfeign.form</groupId>
           <artifactId>feign-form-spring</artifactId>
           <version>3.8.0</version>
       </dependency>

其中，form相關引入是為了解決ContentType為application/x-www-form-urlencoded和multipart/form-data的編碼問題。

配置和服務宣告

第三方服務的地址通過配置來注入。

服務地址配置

ThirdpartServiceConfig.java

@Data
@Component
@ConfigurationProperties(prefix = "thirdpart-service")
public class ThirdpartServiceConfig {
    private String serviceA;
    private String serviceB;
    private String serviceC;
}

服務配置（超時時間配置等也可以寫在這裡）
application.yaml

thirdpart-service:
  serviceA: http://****:***/
  serviceB:  http://****:***/
  serviceC:  http://****:***/

第三方服務配置

因為宣告方法一致，所以省略了多個第三方宣告。
ThirdPartClientConfig.java

@Configuration
public class ThirdParttClientConfig {

    @Resource
    private ThirdpartServiceConfig thirdpartServiceConfig;

    @Bean
    public ServiceAClient serviceAClient() {
        return Feign.builder()
            .encoder(new FormEncoder(new GsonEncoder()))
            .decoder(new GsonDecoder())
            .target(ServiceAClient.class, thirdpartServiceConfig.getServiceA());
    }
}

介面宣告和使用

完成了服務的宣告和服務的配置之後，就可以進行服務介面的宣告瞭。具體宣告方法可以參看OpenFeign文件：[# 翻譯: Spring Cloud Feign使用文件
](https://segmentfault.com/a/1190000018313243?utm_source=tag-newest)
下面給出使用示例:

  • GET請求（feign可直接將返回的結果反序列化為本服務中定義的POJO）
@RequestLine("GET testGet?a={a}&b={b}")
ServiceResp testGet(@Param("a") String a,@Param("b")String b);
  • GET 下載
    使用feign.Response接收請求結果
@RequestLine("GET export?exportId={exportId}")
Response exportFromServiceA(@Param("exportId")String exportId);

@Resource
private ServiceAClient serviceAClient ;

// 匯出方法
public void export(exportId) {
    Response serviceResponse = serviceserviceAClient.exportFromServiceA(exportId);
    Response.Body body = serviceResponse.body();
    try(InputStream inputStream = body.asInputStream();
        // 處理獲取到的inputStream
    } catch (IOException e) {
    log.error("匯出發生異常",e);
}
  • POST application/json"
 @RequestLine("POST /save")
 @Headers("Cofntent-Type: application/json")
  ServiceResp saveEntity(EntityPOJO entityPOJO);
  • POST form
 @RequestLine("POST  uqa/repo/qa/batch")
 @Headers("Content-Type:multipart/form-data")
 ServiceResp uploadFile(@Param("id")String id, @Param("batch_file") File file);
  • 注意：除了file型別，其他引數會被序列化為String，所以若第三方介面引數的值為POJO（或Map），可能會出錯。
  • 對於POJO引數，若第三方引數名含有Java中不合法的屬性字元（如 ”-“，”#“，”.“等），可使用註解進行序列化時的轉化。由於宣告Feign Client時使用的encoder是Gson，所以使用如下註解：
 @SerializedName(value="aaa-bbb")
 private String aaaBbb;

如果使用的是其他序列化工具，改為對應的註解即可。

小結

使用宣告式的第三方和介面寫法，基本覆蓋了請求第三方介面的需求，也易於擴充和管理。
我計劃在後續新增統一的鑑權、日誌列印和異常捕獲處理功能，使依賴元件引入的風險更為可控。OpenFeign幫我們實現了服務宣告、介面宣告、HTTP請求傳送和結果處理等邏輯，在專案需要呼叫多個第三方服務時可以使用。

相關文章