Merge pull request #85 from Eric-Lee-Handyman/master

代码可读性优化 & 语法简化

Author: xy-peng

.editorconfig

@@ -0,0 +1,30 @@
+# EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 100
+tab_width = 2
+trim_trailing_whitespace = true
+continuation_indent_size = 4
+
+[*.java]
+indent_size = 4
+max_line_length = 120
+tab_width = 4
+continuation_indent_size = 8
+
+[{*.gant,*.gradle,*.groovy,*.gson,*.gy}]
+indent_size = 4
+tab_width = 4
+continuation_indent_size = 8
+
+[{*.markdown,*.md}]
+indent_size = 4
+tab_width = 4
+continuation_indent_size = 8

README.md

@@ -1,4 +1,4 @@
-# wechatpay-apache-httpclient 
+# wechatpay-apache-httpclient
 
 ## 概览
 
@@ -54,7 +54,7 @@ import com.wechat.pay.contrib.apache.httpclient.WechatPayHttpClientBuilder;
 //...
 WechatPayHttpClientBuilder builder = WechatPayHttpClientBuilder.create()
         .withMerchant(merchantId, merchantSerialNumber, merchantPrivateKey)
-        .withWechatpay(wechatpayCertificates);
+        .withWechatPay(wechatpayCertificates);
 // ... 接下来，你仍然可以通过builder设置各种参数，来配置你的HttpClient
 
 // 通过WechatPayHttpClientBuilder构造的HttpClient，会自动的处理签名和验签
@@ -113,7 +113,7 @@ rootNode.putObject("payer")
         .put("openid", "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o");
 
 objectMapper.writeValue(bos, rootNode);
-    
+
 httpPost.setEntity(new StringEntity(bos.toString("UTF-8"), "UTF-8"));
 CloseableHttpResponse response = httpClient.execute(httpPost);
 
@@ -148,7 +148,7 @@ ObjectNode rootNode = objectMapper.createObjectNode();
 rootNode.put("mchid","1900009191");
 
 objectMapper.writeValue(bos, rootNode);
-    
+
 httpPost.setEntity(new StringEntity(bos.toString("UTF-8"), "UTF-8"));
 CloseableHttpResponse response = httpClient.execute(httpPost);
 
@@ -173,7 +173,7 @@ Credentials credentials = new WechatPay2Credentials(merchantId, new Signer() {
 });
 WechatPayHttpClientBuilder builder = WechatPayHttpClientBuilder.create()
         .withCredentials(credentials)
-        .withWechatpay(wechatpayCertificates);
+        .withWechatPay(wechatpayCertificates);
 ```
 
 ## 自动更新证书功能
@@ -250,7 +250,7 @@ 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)) { 
+try (FileInputStream ins1 = new FileInputStream(file)) {
   String sha256 = DigestUtils.sha256Hex(ins1);
   try (InputStream ins2 = new FileInputStream(file)) {
     HttpPost request = new WechatPayUploadHttpPost.Builder(uri)
@@ -261,7 +261,7 @@ try (FileInputStream ins1 = new FileInputStream(file)) {
 }
 ```
 
