完善注释

Author: lianup

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

@@ -53,6 +53,9 @@ public WechatPayHttpClientBuilder withWechatPay(List<X509Certificate> certificat
 
     /**
      * Please use {@link #withWechatPay(List)} instead
+     *
+     * @param certificates 平台证书list
+     * @return 具有验证器的builder
      */
     @SuppressWarnings("SpellCheckingInspection")
     @Deprecated

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

@@ -129,9 +129,6 @@ protected void autoUpdateCert() throws IOException, GeneralSecurityException {
         }
     }
 
-    /**
-     * 反序列化证书并解密
-     */
     protected List<X509Certificate> deserializeToCerts(byte[] apiV3Key, String body)
             throws GeneralSecurityException, IOException {
         AesUtil aesUtil = new AesUtil(apiV3Key);

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

@@ -22,12 +22,6 @@ public ScheduledUpdateCertificatesVerifier(Credentials credentials, byte[] apiv3
         verifier = new CertificatesVerifier(certManagerSingleton.getCertificates());
     }
 
-    /**
-     * 初始化平台证书管理器
-     *
-     * @param credentials
-     * @param apiv3Key
-     */
     public void initCertManager(Credentials credentials, byte[] apiv3Key) {
         if (credentials == null || apiv3Key.length == 0) {
             throw new IllegalArgumentException("credentials或apiv3Key为空");

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

@@ -11,15 +11,12 @@ public interface Verifier {
 
     /**
      * 该方法已废弃，请使用getLatestCertificate代替
+     *
+     * @return 合法证书
      */
     @Deprecated
     X509Certificate getValidCertificate();
 
-    /**
-     * 获取最新的证书
-     *
-     * @return
-     */
     X509Certificate getLatestCertificate();
 
 }

src/main/java/com/wechat/pay/contrib/apache/httpclient/cert/CertManagerSingleton.java

@@ -52,11 +52,6 @@ public class CertManagerSingleton {
     private CertManagerSingleton() {
     }
 
-    /**
-     * 获取平台证书管理器实例
-     *
-     * @return
-     */
     public static CertManagerSingleton getInstance() {
         if (instance == null) {
             synchronized (CertManagerSingleton.class) {
@@ -71,9 +66,9 @@ public static CertManagerSingleton getInstance() {
     /**
      * 初始化平台证书管理器实例，在使用前需先调用该方法
      *
-     * @param credentials
-     * @param apiV3Key
-     * @param minutesInterval
+     * @param credentials 认证器
+     * @param apiV3Key APIv3密钥
+     * @param minutesInterval 定时更新间隔时间
      */
     public synchronized void init(Credentials credentials, byte[] apiV3Key, long minutesInterval) {
         if (credentials == null || apiV3Key.length == 0 || minutesInterval == 0) {
@@ -118,21 +113,13 @@ public void close() {
         }
     }
 
-    /**
-     * 获取平台证书 map
-     */
     public Map<BigInteger, X509Certificate> getCertificates() {
         if (certificates == null) {
             throw new IllegalStateException("请先调用init方法初始化实例");
         }
         return certificates;
     }
 
-    /**
-     * 获取最新的证书
-     *
-     * @return
-     */
     public X509Certificate getLatestCertificate() {
         if (certificates == null) {
             throw new IllegalStateException("请先调用init方法初始化实例");
@@ -147,11 +134,6 @@ public X509Certificate getLatestCertificate() {
         return latestCert;
     }
 
-    /**
-     * 下载和更新证书
-     *
-     * @param verifier
-     */
     private synchronized void downloadAndUpdateCert(Verifier verifier) {
         try (CloseableHttpClient httpClient = WechatPayHttpClientBuilder.create()
                 .withCredentials(credentials)
@@ -180,16 +162,10 @@ private synchronized void downloadAndUpdateCert(Verifier verifier) {
         }
     }
 
-    /**
-     * 初始化平台证书 map
-     */
     private void initCertificates() {
         downloadAndUpdateCert(null);
     }
 
-    /**
-     * 更新平台证书 map
-     */
     private void updateCertificates() {
         Verifier verifier = null;
         if (!certificates.isEmpty()) {

src/main/java/com/wechat/pay/contrib/apache/httpclient/constant/WechatPayHttpHeaders.java

@@ -4,7 +4,7 @@
  * 微信支付HTTP请求头相关常量
  *
  * @author Eric.Lee
- * @date 2021/10/29
+ *         Date: 2021/10/29
  */
 public final class WechatPayHttpHeaders {
 

src/main/java/com/wechat/pay/contrib/apache/httpclient/util/CertSerializeUtil.java

@@ -19,11 +19,11 @@ public class CertSerializeUtil {
     /**
      * 反序列化证书并解密
      *
-     * @param apiV3Key
-     * @param body
-     * @return
-     * @throws GeneralSecurityException
-     * @throws IOException
+     * @param apiV3Key APIv3密钥
+     * @param body 下载证书的请求返回体
+     * @return 证书list
+     * @throws GeneralSecurityException 当证书过期或尚未生效时
+     * @throws IOException 当body不合法时
      */
     public static Map<BigInteger, X509Certificate> deserializeToCerts(byte[] apiV3Key, String body)
             throws GeneralSecurityException, IOException {