Merge pull request #26 from vikadata/feature-add-okhttp

feat: add okhttp callTimeout and writeTimeout

Author: BronLau

client/src/main/java/cn/vika/client/api/AttachmentApi.java

@@ -29,6 +29,7 @@
 import cn.vika.client.api.http.ApiHttpClient;
 import cn.vika.client.api.model.Attachment;
 import cn.vika.client.api.model.HttpResult;
+import cn.vika.core.exception.HttpClientException;
 import cn.vika.core.http.FormDataMap;
 import cn.vika.core.http.GenericTypeReference;
 import cn.vika.core.http.HttpHeader;
@@ -69,7 +70,11 @@ public Attachment upload(String datasheetId, File file) throws ApiException {
     public Attachment upload(String datasheetId, FormDataMap formData) throws ApiException {
         HttpHeader httpHeader = new HttpHeader();
         httpHeader.setContentType(HttpMediaType.MULTIPART_FORM_DATA);
-        HttpResult<Attachment> result = getDefaultHttpClient().post(String.format(PATH, datasheetId), httpHeader, formData, new GenericTypeReference<HttpResult<Attachment>>() {});
-        return result.getData();
+        try {
+            HttpResult<Attachment> result = getDefaultHttpClient().post(String.format(PATH, datasheetId), httpHeader, formData, new GenericTypeReference<HttpResult<Attachment>>() {});
+            return result.getData();
+        } catch (HttpClientException e) {
+            throw new HttpClientException("timeout retry", e);
+        }
     }
 }

client/src/main/java/cn/vika/client/api/VikaApiClient.java

@@ -131,6 +131,44 @@ public VikaApiClient withReadTimeout(Integer readTimeout) {
         return this;
     }
 
+    /**
+     * Sets the per request write timeout.
+     *
+     * @param writeTimeout the per request read timeout in milliseconds, can be null to use default
+     */
+    public void setWriteTimeout(Integer writeTimeout) {
+        this.apiHttpClient.setWriteTimeout(writeTimeout);
+    }
+
+    /**
+     * Build method that sets the per request write timeout.
+     * @param writeTimeout the per request write timeout in milliseconds, can be null to use default
+     * @return VikaApiClient instance
+     */
+    public VikaApiClient withWriteTimeout(Integer writeTimeout) {
+        apiHttpClient.setWriteTimeout(writeTimeout);
+        return this;
+    }
+
+    /**
+     * Sets the per request call timeout.
+     *
+     * @param callTimeout the per request call timeout in milliseconds, can be null to use default
+     */
+    public void setCallTimeout(Integer callTimeout) {
+        this.apiHttpClient.setCallTimeout(callTimeout);
+    }
+
+    /**
+     * Build method that sets the per request call timeout.
+     * @param callTimeout the per request call timeout in milliseconds, can be null to use default
+     * @return VikaApiClient instance
+     */
+    public VikaApiClient withCallTimeout(Integer callTimeout) {
+        apiHttpClient.setCallTimeout(callTimeout);
+        return this;
+    }
+
     public RecordApi getRecordApi() {
         if (this.recordApi == null) {
             synchronized (this) {

client/src/main/java/cn/vika/client/api/http/ApiHttpClient.java

@@ -50,6 +50,10 @@ public String getApiNamespace() {
 
     public static final int DEFAULT_READ_TIMEOUT = 60000;
 
+    public static final int DEFAULT_CALL_TIMEOUT = 60000;
+
+    public static final int DEFAULT_WRITE_TIMEOUT = 60000;
+
     private final DefaultHttpClient defaultHttpClient;
 
     private int defaultPerPage = DEFAULT_PER_PAGE;
@@ -58,6 +62,10 @@ public String getApiNamespace() {
 
     private Integer readTimeout = DEFAULT_READ_TIMEOUT;
 
+    private Integer writeTimeout = DEFAULT_WRITE_TIMEOUT;
+
+    private Integer callTimeout = DEFAULT_CALL_TIMEOUT;
+
     public ApiHttpClient(ApiVersion apiVersion, String baseUrl, ApiCredential apiCredential) {
         baseUrl += apiVersion.getApiNamespace();
         this.defaultHttpClient = new DefaultHttpClient(baseUrl);
@@ -81,6 +89,10 @@ public void setReadTimeout(Integer readTimeout) {
         this.readTimeout = readTimeout;
     }
 
+    public void setWriteTimeout(Integer writeTimeout){ this.writeTimeout = writeTimeout; }
+
+    public void setCallTimeout(Integer callTimeout){ this.callTimeout = callTimeout; }
+
     public void setDefaultPerPage(int defaultPerPage) {
         this.defaultPerPage = defaultPerPage;
     }
@@ -105,6 +117,23 @@ public DefaultHttpClient getDefaultHttpClient() {
                 ((OkHttpClientHttpRequestFactory) requestFactory).setReadTimeout(readTimeout);
             }
         }
+
+        if (writeTimeout != null) {
+            // Sets the per request write timeout.
+            ClientHttpRequestFactory requestFactory = this.defaultHttpClient.getRequestFactory();
+            if (requestFactory instanceof OkHttpClientHttpRequestFactory) {
+                ((OkHttpClientHttpRequestFactory) requestFactory).setWriteTimeout(writeTimeout);
+            }
+        }
+
+        if (callTimeout != null) {
+            // Sets the per request call timeout.
+            ClientHttpRequestFactory requestFactory = this.defaultHttpClient.getRequestFactory();
+            if (requestFactory instanceof OkHttpClientHttpRequestFactory) {
+                ((OkHttpClientHttpRequestFactory) requestFactory).setCallTimeout(callTimeout);
+            }
+        }
+
         return this.defaultHttpClient;
     }
 }

core/src/main/java/cn/vika/core/http/OkHttpClientHttpRequestFactory.java

@@ -72,6 +72,26 @@ public void setConnectTimeout(int connectTimeout) {
                 .build();
     }
 
+    /**
+     * Set call timeout in milliseconds.
+     * @param callTimeout call timeout
+     */
+    public void setCallTimeout(int callTimeout){
+        this.client = this.client.newBuilder()
+            .callTimeout(callTimeout, TimeUnit.MICROSECONDS)
+            .build();
+    }
+
+    /**
+     * Set write timeout in milliseconds.
+     * @param writeTimeout write timeout
+     */
+    public void setWriteTimeout(int writeTimeout){
+        this.client = this.client.newBuilder()
+            .writeTimeout(writeTimeout, TimeUnit.MILLISECONDS)
+            .build();
+    }
+
     @Override
     public ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod) {
         return new OkHttpClientRequest(this.client, uri, httpMethod);