-[AutoUpdateVerifierTest.uploadImageTest](/src/test/java/com/wechat/pay/contrib/apache/httpclient/AutoUpdateVerifierTest.java#L86)是一个更完整的示例。
+[AutoUpdateVerifierTest.uploadImageTest](/src/test/java/com/wechat/pay/contrib/apache/httpclient/AutoUpdateVerifierTest.java#90)是一个更完整的示例。
 
 ## 常见问题
 
@@ -281,7 +281,7 @@ PrivateKey merchantPrivateKey = PemUtil.loadPrivateKey(
 
 ### 如何下载平台证书？
 
-使用`WechatPayHttpClientBuilder`需要调用`withWechatpay`设置[微信支付平台证书](https://wechatpay-api.gitbook.io/wechatpay-api-v3/ren-zheng/zheng-shu#ping-tai-zheng-shu)，而平台证书又只能通过调用[获取平台证书接口](https://wechatpay-api.gitbook.io/wechatpay-api-v3/jie-kou-wen-dang/ping-tai-zheng-shu#huo-qu-ping-tai-zheng-shu-lie-biao)下载。为了解开"死循环"，你可以在第一次下载平台证书时，按照下述方法临时"跳过”应答签名的验证。
+使用`WechatPayHttpClientBuilder`需要调用`withWechatPay`设置[微信支付平台证书](https://wechatpay-api.gitbook.io/wechatpay-api-v3/ren-zheng/zheng-shu#ping-tai-zheng-shu)，而平台证书又只能通过调用[获取平台证书接口](https://wechatpay-api.gitbook.io/wechatpay-api-v3/jie-kou-wen-dang/ping-tai-zheng-shu#huo-qu-ping-tai-zheng-shu-lie-biao)下载。为了解开"死循环"，你可以在第一次下载平台证书时，按照下述方法临时"跳过”应答签名的验证。
 
 ```java
 CloseableHttpClient httpClient = WechatPayHttpClientBuilder.create()

build.gradle

@@ -57,7 +57,7 @@ publishing {
                 licenses {
                     license {
                         name = 'The Apache Software License, Version 2.0'
-                        url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+                        url = 'https://www.apache.org/licenses/LICENSE-2.0.txt'
                     }
                 }
                 developers {
@@ -91,8 +91,3 @@ publishing {
 signing {
     sign publishing.publications.maven
 }
-
-
-
-
-

settings.gradle

@@ -1,2 +1 @@
 rootProject.name = 'wechatpay-apache-httpclient'
-

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

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

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

@@ -1,5 +1,10 @@
 package com.wechat.pay.contrib.apache.httpclient;
 
+import static org.apache.http.HttpHeaders.AUTHORIZATION;
+import static org.apache.http.HttpStatus.SC_MULTIPLE_CHOICES;
+import static org.apache.http.HttpStatus.SC_OK;
+
+import java.io.IOException;
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpEntityEnclosingRequest;
 import org.apache.http.HttpException;
@@ -12,67 +17,69 @@
 import org.apache.http.entity.BufferedHttpEntity;
 import org.apache.http.impl.execchain.ClientExecChain;
 
-import java.io.IOException;
-
+/**
+ * @author xy-peng
+ */
 public class SignatureExec implements ClientExecChain {
-  final ClientExecChain mainExec;
-  final Credentials credentials;
-  final Validator validator;
 
-  SignatureExec(Credentials credentials, Validator validator, ClientExecChain mainExec) {
-    this.credentials = credentials;
-    this.validator = validator;
-    this.mainExec = mainExec;
-  }
+    private static final String WECHAT_PAY_HOST_NAME_SUFFIX = ".mch.weixin.qq.com";
+    private final ClientExecChain mainExec;
+    private final Credentials credentials;
+    private final Validator validator;
 
-  protected void convertToRepeatableResponseEntity(CloseableHttpResponse response)
-      throws IOException {
-    HttpEntity entity = response.getEntity();
-    if (entity != null) {
-      response.setEntity(new BufferedHttpEntity(entity));
+    protected SignatureExec(Credentials credentials, Validator validator, ClientExecChain mainExec) {
+        this.credentials = credentials;
+        this.validator = validator;
+        this.mainExec = mainExec;
     }
-  }
 
-  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));
-      }
+    protected void convertToRepeatableResponseEntity(CloseableHttpResponse response) throws IOException {
+        HttpEntity entity = response.getEntity();
+        if (entity != null) {
+            response.setEntity(new BufferedHttpEntity(entity));
+        }
     }
-  }
 
-  @Override
-  public CloseableHttpResponse execute(HttpRoute route, HttpRequestWrapper request,
-      HttpClientContext context, HttpExecutionAware execAware) throws IOException, HttpException {
-    if (request.getTarget().getHostName().endsWith(".mch.weixin.qq.com")) {
-      return executeWithSignature(route, request, context, execAware);
-    } else {
-      return mainExec.execute(route, request, context, execAware);
+    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));
+            }
+        }
     }
-  }
 
-  private CloseableHttpResponse executeWithSignature(HttpRoute route, HttpRequestWrapper request,
-      HttpClientContext context, HttpExecutionAware execAware) throws IOException, HttpException {
-    // 上传类不需要消耗两次故不做转换
-    if (!(request.getOriginal() instanceof WechatPayUploadHttpPost)) {
-      convertToRepeatableRequestEntity(request);
+    @Override
+    public CloseableHttpResponse execute(HttpRoute route, HttpRequestWrapper request, HttpClientContext context,
+            HttpExecutionAware execAware) throws IOException, HttpException {
+        if (request.getTarget().getHostName().endsWith(WECHAT_PAY_HOST_NAME_SUFFIX)) {
+            return executeWithSignature(route, request, context, execAware);
+        } else {
+            return mainExec.execute(route, request, context, execAware);
+        }
     }
-    // 添加认证信息
-    request.addHeader("Authorization",
-        credentials.getSchema() + " " + credentials.getToken(request));
 
-    // 执行
-    CloseableHttpResponse response = mainExec.execute(route, request, context, execAware);
+    private CloseableHttpResponse executeWithSignature(HttpRoute route, HttpRequestWrapper request,
+            HttpClientContext context,
+            HttpExecutionAware execAware) throws IOException, HttpException {
+        // 上传类不需要消耗两次故不做转换
+        if (!(request.getOriginal() instanceof WechatPayUploadHttpPost)) {
+            convertToRepeatableRequestEntity(request);
+        }
+        // 添加认证信息
+        request.addHeader(AUTHORIZATION, credentials.getSchema() + " " + credentials.getToken(request));
+
+        // 执行
+        CloseableHttpResponse response = mainExec.execute(route, request, context, execAware);
 
-    // 对成功应答验签
-    StatusLine statusLine = response.getStatusLine();
-    if (statusLine.getStatusCode() >= 200 && statusLine.getStatusCode() < 300) {
-      convertToRepeatableResponseEntity(response);
-      if (!validator.validate(response)) {
-        throw new HttpException("应答的微信支付签名验证失败");
-      }
+        // 对成功应答验签
+        StatusLine statusLine = response.getStatusLine();
+        if (statusLine.getStatusCode() >= SC_OK && statusLine.getStatusCode() < SC_MULTIPLE_CHOICES) {
+            convertToRepeatableResponseEntity(response);
+            if (!validator.validate(response)) {
+                throw new HttpException("应答的微信支付签名验证失败");
+            }
+        }
+        return response;
     }
-    return response;
-  }
 }

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

@@ -3,6 +3,11 @@
 import java.io.IOException;
 import org.apache.http.client.methods.CloseableHttpResponse;
 
+/**
+ * @author xy-peng
+ */
 public interface Validator {
-  boolean validate(CloseableHttpResponse response) throws IOException;
+
+    boolean validate(CloseableHttpResponse response) throws IOException;
+
 }