干掉 Feign,Spring Cloud Square 組件發布

Spring Cloud Square 是什么

談起 Spring Cloud 生態大家一定對 Feign 不陌生，如下圖所示，Feign 可以把底層（okhttp、httpclient）Rest 的請求進行隱藏，偽裝成類似 SpringMVC 的 Controller 一樣。你不用再自己拼接 url，拼接參數等等操作，一切都交給 Feign 去做。使用 Feign 調用 API 就像調用本地方法一樣，從避免了調用目標微服務時，需要不斷的解析/封裝 json 數據的繁瑣。

Spring Cloud Square 項目旨在替代原有的 Spring Cloud Feign , 借助 Retrofit 對底層通信類庫的封裝實現跨服務調用，目前已在 spring-cloud-incubator 孵化器進行孵化 （上一個在孵化器孵化 spring-cloud-loadbalancer 已經正式接替 Ribbon 成為正式推薦組件）。

在了解 Spring Cloud Square 之前，需要先了解以下組件：

• OkHttp 是一個關於網絡請求的第三方類庫，其中封裝了網絡請求的 get、post 等操作的底層實現，是目前最為火熱的網絡請求框架之一。

• Retrofit 是一個 RESTful 的 HTTP 網絡請求框架，它是基於 OkHttp 的。它是通過注解配置網絡參數的，支持多種數據的解析和序列化（Gson、Json、Xml 等，並且對 RxJava 也是支持的。

那么基於 Spring Cloud Square 的服務調用可以抽象成如下圖所示：

快速上手

添加依賴

• 由於目前 spring-cloud-square 未正式發布，需要配置 spring maven 倉庫。

<repositories>
  <repository>
    <id>spring-milestones</id>
    <url>https://repo.spring.io/milestone</url>
  </repository>
</repositories>

• maven 依賴

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-square-okhttp</artifactId>
  <version>${square.version}</version>
</dependency>
<dependency>
  <groupId>com.squareup.okhttp3</groupId>
  <artifactId>okhttp</artifactId>
  <version>${okhttp.version}</version>
</dependency>

<!--添加負載均衡支持-->
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>

代碼配置

@Bean
@LoadBalanced
public OkHttpClient.Builder okHttpClientBuilder() {
    return new OkHttpClient.Builder();
}

代碼調用

• 和最早的 ribbon 調用一樣，非常的簡單。

@Autowired
OkHttpClient.Builder builder;

@GetMapping
public String req() {
    Request request = new Request.Builder()
            .url("http://square-provider/req").build();
    Response response = builder.build().newCall(request).execute();
    return response.body().string();
}

進階使用

作為 Spring Cloud Feign 的替代品，square 也支持聲明式客戶端的形式。注意看以下代碼 和 feign 一樣的味道

添加依賴

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-square-retrofit</artifactId>
  <version>${square.version}</version>
</dependency>

聲明調用客戶端

@RetrofitClient("square-provider")
public interface DemoService {

    @GET("/")
    Call<String> req();
}

開啟客戶端掃描

@EnableRetrofitClients

代碼調用

@Autowired
DemoService demoService;

@SneakyThrows
@GetMapping("/retrofit")
public String retrofit(){
    return demoService.req().execute().body();
}

總結

• 1. 由於 spring-cloud-square 直接基於 retrofit 實現，整體源碼非常的簡單，推薦大家一讀。
• 2. 目前版本暫未實現 fallback 相關的實現。
• 3. 本文的配套代碼 https://github.com/lltx/spring-cloud-square-demo