Merge branch 'feature/p0' into 'integration_2025-04-24_877340287234'

feat: [development task] core-p0 (1181096)

See merge request iaasng/volcengine-java-sdk!456

Author: BitsAdmin

README.md

@@ -8,8 +8,7 @@
 * Note
 
 ### Requirements ###
-
-运行 SDK需要jdk **Java 1.7+**. 你可以下载最新的版本： http://developers.sun.com/downloads/.
+运行 SDK需要jdk **Java 1.8.0_131+**. 你可以下载最新的版本： http://developers.sun.com/downloads/.
 如果 SDK版本 高于或者等于 **Java 9** 请依赖javax.annotation-api
 由于在高于或者等于 **Java 9** 中 javax.annotation-api 被移除
 

volcengine-java-sdk-core/src/main/java/com/volcengine/ApiClient.java

@@ -19,6 +19,10 @@
 import com.squareup.okhttp.logging.HttpLoggingInterceptor;
 import com.squareup.okhttp.logging.HttpLoggingInterceptor.Level;
 import com.volcengine.auth.Authentication;
+import com.volcengine.auth.CredentialProvider;
+import com.volcengine.endpoint.DefaultEndpointProvider;
+import com.volcengine.endpoint.EndpointResolver;
+import com.volcengine.interceptor.*;
 import com.volcengine.model.AbstractResponse;
 import com.volcengine.model.ResponseMetadata;
 import com.volcengine.sign.Credentials;
