com.taobao.api.internal.feature.BatchFeature Maven / Gradle / Ivy
The newest version!
package com.taobao.api.internal.feature;
import com.taobao.api.*;
import com.taobao.api.internal.parser.json.ObjectJsonParser;
import com.taobao.api.internal.parser.xml.ObjectXmlParser;
import com.taobao.api.internal.util.*;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 批量调用特性
*/
public abstract class BatchFeature {
public static final String BATCH_API_HEADER_SPLIT = "top-api-separator"; // 批量API用户自定义分隔符Header Key
public static final String BATCH_API_PUBLIC_PARAMETER = "#PUBLIC#"; // 批量API公共参数头
public static final String BATCH_API_DEFAULT_SPLIT = "\r\n-S-\r\n";// 批量API默认分隔符
private String batchServerUrl;
private String batchApiSeparator; // 自定义批量API分隔符
private DefaultTaobaoClient client;
public void init(String batchServerUrl, final DefaultTaobaoClient client) {
this.batchServerUrl = batchServerUrl;
this.client = client;
}
public T execute(TaobaoRequest request, String session) throws ApiException {
if (request instanceof TaobaoBatchRequest) {
return _execute(request, session);
} else {
return clientExecute(request, session);
}
}
@SuppressWarnings({ "unchecked", "rawtypes" })
private T _execute(TaobaoRequest tRequest, String session) throws ApiException {
TaobaoBatchRequest batchRequest = (TaobaoBatchRequest) tRequest;
long start = System.currentTimeMillis();
List> requestList = batchRequest.getRequestList();
if (requestList == null || requestList.isEmpty()) {
throw new ApiException("40", "client-error:api request list is empty");
}
// 本地校验请求参数
if (client.isNeedCheckRequest() && batchRequest.getPublicParams().isEmpty()) {
for (int i = 0; i < requestList.size(); i++) {
try {
requestList.get(i).check();
} catch (ApiRuleException e) {
return (T) new TaobaoBatchResponse(e.getErrCode(), "API NO. " + (i + 1) + ": " + e.getErrMsg());
}
}
}
// 添加协议级请求参数
RequestParametersHolder requestHolder = new RequestParametersHolder();
TaobaoHashMap protocalMustParams = new TaobaoHashMap();
protocalMustParams.put(Constants.VERSION, "2.0");
protocalMustParams.put(Constants.APP_KEY, client.getAppKey());
Long timestamp = batchRequest.getTimestamp();
if (timestamp == null) {
timestamp = System.currentTimeMillis();
}
protocalMustParams.put(Constants.TIMESTAMP, new Date(timestamp));
requestHolder.setProtocalMustParams(protocalMustParams);
TaobaoHashMap protocalOptParams = new TaobaoHashMap();
protocalOptParams.put(Constants.FORMAT, client.getFormat());
protocalOptParams.put(Constants.SIGN_METHOD, client.getSignMethod());
protocalOptParams.put(Constants.SESSION, session);
protocalOptParams.put(Constants.PARTNER_ID, client.getSdkVersion());
protocalOptParams.put(Constants.TARGET_APP_KEY, batchRequest.getTargetAppKey());
if (Constants.FORMAT_JSON.equals(client.getFormat()) && client.isUseSimplifyJson()) {
protocalOptParams.put(Constants.SIMPLIFY, Boolean.TRUE.toString());
}
requestHolder.setProtocalOptParams(protocalOptParams);
// 添加自定义分隔符
String separator = BATCH_API_DEFAULT_SPLIT;
if (batchApiSeparator != null) {
batchRequest.putHeaderParam(BATCH_API_HEADER_SPLIT, separator = batchApiSeparator);
}
// 是否需要压缩响应
if (client.isUseGzipEncoding()) {
batchRequest.putHeaderParam(Constants.ACCEPT_ENCODING, Constants.CONTENT_ENCODING_GZIP);
}
try {
// 添加公共请求头
if (batchRequest.getPublicMethod() != null) {
batchRequest.addPublicParam(Constants.METHOD, batchRequest.getPublicMethod());
} else {
if (isSameRequest(requestList)) {
batchRequest.addPublicParam(Constants.METHOD, requestList.get(0).getApiMethodName());
}
}
// 构建批量请求主体
StringBuilder requestBody = new StringBuilder();
String publicParamStr = WebUtils.buildQuery(batchRequest.getPublicParams(), Constants.CHARSET_UTF8);
if (!StringUtils.isEmpty(publicParamStr)) {
requestBody.append(BATCH_API_PUBLIC_PARAMETER).append(publicParamStr).append(separator);
}
// 组装每个API的请求参数
for (int i = 0; i < requestList.size(); i++) {
TaobaoRequest request = requestList.get(i);
request.setBatchApiOrder(i);
Map apiParams = request.getTextParams();
// 如果单个API的方法和批量API的公共方法不一致，那么需要设置单个API的方法名称
if (request.getApiMethodName() != null && !request.getApiMethodName().equals(batchRequest.getPublicMethod())) {
apiParams.put(Constants.METHOD, request.getApiMethodName());
}
if (request.getBatchApiSession() != null) {
apiParams.put(Constants.SESSION, request.getBatchApiSession());
}
if (request.getTargetAppKey() != null) {
apiParams.put(Constants.TARGET_APP_KEY, request.getTargetAppKey());
}
String apiParamStr = WebUtils.buildQuery(apiParams, Constants.CHARSET_UTF8);
if (StringUtils.isEmpty(apiParamStr)) {
apiParamStr = "N";
}
requestBody.append(apiParamStr);
if (i != (requestList.size() - 1)) {
requestBody.append(separator);
}
}
String apiBody = requestBody.toString();
// 添加签名参数
protocalMustParams.put(Constants.SIGN, TaobaoUtils.signTopRequestWithBody(requestHolder, apiBody, client.getAppSecret(), client.getSignMethod()));
// 发起批量请求
String sysMustQuery = WebUtils.buildQuery(requestHolder.getProtocalMustParams(), Constants.CHARSET_UTF8);
String sysOptQuery = WebUtils.buildQuery(requestHolder.getProtocalOptParams(), Constants.CHARSET_UTF8);
String fullUrl = WebUtils.buildRequestUrl(this.batchServerUrl, sysMustQuery, sysOptQuery);
HttpResponseData data = WebV2Utils.doPost(fullUrl, apiBody, Constants.CHARSET_UTF8, client.getConnectTimeout(), client.getReadTimeout(), batchRequest.getHeaderMap());
requestHolder.setResponseBody(data.getBody());
} catch (IOException e) {
TaobaoLogger.logApiError(client.getAppKey(), "BatchApi", batchServerUrl, requestHolder.getAllParams(), System.currentTimeMillis() - start, e.toString());
throw new ApiException(e);
}
// 构造响应解释器
List> parserList = new ArrayList>();
if (client.isNeedEnableParser()) {
if (Constants.FORMAT_XML.equals(client.getFormat())) {
for (int i = 0; i < requestList.size(); i++) {
parserList.add(new ObjectXmlParser(requestList.get(i).getResponseClass()));
}
} else {
for (int i = 0; i < requestList.size(); i++) {
parserList.add(new ObjectJsonParser(requestList.get(i).getResponseClass(), client.isUseSimplifyJson()));
}
}
}
TaobaoBatchResponse batchResponse = new TaobaoBatchResponse();
batchResponse.setBody(requestHolder.getResponseBody());
String[] responseArray = batchResponse.getBody().split(separator);
// 批量API在走单通道验证时没通过，如前面验证，此时只有一个报错信息
if (responseArray.length > 0 && responseArray.length != requestList.size()) {
if (client.isNeedEnableParser()) {
TaobaoResponse tRsp = (TaobaoResponse) parserList.get(0).parse(responseArray[0], Constants.RESPONSE_TYPE_TOP);
batchResponse.setErrorCode(tRsp.getErrorCode());
batchResponse.setMsg(tRsp.getMsg());
batchResponse.setSubCode(tRsp.getSubCode());
batchResponse.setSubMsg(tRsp.getSubMsg());
} else {
batchResponse.setMsg("batch api call fail");
}
return (T) batchResponse;
}
for (int i = 0; i < responseArray.length; i++) {
TaobaoResponse tRsp = null;
if (client.isNeedEnableParser()) {
tRsp = (TaobaoResponse) parserList.get(i).parse(responseArray[i], Constants.RESPONSE_TYPE_TOP);
tRsp.setBody(responseArray[i]);
} else {
try {
tRsp = requestList.get(i).getResponseClass().newInstance();
tRsp.setBody(responseArray[i]);
} catch (Exception e) {
throw new ApiException(e);
}
}
tRsp.setParams(requestList.get(i).getTextParams());
batchResponse.addResponse(tRsp);
}
if (!batchResponse.isSuccess()) {
TaobaoLogger.logApiError(client.getAppKey(), "BatchApi", batchServerUrl, requestHolder.getAllParams(), System.currentTimeMillis() - start, batchResponse.getBody());
}
return (T) batchResponse;
}
/**
* 判断批量API请求是否全部请求同一种类型的API。
*/
private boolean isSameRequest(List> requestList) {
if (requestList != null && requestList.size() > 1) { // 只有两个或以上的请求才考虑合并
String firstMethod = requestList.get(0).getApiMethodName();
for (int i = 1; i < requestList.size(); i++) {
String currentMethod = requestList.get(i).getApiMethodName();
if (!firstMethod.equals(currentMethod)) {
return false;
}
}
}
return true;
}
/**
* 设置批量API请求的自定义分隔符。
*/
public void setBatchApiSeparator(String batchApiSeparator) {
this.batchApiSeparator = batchApiSeparator;
}
public String getBatchServerUrl() {
return batchServerUrl;
}
public void setBatchServerUrl(String batchServerUrl) {
this.batchServerUrl = batchServerUrl;
}
public abstract T clientExecute(TaobaoRequest request, String session) throws ApiException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy