统一文档和测试用例中的变量命名 (#142)

lianup · web-flow · commit c78640b5fe7f · 2022-05-13T09:07:59.000+08:00
diff --git a/README.md b/README.md
@@ -58,7 +58,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，会自动的处理签名和验签
@@ -73,7 +73,7 @@ CloseableHttpResponse response = httpClient.execute(...);
 + `merchantId`商户号。
 + `merchantSerialNumber`商户API证书的证书序列号。
 + `merchantPrivateKey`商户API私钥，如何加载商户API私钥请看[常见问题](#如何加载商户私钥)。
-+ `wechatpayCertificates`微信支付平台证书。你也可以使用后面章节提到的“[定时更新平台证书功能](#定时更新平台证书功能)”，而不需要关心平台证书的来龙去脉。
++ `wechatPayCertificates`微信支付平台证书列表。你也可以使用后面章节提到的“[定时更新平台证书功能](#定时更新平台证书功能)”，而不需要关心平台证书的来龙去脉。
 
 ### 示例：获取平台证书
 
@@ -177,24 +177,24 @@ Credentials credentials = new WechatPay2Credentials(merchantId, new Signer() {
 });
 WechatPayHttpClientBuilder builder = WechatPayHttpClientBuilder.create()
         .withCredentials(credentials)
-        .withWechatPay(wechatpayCertificates);
+        .withWechatPay(wechatPayCertificates);
 ```
 
 ## 定时更新平台证书功能
 
-版本>=`0.4.0`可使用 CertificatesManager.getVerifier(mchId) 得到的验签器替代默认的验签器。它会定时下载和更新商户对应的[微信支付平台证书](https://wechatpay-api.gitbook.io/wechatpay-api-v3/ren-zheng/zheng-shu#ping-tai-zheng-shu) （默认下载间隔为UPDATE_INTERVAL_MINUTE）。
+版本>=`0.4.0`可使用 CertificatesManager.getVerifier(merchantId) 得到的验签器替代默认的验签器。它会定时下载和更新商户对应的[微信支付平台证书](https://wechatpay-api.gitbook.io/wechatpay-api-v3/ren-zheng/zheng-shu#ping-tai-zheng-shu) （默认下载间隔为UPDATE_INTERVAL_MINUTE）。
 
 示例代码：
 ```java
 // 获取证书管理器实例
 certificatesManager = CertificatesManager.getInstance();
 // 向证书管理器增加需要自动更新平台证书的商户信息
-certificatesManager.putMerchant(mchId, new WechatPay2Credentials(mchId,
-            new PrivateKeySigner(mchSerialNo, merchantPrivateKey)), apiV3Key.getBytes(StandardCharsets.UTF_8));
+certificatesManager.putMerchant(merchantId, new WechatPay2Credentials(merchantId,
+            new PrivateKeySigner(merchantSerialNumber, merchantPrivateKey)), apiV3Key.getBytes(StandardCharsets.UTF_8));
 // ... 若有多个商户号，可继续调用putMerchant添加商户信息
 
 // 从证书管理器中获取verifier
-verifier = certificatesManager.getVerifier(mchId);
+verifier = certificatesManager.getVerifier(merchantId);
 WechatPayHttpClientBuilder builder = WechatPayHttpClientBuilder.create()
         .withMerchant(merchantId, merchantSerialNumber, merchantPrivateKey)
         .withValidator(new WechatPay2Validator(verifier))
@@ -221,9 +221,9 @@ CloseableHttpResponse response = httpClient.execute(...);
 
 ```java
 // 建议从Verifier中获得微信支付平台证书，或使用预先下载到本地的平台证书文件中
-X509Certificate wechatpayCertificate = verifier.getValidCertificate();
+X509Certificate certificate = verifier.getValidCertificate();
 try {
-  String ciphertext = RsaCryptoUtil.encryptOAEP(text, wechatpayCertificate);
+  String ciphertext = RsaCryptoUtil.encryptOAEP(text, certificate);
 } catch (IllegalBlockSizeException e) {
   e.printStackTrace();
 }
@@ -321,7 +321,7 @@ PrivateKey merchantPrivateKey = PemUtil.loadPrivateKey(
 
 ```java
 CloseableHttpClient httpClient = WechatPayHttpClientBuilder.create()
-  .withMerchant(mchId, mchSerialNo, merchantPrivateKey)
+  .withMerchant(merchantId, merchantSerialNumber, merchantPrivateKey)
   .withValidator(response -> true) // NOTE: 设置一个空的应答签名验证器，**不要**用在业务请求
   .build();
 ```
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -1,17 +1,22 @@
 # 升级指南
+
 ## 从 0.3.0 升级至 0.4.0
+
 版本`0.4.0`提供了支持多商户号的[定时更新平台证书功能](README.md#定时更新平台证书功能)，不兼容版本`0.3.0`。推荐升级方式如下：
+
 - 若你使用了`ScheduledUpdateCertificatesVerifier`，请使用`CertificatesManager`替换：
+
 ```diff
 -verifier = new ScheduledUpdateCertificatesVerifier(
 -                new WechatPay2Credentials(merchantId, new PrivateKeySigner(merchantSerialNumber, merchantPrivateKey)),
 -                apiV3Key.getBytes(StandardCharsets.UTF_8));
 +// 获取证书管理器实例
 +certificatesManager = CertificatesManager.getInstance();
 +// 向证书管理器增加需要自动更新平台证书的商户信息
-+certificatesManager.putMerchant(mchId, new WechatPay2Credentials(mchId,
-+                new PrivateKeySigner(mchSerialNo, merchantPrivateKey)), apiV3Key.getBytes(StandardCharsets.UTF_8));
++certificatesManager.putMerchant(merchantId, new WechatPay2Credentials(merchantId,
++                new PrivateKeySigner(merchantSerialNumber, merchantPrivateKey)), apiV3Key.getBytes(StandardCharsets.UTF_8));
 +// 从证书管理器中获取verifier
-+verifier = certificatesManager.getVerifier(mchId);
++verifier = certificatesManager.getVerifier(merchantId);
 ```
+
 - 若你使用了`getLatestCertificate`方法，请使用`getValidCertificate`方法替换。
diff --git a/src/test/java/com/wechat/pay/contrib/apache/httpclient/AutoUpdateVerifierTest.java b/src/test/java/com/wechat/pay/contrib/apache/httpclient/AutoUpdateVerifierTest.java
@@ -39,8 +39,8 @@ public class AutoUpdateVerifierTest {
     private static final String serialNumber = "";
     private static final String message = "";
     private static final String signature = "";
-    private static final String mchId = ""; // 商户号
-    private static final String mchSerialNo = ""; // 商户证书序列号
+    private static final String merchantId = ""; // 商户号
+    private static final String merchantSerialNumber = ""; // 商户证书序列号
     private static final String apiV3Key = ""; // API V3密钥
     private CloseableHttpClient httpClient;
     private AutoUpdateCertificatesVerifier verifier;
@@ -51,11 +51,11 @@ public void setup() {
 
         //使用自动更新的签名验证器，不需要传入证书
         verifier = new AutoUpdateCertificatesVerifier(
-                new WechatPay2Credentials(mchId, new PrivateKeySigner(mchSerialNo, merchantPrivateKey)),
+                new WechatPay2Credentials(merchantId, new PrivateKeySigner(merchantSerialNumber, merchantPrivateKey)),
                 apiV3Key.getBytes(StandardCharsets.UTF_8));
 
         httpClient = WechatPayHttpClientBuilder.create()
-                .withMerchant(mchId, mchSerialNo, merchantPrivateKey)
+                .withMerchant(merchantId, merchantSerialNumber, merchantPrivateKey)
                 .withValidator(new WechatPay2Validator(verifier))
                 .build();
     }
diff --git a/src/test/java/com/wechat/pay/contrib/apache/httpclient/CertificatesManagerTest.java b/src/test/java/com/wechat/pay/contrib/apache/httpclient/CertificatesManagerTest.java
@@ -34,11 +34,8 @@ public class CertificatesManagerTest {
     // 你的商户私钥
     private static final String privateKey = "-----BEGIN PRIVATE KEY-----\n"
             + "-----END PRIVATE KEY-----\n";
-    private static final String serialNumber = "";
-    private static final String message = "";
-    private static final String signature = "";
-    private static final String mchId = ""; // 商户号
-    private static final String mchSerialNo = ""; // 商户证书序列号
+    private static final String merchantId = ""; // 商户号
+    private static final String merchantSerialNumber = ""; // 商户证书序列号
     private static final String apiV3Key = ""; // API V3密钥
     private CloseableHttpClient httpClient;
     CertificatesManager certificatesManager;
@@ -50,13 +47,14 @@ public void setup() throws Exception {
         // 获取证书管理器实例
         certificatesManager = CertificatesManager.getInstance();
         // 向证书管理器增加需要自动更新平台证书的商户信息
-        certificatesManager.putMerchant(mchId, new WechatPay2Credentials(mchId,
-                new PrivateKeySigner(mchSerialNo, merchantPrivateKey)), apiV3Key.getBytes(StandardCharsets.UTF_8));
+        certificatesManager.putMerchant(merchantId, new WechatPay2Credentials(merchantId,
+                        new PrivateKeySigner(merchantSerialNumber, merchantPrivateKey)),
+                apiV3Key.getBytes(StandardCharsets.UTF_8));
         // 从证书管理器中获取verifier
-        verifier = certificatesManager.getVerifier(mchId);
+        verifier = certificatesManager.getVerifier(merchantId);
         // 构造httpclient
         httpClient = WechatPayHttpClientBuilder.create()
-                .withMerchant(mchId, mchSerialNo, merchantPrivateKey)
+                .withMerchant(merchantId, merchantSerialNumber, merchantPrivateKey)
                 .withValidator(new WechatPay2Validator(verifier))
                 .build();
     }
diff --git a/src/test/java/com/wechat/pay/contrib/apache/httpclient/HttpClientBuilderTest.java b/src/test/java/com/wechat/pay/contrib/apache/httpclient/HttpClientBuilderTest.java
@@ -31,8 +31,8 @@
 
 public class HttpClientBuilderTest {
 
-    private static final String mchId = "1900009191"; // 商户号
-    private static final String mchSerialNo = "1DDE55AD98ED71D6EDD4A4A16996DE7B47773A8C"; // 商户证书序列号
+    private static final String merchantId = "1900009191"; // 商户号
+    private static final String merchantSerialNumber = "1DDE55AD98ED71D6EDD4A4A16996DE7B47773A8C"; // 商户证书序列号
     private static final String requestBody = "{\n"
             + "    \"stock_id\": \"9433645\",\n"
             + "    \"stock_creator_mchid\": \"1900006511\",\n"
@@ -50,15 +50,15 @@ public class HttpClientBuilderTest {
     @Before
     public void setup() {
         PrivateKey merchantPrivateKey = PemUtil.loadPrivateKey(privateKey);
-        X509Certificate wechatPayCertificate = PemUtil.loadCertificate(
+        X509Certificate wechatPayCert = PemUtil.loadCertificate(
                 new ByteArrayInputStream(certificate.getBytes(StandardCharsets.UTF_8)));
 
-        ArrayList<X509Certificate> listCertificates = new ArrayList<>();
-        listCertificates.add(wechatPayCertificate);
+        ArrayList<X509Certificate> wechatPayCertificates = new ArrayList<>();
+        wechatPayCertificates.add(wechatPayCert);
 
         httpClient = WechatPayHttpClientBuilder.create()
-                .withMerchant(mchId, mchSerialNo, merchantPrivateKey)
-                .withWechatPay(listCertificates)
+                .withMerchant(merchantId, merchantSerialNumber, merchantPrivateKey)
+                .withWechatPay(wechatPayCertificates)
                 .build();
     }
 
@@ -84,7 +84,7 @@ public void getCertificatesWithoutCertTest() throws Exception {
         PrivateKey merchantPrivateKey = PemUtil.loadPrivateKey(privateKey);
 
         httpClient = WechatPayHttpClientBuilder.create()
-                .withMerchant(mchId, mchSerialNo, merchantPrivateKey)
+                .withMerchant(merchantId, merchantSerialNumber, merchantPrivateKey)
                 .withValidator(response -> true)
                 .build();
 
diff --git a/src/test/java/com/wechat/pay/contrib/apache/httpclient/NotificationHandlerTest.java b/src/test/java/com/wechat/pay/contrib/apache/httpclient/NotificationHandlerTest.java
@@ -18,8 +18,8 @@ public class NotificationHandlerTest {
 
     private static final String privateKey = "-----BEGIN PRIVATE KEY-----\n"
             + "-----END PRIVATE KEY-----\n"; // 商户私钥
-    private static final String mchId = ""; // 商户号
-    private static final String mchSerialNo = ""; // 商户证书序列号
+    private static final String merchantId = ""; // 商户号
+    private static final String merchantSerialNumber = ""; // 商户证书序列号
     private static final String apiV3Key = ""; // apiV3密钥
     private static final String wechatPaySerial = ""; // 平台证书序列号
     private static final String nonce = ""; // 请求头Wechatpay-Nonce
@@ -35,10 +35,11 @@ public void setup() throws Exception {
         // 获取证书管理器实例
         certificatesManager = CertificatesManager.getInstance();
         // 向证书管理器增加需要自动更新平台证书的商户信息
-        certificatesManager.putMerchant(mchId, new WechatPay2Credentials(mchId,
-                new PrivateKeySigner(mchSerialNo, merchantPrivateKey)), apiV3Key.getBytes(StandardCharsets.UTF_8));
+        certificatesManager.putMerchant(merchantId, new WechatPay2Credentials(merchantId,
+                        new PrivateKeySigner(merchantSerialNumber, merchantPrivateKey)),
+                apiV3Key.getBytes(StandardCharsets.UTF_8));
         // 从证书管理器中获取verifier
-        verifier = certificatesManager.getVerifier(mchId);
+        verifier = certificatesManager.getVerifier(merchantId);
     }
 
     @Test
diff --git a/src/test/java/com/wechat/pay/contrib/apache/httpclient/RsaCryptoTest.java b/src/test/java/com/wechat/pay/contrib/apache/httpclient/RsaCryptoTest.java
@@ -15,13 +15,13 @@
 import com.wechat.pay.contrib.apache.httpclient.cert.CertificatesManager;
 import com.wechat.pay.contrib.apache.httpclient.util.PemUtil;
 import com.wechat.pay.contrib.apache.httpclient.util.RsaCryptoUtil;
-
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.security.PrivateKey;
 import java.util.Base64;
-
+import javax.crypto.BadPaddingException;
+import javax.crypto.Cipher;
 import org.apache.http.HttpEntity;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpPost;
@@ -32,15 +32,10 @@
 import org.junit.Before;
 import org.junit.Test;
 
-import javax.crypto.BadPaddingException;
-import javax.crypto.Cipher;
-import javax.crypto.IllegalBlockSizeException;
-import javax.management.PersistentMBean;
-
 public class RsaCryptoTest {
 
-    private static final String mchId = ""; // 商户号
-    private static final String mchSerialNo = ""; // 商户证书序列号
+    private static final String merchantId = ""; // 商户号
+    private static final String merchantSerialNumber = ""; // 商户证书序列号
     private static final String apiV3Key = ""; // API V3密钥
     private static final String privateKey = ""; // 商户API V3私钥
     private static final String wechatPaySerial = ""; // 平台证书序列号
@@ -102,13 +97,14 @@ public void setup() throws Exception {
         // 获取证书管理器实例
         certificatesManager = CertificatesManager.getInstance();
         // 向证书管理器增加需要自动更新平台证书的商户信息
-        certificatesManager.putMerchant(mchId, new WechatPay2Credentials(mchId,
-                new PrivateKeySigner(mchSerialNo, merchantPrivateKey)), apiV3Key.getBytes(StandardCharsets.UTF_8));
+        certificatesManager.putMerchant(merchantId, new WechatPay2Credentials(merchantId,
+                        new PrivateKeySigner(merchantSerialNumber, merchantPrivateKey)),
+                apiV3Key.getBytes(StandardCharsets.UTF_8));
         // 从证书管理器中获取verifier
-        verifier = certificatesManager.getVerifier(mchId);
+        verifier = certificatesManager.getVerifier(merchantId);
         httpClient = WechatPayHttpClientBuilder.create()
-                .withMerchant(mchId, mchSerialNo, merchantPrivateKey)
-                .withValidator(new WechatPay2Validator(certificatesManager.getVerifier(mchId)))
+                .withMerchant(merchantId, merchantSerialNumber, merchantPrivateKey)
+                .withValidator(new WechatPay2Validator(certificatesManager.getVerifier(merchantId)))
                 .build();
     }
 