@@ -84,14 +88,27 @@ public class ApiClient {
 
     private Credentials credentials;
     private String region;
-    private String endpoint = "open.volcengineapi.com";
+    private String endpoint;
     private boolean disableSSL = false;
 
+    private InterceptorChain interceptorChain = new InterceptorChain();
+
+    private EndpointResolver endpointResolver;
+
+    private CredentialProvider credentialProvider;
+
+    private Integer maxIdleConns = 5;
+
+    private Integer keepAliveDurationMs = 5 * 60 * 1000;
+
+
     /*
      * Constructor for ApiClient
      */
     public ApiClient() {
+        ConnectionPool connectionPool=new ConnectionPool(maxIdleConns,keepAliveDurationMs);
         httpClient = new OkHttpClient();
+        httpClient.setConnectionPool(connectionPool);
 
 
         verifyingSsl = true;
@@ -106,6 +123,13 @@ public ApiClient() {
         authentications.put(DefaultAuthentication, new VolcstackSign());
         // Prevent the authentications from being modified.
         authentications = Collections.unmodifiableMap(authentications);
+        endpointResolver = new DefaultEndpointProvider();
+
+        interceptorChain.appendRequestInterceptor(new ResolveEndpointInterceptor());
+        interceptorChain.appendRequestInterceptor(new BuildRequestInterceptor());
+        interceptorChain.appendRequestInterceptor(new SignRequestInterceptor());
+
+        interceptorChain.appendResponseInterceptor(new DeserializedResponseInterceptor());
     }
 
     /**
@@ -891,10 +915,24 @@ public <T> ApiResponse<T> execute(Call call) throws ApiException {
      * @throws ApiException If fail to execute the call
      */
     public <T> ApiResponse<T> execute(Call call, final Type returnType, boolean... isCommon) throws ApiException {
+        if (!(call instanceof InterceptorContext)) {
+            throw new ApiException("not support custom context class");
+        }
+        InterceptorContext context = (InterceptorContext) call;
+        ResponseInterceptorContext responseInterceptorContext = new ResponseInterceptorContext();
+        responseInterceptorContext.setCommon(isCommon.length > 0 && isCommon[0]);
+        responseInterceptorContext.setReturnType(returnType);
+        context.setResponseContext(responseInterceptorContext);
+
+        context.setApiClient(this);
+
         try {
-            Response response = call.execute();
-            T data = handleResponse(response, returnType, isCommon);
-            return new ApiResponse<T>(response.code(), response.headers().toMultimap(), data);
+            this.interceptorChain.executeRequest(context);
+            Call finalCall = context.requestContext.getCall();
+            Response response = finalCall.execute();
+            context.getResponseContext().setOriginalResponse(response);
+            this.interceptorChain.executeResponse(context);
+            return new ApiResponse<T>(response.code(), response.headers().toMultimap(), (T) context.getResponseContext().getData());
         } catch (IOException e) {
             throw new ApiException(e);
         }
@@ -922,7 +960,23 @@ public <T> void executeAsync(Call call, ApiCallback<T> callback) {
      */
     @SuppressWarnings("unchecked")
     public <T> void executeAsync(Call call, final Type returnType, final ApiCallback<T> callback) {
-        call.enqueue(new Callback() {
+        if (!(call instanceof InterceptorContext)) {
+            callback.onFailure(new ApiException("not support custom context class"), 0, null);
+            return;
+        }
+        final InterceptorContext context = (InterceptorContext) call;
+        ResponseInterceptorContext responseInterceptorContext = new ResponseInterceptorContext();
+        responseInterceptorContext.setReturnType(returnType);
+        context.setResponseContext(responseInterceptorContext);
+
+        context.setApiClient(this);
+        try {
+            this.interceptorChain.executeRequest(context);
+        } catch (ApiException e) {
+            callback.onFailure(e, 0, null);
+            return;
+        }
+        Callback okHttpCallBack = new Callback() {
             @Override
             public void onFailure(Request request, IOException e) {
                 callback.onFailure(new ApiException(e), 0, null);
@@ -932,14 +986,18 @@ public void onFailure(Request request, IOException e) {
             public void onResponse(Response response) throws IOException {
                 T result;
                 try {
-                    result = (T) handleResponse(response, returnType);
+                    context.getResponseContext().setOriginalResponse(response);
+                    context.getApiClient().interceptorChain.executeResponse(context);
+                    result = (T) context.responseContext.getData();
                 } catch (ApiException e) {
                     callback.onFailure(e, response.code(), response.headers().toMultimap());
                     return;
                 }
                 callback.onSuccess(result, response.code(), response.headers().toMultimap());
             }
-        });
+        };
+
+        ((InterceptorContext) call).getRequestContext().getCall().enqueue(okHttpCallBack);
     }
 
     /**
@@ -998,20 +1056,33 @@ public <T> T handleResponse(Response response, Type returnType, boolean... isCom
      * @return The HTTP call
      * @throws ApiException If fail to serialize the request body object
      */
-    public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener, boolean... isCommon) throws ApiException {
-        Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener, isCommon);
-
-        return httpClient.newCall(request);
-    }
-
-    private void getDefaultContentType(Map<String, String> headerParams) {
+    public InterceptorContext buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener, boolean... isCommon) throws ApiException {
+        InterceptorContext interceptorContext = new InterceptorContext(this.httpClient, null);
+        InitInterceptorContext requestInterceptorContext = new InitInterceptorContext.Builder()
+                .path(path)
+                .method(method)
+                .queryParams(queryParams)
+                .collectionQueryParams(collectionQueryParams)
+                .body(body)
+                .headerParams(headerParams)
+                .formParams(formParams)
+                .authNames(authNames)
+                .progressRequestListener(progressRequestListener)
+                .isCommon(isCommon.length > 0 && isCommon[0])
+                .build();
+        interceptorContext.setInitInterceptorContext(requestInterceptorContext);
+        interceptorContext.setApiClient(this);
+        return interceptorContext;
+    }
+
+    public void getDefaultContentType(Map<String, String> headerParams) {
         String contentType = headerParams.get("Content-Type");
         if (contentType == null) {
             headerParams.put("Content-Type", "text/plain");
         }
     }
 
-    private boolean isApplicationJsonBody(Map<String, String> headerParams) {
+    public boolean isApplicationJsonBody(Map<String, String> headerParams) {
         String contentType = headerParams.get("Content-Type");
         if (contentType == null) {
             return false;
@@ -1022,7 +1093,7 @@ private boolean isApplicationJsonBody(Map<String, String> headerParams) {
         return false;
     }
 
-    private boolean isPostBody(Map<String, String> headerParams) {
+    public boolean isPostBody(Map<String, String> headerParams) {
         String contentType = headerParams.get("Content-Type");
         if (contentType == null) {
             return false;
@@ -1033,12 +1104,12 @@ private boolean isPostBody(Map<String, String> headerParams) {
         return false;
     }
 
-    private void updateQueryParams(List<Pair> queryParams, String[] param) {
+    public void updateQueryParams(List<Pair> queryParams, String[] param) {
         queryParams.add(new Pair("Action", param[1]));
         queryParams.add(new Pair("Version", param[2]));
     }
 
-    private ServiceInfo addPairAndGetServiceInfo(String path, List<Pair> queryParams, Map<String, String> headerParams) {
+    public ServiceInfo addPairAndGetServiceInfo(String path, List<Pair> queryParams, Map<String, String> headerParams) {
         String[] param = path.split("/");
 
         if (param.length >= 6) {
@@ -1053,7 +1124,7 @@ private ServiceInfo addPairAndGetServiceInfo(String path, List<Pair> queryParams
 
     }
 
-    private String getTruePath(String path, Map<String, String> headerParams) {
+    public String getTruePath(String path, Map<String, String> headerParams) {
         if (isApplicationJsonBody(headerParams) || isPostBody(headerParams)) {
             String[] param = path.split("/");
             return "/?Action=" + param[1] + "&Version=" + param[2];
@@ -1088,7 +1159,7 @@ private boolean convertResponseBody(String source, StringBuilder stringBuilder,
         return false;
     }
 
-    private void buildSimpleRequest(Object body, List<Pair> queryParams, Map<String, String> headerParams, StringBuilder builder, FormEncodingBuilder formBuilder, String chain, boolean... isCommon) throws Exception {
+    public void buildSimpleRequest(Object body, List<Pair> queryParams, Map<String, String> headerParams, StringBuilder builder, FormEncodingBuilder formBuilder, String chain, boolean... isCommon) throws Exception {
         if (body == null) {
             return;
         }
@@ -1352,6 +1423,25 @@ public String buildUrl(String path, List<Pair> queryParams, List<Pair> collectio
         return url.toString();
     }
 
+    public void buildQueryParams(String path, StringBuilder url, List<Pair> queryParams) {
+        if (queryParams != null && !queryParams.isEmpty()) {
+            // support (constant) query string in `path`, e.g. "/posts?draft=1"
+            String prefix = path.contains("?") ? "&" : "?";
+            for (Pair param : queryParams) {
+                if (param.getValue() != null) {
+                    if (prefix != null) {
+                        url.append(prefix);
+                        prefix = null;
+                    } else {
+                        url.append("&");
+                    }
+                    String value = parameterToString(param.getValue());
+                    url.append(escapeString(param.getName())).append("=").append(escapeString(value));
+                }
+            }
+        }
+    }
+
     /**
      * Set header parameters to the request builder, including default headers.
      *
@@ -1369,6 +1459,14 @@ public void processHeaderParams(Map<String, String> headerParams, Request.Builde
         }
     }
 
+    public void processDefaultHeader(Map<String, String> headerParams) {
+        for (Entry<String, String> header : defaultHeaderMap.entrySet()) {
+            if (!headerParams.containsKey(header.getKey())) {
+                headerParams.put(header.getKey(), parameterToString(header.getValue()));
+            }
+        }
+    }
+
     /**
      * Update query and header parameters based on authentication settings.
      *
@@ -1522,6 +1620,7 @@ public boolean verify(String hostname, SSLSession session) {
         }
     }
 
+
     private KeyStore newEmptyKeyStore(char[] password) throws GeneralSecurityException {
         try {
             KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
@@ -1531,4 +1630,43 @@ private KeyStore newEmptyKeyStore(char[] password) throws GeneralSecurityExcepti
             throw new AssertionError(e);
         }
     }
+
+    public CredentialProvider getCredentialProvider() {
+        return credentialProvider;
+    }
+
+    public ApiClient setCredentialProvider(CredentialProvider credentialProvider) {
+        this.credentialProvider = credentialProvider;
+        return this;
+    }
+
+    public EndpointResolver getEndpointResolver() {
+        return endpointResolver;
+    }
+
+    public ApiClient setEndpointResolver(EndpointResolver endpointResolver) {
+        this.endpointResolver = endpointResolver;
+        return this;
+    }
+
+
+    public Integer getMaxIdleConns() {
+        return maxIdleConns;
+    }
+
+    public ApiClient setMaxIdleConns(Integer maxIdleConns) {
+        this.maxIdleConns = maxIdleConns;
+        this.httpClient.setConnectionPool(new ConnectionPool(maxIdleConns,keepAliveDurationMs));
+        return this;
+    }
+
+    public Integer getKeepAliveDurationMs() {
+        return keepAliveDurationMs;
+    }
+
+    public ApiClient setKeepAliveDurationMs(Integer keepAliveDurationMs) {
+        this.keepAliveDurationMs = keepAliveDurationMs;
+        this.httpClient.setConnectionPool(new ConnectionPool(maxIdleConns,keepAliveDurationMs));
+        return this;
+    }
 }

volcengine-java-sdk-core/src/main/java/com/volcengine/auth/CredentialProvider.java

@@ -0,0 +1,40 @@
+package com.volcengine.auth;
+
+import com.volcengine.ApiException;
+
+import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReadWriteLock;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
+
+public class CredentialProvider {
+    private Provider provider;
+
+    private ReadWriteLock readWriteLock;
+
+    public CredentialProvider(Provider provider) {
+        this.provider = provider;
+        readWriteLock = new ReentrantReadWriteLock();
+    }
+
+    public CredentialValue get() throws ApiException {
+        try {
+            readWriteLock.readLock().lock();
+            if (!provider.isExpired()) {
+                return provider.retrieve();
+            }
+        } finally {
+            readWriteLock.readLock().unlock();
+        }
+
+        try {
+            readWriteLock.writeLock().lock();
+            if (provider.isExpired()) {
+                provider.refresh();
+            }
+            return provider.retrieve();
+
+        } finally {
+            readWriteLock.writeLock().unlock();
+        }
+    }
+}