feat: 图片上传 (#18)

* feat: 图片上传支持

BREAKING CHANGE: Credentials.getToken(request)，参数改为使用HttpRequestWrapper

refactor: SignatureExec.convertToRepeatableXXXEntity 使用BufferedHttpEntity

* update version to 0.2.0

Author: xy-peng

README.md

@@ -8,11 +8,11 @@
 
 ## 项目状态
 
-当前版本`0.1.6`为测试版本。请商户的专业技术人员在使用时注意系统和软件的正确性和兼容性，以及带来的风险。
+当前版本`0.2.0`为测试版本。请商户的专业技术人员在使用时注意系统和软件的正确性和兼容性，以及带来的风险。
 
 ## 环境要求
 
-+ Java 1.8
++ Java 1.8+
 
 ## 安装
 
@@ -51,7 +51,7 @@ dependencies {
 	<dependency>
 	    <groupId>com.github.wechatpay-apiv3</groupId>
 	    <artifactId>wechatpay-apache-httpclient</artifactId>
-	    <version>0.1.6</version>
+	    <version>0.2.0</version>
 	</dependency>
 ```
 
@@ -154,6 +154,33 @@ try {
 }
 ```
 
+## 图片/视频上传
+
+我们对上传的参数组装和签名逻辑进行了一定的封装，只需要以下几步：
+
+1. 使用`WechatPayUploadHttpPost`构造一个上传的`HttpPost`，需设置待上传文件的文件名，SHA256摘要，文件的输入流。
+2. 通过`WechatPayHttpClientBuilder`得到的`HttpClient`发送请求。
+
+示例请参考下列代码。
+
+```java
+String filePath = "/your/home/hellokitty.png";
+URI uri = new URI("https://api.mch.weixin.qq.com/v3/merchant/media/upload");
+File file = new File(filePath);
+
+try (FileInputStream ins1 = new FileInputStream(file)) { 
+  String sha256 = DigestUtils.sha256Hex(ins1);
+  try (InputStream ins2 = new FileInputStream(file)) {
+    HttpPost request = new WechatPayUploadHttpPost.Builder(uri)
+        .withImage(file.getName(), sha256, ins2)
+        .build();
+    CloseableHttpResponse response1 = httpClient.execute(request);
+  }
+}
+```
+
+[AutoUpdateVerifierTest.uploadImageTest](/src/test/java/com/wechat/pay/contrib/apache/httpclient/AutoUpdateVerifierTest.java#L86)是一个更完整的示例。
+
 ## 常见问题
 
 ### 如何下载平台证书？
@@ -173,6 +200,18 @@ CloseableHttpClient httpClient = WechatPayHttpClientBuilder.create()
 
 请参考[AesUtil.Java](https://github.com/wechatpay-apiv3/wechatpay-apache-httpclient/blob/master/src/main/java/com/wechat/pay/contrib/apache/httpclient/util/AesUtil.java)。
 
+### 我想使用以前的版本，要怎么办
+
+可以在gradle中指定版本号。例如希望使用0.1.6版本，可以使用以下的方式。
+
+```xml
+	<dependency>
+	    <groupId>com.github.wechatpay-apiv3</groupId>
+	    <artifactId>wechatpay-apache-httpclient</artifactId>
+	    <version>0.1.6</version>
+	</dependency>
+```
+
 ## 联系我们
 
 如果你发现了**BUG**或者有任何疑问、建议，请通过issue进行反馈。

build.gradle

@@ -4,7 +4,7 @@ plugins {
 }
 
 group 'com.github.wechatpay-apiv3'
-version '0.1.6'
+version '0.2.0'
 
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
@@ -22,6 +22,7 @@ ext {
 
 dependencies {
     api "org.apache.httpcomponents:httpclient:$httpclient_version"
+    implementation "org.apache.httpcomponents:httpmime:$httpclient_version"
     implementation "com.fasterxml.jackson.core:jackson-databind:$jackson_version"
     implementation "org.slf4j:slf4j-api:$slf4j_version"
     testImplementation "org.slf4j:slf4j-simple:$slf4j_version"
@@ -39,27 +40,13 @@ jar {
 
 task sourcesJar(type: Jar) {
     from sourceSets.main.allJava
-    archiveClassifier = 'sources'
+    archiveClassifier.set("sources")
 }
 
 artifacts {
     archives sourcesJar
 }
 
-install {
-    repositories.mavenInstaller {
-        pom.project {
-            licenses {
-                license {
-                    name 'The Apache Software License, Version 2.0'
-                    url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
-                    distribution 'repo'
-                }
-            }
-        }
-    }
-}
-
 wrapper {
     gradleVersion = "5.4.1"
     distributionType = Wrapper.DistributionType.ALL

src/main/java/com/wechat/pay/contrib/apache/httpclient/Credentials.java

@@ -1,11 +1,11 @@
 package com.wechat.pay.contrib.apache.httpclient;
 
 import java.io.IOException;
-import org.apache.http.client.methods.HttpUriRequest;
+import org.apache.http.client.methods.HttpRequestWrapper;
 
 public interface Credentials {
 
   String getSchema();
 
-  String getToken(HttpUriRequest request) throws IOException;
+  String getToken(HttpRequestWrapper request) throws IOException;
 }

src/main/java/com/wechat/pay/contrib/apache/httpclient/SignatureExec.java

@@ -1,20 +1,18 @@
 package com.wechat.pay.contrib.apache.httpclient;
 
-import java.io.IOException;
 import org.apache.http.HttpEntity;
+import org.apache.http.HttpEntityEnclosingRequest;
 import org.apache.http.HttpException;
 import org.apache.http.StatusLine;
 import org.apache.http.client.methods.CloseableHttpResponse;
-import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
 import org.apache.http.client.methods.HttpExecutionAware;
 import org.apache.http.client.methods.HttpRequestWrapper;
-import org.apache.http.client.methods.HttpUriRequest;
-import org.apache.http.client.methods.RequestBuilder;
 import org.apache.http.client.protocol.HttpClientContext;
 import org.apache.http.conn.routing.HttpRoute;
-import org.apache.http.entity.ByteArrayEntity;
+import org.apache.http.entity.BufferedHttpEntity;
 import org.apache.http.impl.execchain.ClientExecChain;
-import org.apache.http.util.EntityUtils;
+
+import java.io.IOException;
 
 public class SignatureExec implements ClientExecChain {
   final ClientExecChain mainExec;
@@ -27,27 +25,19 @@ public class SignatureExec implements ClientExecChain {
     this.mainExec = mainExec;
   }
 
-  protected HttpEntity newRepeatableEntity(HttpEntity entity) throws IOException {
-    byte[] content = EntityUtils.toByteArray(entity);
-    ByteArrayEntity newEntity = new ByteArrayEntity(content);
-    newEntity.setContentEncoding(entity.getContentEncoding());
-    newEntity.setContentType(entity.getContentType());
-
-    return newEntity;
-  }
-
-  protected void convertToRepeatableResponseEntity(CloseableHttpResponse response) throws IOException {
+  protected void convertToRepeatableResponseEntity(CloseableHttpResponse response)
+      throws IOException {
     HttpEntity entity = response.getEntity();
-    if (entity != null && !entity.isRepeatable()) {
-      response.setEntity(newRepeatableEntity(entity));
+    if (entity != null) {
+      response.setEntity(new BufferedHttpEntity(entity));
     }
   }
 
-  protected void convertToRepeatableRequestEntity(HttpUriRequest request) throws IOException {
-    if (request instanceof HttpEntityEnclosingRequestBase) {
-      HttpEntity entity = ((HttpEntityEnclosingRequestBase) request).getEntity();
-      if (entity != null && !entity.isRepeatable()) {
-        ((HttpEntityEnclosingRequestBase) request).setEntity(newRepeatableEntity(entity));
+  protected void convertToRepeatableRequestEntity(HttpRequestWrapper request) throws IOException {
+    if (request instanceof HttpEntityEnclosingRequest) {
+      HttpEntity entity = ((HttpEntityEnclosingRequest) request).getEntity();
+      if (entity != null) {
+        ((HttpEntityEnclosingRequest) request).setEntity(new BufferedHttpEntity(entity));
       }
     }
   }
@@ -64,15 +54,16 @@ public CloseableHttpResponse execute(HttpRoute route, HttpRequestWrapper request
 
   private CloseableHttpResponse executeWithSignature(HttpRoute route, HttpRequestWrapper request,
       HttpClientContext context, HttpExecutionAware execAware) throws IOException, HttpException {
-    HttpUriRequest newRequest = RequestBuilder.copy(request.getOriginal()).build();
-    convertToRepeatableRequestEntity(newRequest);
+    // 上传类不需要消耗两次故不做转换
+    if (!(request.getOriginal() instanceof WechatPayUploadHttpPost)) {
+      convertToRepeatableRequestEntity(request);
+    }
     // 添加认证信息
-    newRequest.addHeader("Authorization",
-        credentials.getSchema() + " " + credentials.getToken(newRequest));
+    request.addHeader("Authorization",
+        credentials.getSchema() + " " + credentials.getToken(request));
 
     // 执行
-    CloseableHttpResponse response = mainExec.execute(
-        route, HttpRequestWrapper.wrap(newRequest), context, execAware);
+    CloseableHttpResponse response = mainExec.execute(route, request, context, execAware);
 
     // 对成功应答验签
     StatusLine statusLine = response.getStatusLine();
@@ -84,5 +75,4 @@ private CloseableHttpResponse executeWithSignature(HttpRoute route, HttpRequestW
     }
     return response;
   }
-
 }

src/main/java/com/wechat/pay/contrib/apache/httpclient/WechatPayUploadHttpPost.java

@@ -0,0 +1,75 @@
+package com.wechat.pay.contrib.apache.httpclient;
+
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URLConnection;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.entity.ContentType;
+import org.apache.http.entity.mime.HttpMultipartMode;
+import org.apache.http.entity.mime.MultipartEntityBuilder;
+
+public class WechatPayUploadHttpPost extends HttpPost {
+
+  private String meta;
+
+  private WechatPayUploadHttpPost(URI uri, String meta) {
+    super(uri);
+
+    this.meta = meta;
+  }
+
+  public String getMeta() {
+    return meta;
+  }
+
+  public static class Builder {
+
+    private String fileName;
+    private String fileSha256;
+    private InputStream fileInputStream;
+    private org.apache.http.entity.ContentType fileContentType;
+    private URI uri;
+
+    public Builder(URI uri) {
+      this.uri = uri;
+    }
+
+    public Builder withImage(String fileName, String fileSha256, InputStream inputStream) {
+      this.fileName = fileName;
+      this.fileSha256 = fileSha256;
+      this.fileInputStream = inputStream;
+
+      String mimeType = URLConnection.guessContentTypeFromName(fileName);
+      if (mimeType == null) {
+        // guess this is a video uploading
+        this.fileContentType = ContentType.APPLICATION_OCTET_STREAM;
+      } else {
+        this.fileContentType = ContentType.create(mimeType);
+      }
+      return this;
+    }
+
+    public WechatPayUploadHttpPost build() {
+      if (fileName == null || fileSha256 == null || fileInputStream == null) {
+        throw new IllegalArgumentException("缺少待上传图片文件信息");
+      }
+
+      if (uri == null) {
+        throw new IllegalArgumentException("缺少上传图片接口URL");
+      }
+
+      String meta = String.format("{\"filename\":\"%s\",\"sha256\":\"%s\"}", fileName, fileSha256);
+      WechatPayUploadHttpPost request = new WechatPayUploadHttpPost(uri, meta);
+
+      MultipartEntityBuilder entityBuilder = MultipartEntityBuilder.create();
+      entityBuilder.setMode(HttpMultipartMode.RFC6532)
+          .addBinaryBody("file", fileInputStream, fileContentType, fileName)
+          .addTextBody("meta", meta, org.apache.http.entity.ContentType.APPLICATION_JSON);
+
+      request.setEntity(entityBuilder.build());
+      request.addHeader("Accept", org.apache.http.entity.ContentType.APPLICATION_JSON.toString());
+
+      return request;
+    }
+  }
+}

src/main/java/com/wechat/pay/contrib/apache/httpclient/auth/WechatPay2Credentials.java

@@ -1,11 +1,14 @@
 package com.wechat.pay.contrib.apache.httpclient.auth;
 
 import com.wechat.pay.contrib.apache.httpclient.Credentials;
+import com.wechat.pay.contrib.apache.httpclient.WechatPayUploadHttpPost;
 import java.io.IOException;
 import java.net.URI;
+import java.nio.charset.StandardCharsets;
 import java.security.SecureRandom;
-import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
-import org.apache.http.client.methods.HttpUriRequest;
+
+import org.apache.http.HttpEntityEnclosingRequest;
+import org.apache.http.client.methods.HttpRequestWrapper;
 import org.apache.http.util.EntityUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -46,14 +49,14 @@ public final String getSchema() {
   }
 
   @Override
-  public final String getToken(HttpUriRequest request) throws IOException {
+  public final String getToken(HttpRequestWrapper request) throws IOException {
     String nonceStr = generateNonceStr();
     long timestamp = generateTimestamp();
 
     String message = buildMessage(nonceStr, timestamp, request);
     log.debug("authorization message=[{}]", message);
 
-    Signer.SignatureResult signature = signer.sign(message.getBytes("utf-8"));
+    Signer.SignatureResult signature = signer.sign(message.getBytes(StandardCharsets.UTF_8));
 
     String token = "mchid=\"" + getMerchantId() + "\","
         + "nonce_str=\"" + nonceStr + "\","
@@ -65,7 +68,7 @@ public final String getToken(HttpUriRequest request) throws IOException {
     return token;
   }
 
-  protected final String buildMessage(String nonce, long timestamp, HttpUriRequest request)
+  protected final String buildMessage(String nonce, long timestamp, HttpRequestWrapper request)
       throws IOException {
     URI uri = request.getURI();
     String canonicalUrl = uri.getRawPath();
@@ -75,8 +78,10 @@ protected final String buildMessage(String nonce, long timestamp, HttpUriRequest
 
     String body = "";
     // PATCH,POST,PUT
-    if (request instanceof HttpEntityEnclosingRequestBase) {
-      body = EntityUtils.toString(((HttpEntityEnclosingRequestBase) request).getEntity());
+    if (request.getOriginal() instanceof WechatPayUploadHttpPost) {
+      body = ((WechatPayUploadHttpPost) request.getOriginal()).getMeta();
+    } else if (request instanceof HttpEntityEnclosingRequest) {
+      body = EntityUtils.toString(((HttpEntityEnclosingRequest) request).getEntity());
     }
 
     return request.getRequestLine().getMethod() + "\n"