自动下载证书支持代理 (#124)

Author: xy-peng

core/src/main/java/com/wechat/pay/java/core/RSAAutoCertificateConfig.java

@@ -6,10 +6,8 @@
 
 import com.wechat.pay.java.core.certificate.CertificateProvider;
 import com.wechat.pay.java.core.certificate.RSAAutoCertificateProvider;
-import com.wechat.pay.java.core.cipher.AeadAesCipher;
-import com.wechat.pay.java.core.cipher.AeadCipher;
-import com.wechat.pay.java.core.cipher.RSAVerifier;
-import com.wechat.pay.java.core.cipher.Verifier;
+import com.wechat.pay.java.core.cipher.*;
+import com.wechat.pay.java.core.http.AbstractHttpClientBuilder;
 import com.wechat.pay.java.core.http.HttpClient;
 import com.wechat.pay.java.core.notification.NotificationConfig;
 import java.nio.charset.StandardCharsets;
@@ -75,6 +73,7 @@ public static class Builder extends AbstractRSAConfigBuilder<Builder> {
     protected HttpClient httpClient;
     protected byte[] apiV3Key;
     protected CertificateProvider certificateProvider;
+    protected AbstractHttpClientBuilder<?> httpClientBuilder;
 
     public Builder apiV3Key(String apiV3key) {
       this.apiV3Key = apiV3key.getBytes(StandardCharsets.UTF_8);
@@ -86,6 +85,11 @@ public Builder httpClient(HttpClient httpClient) {
       return this;
     }
 
+    public Builder httpClientBuilder(AbstractHttpClientBuilder<?> builder) {
+      httpClientBuilder = builder;
+      return this;
+    }
+
     @Override
     protected Builder self() {
       return this;
@@ -98,10 +102,15 @@ public RSAAutoCertificateConfig build() {
               .apiV3Key(requireNonNull(apiV3Key))
               .privateKey(requireNonNull(privateKey))
               .merchantSerialNumber(requireNonNull(merchantSerialNumber));
+
       if (httpClient != null) {
         providerBuilder.httpClient(httpClient);
       }
 
+      if (httpClientBuilder != null) {
+        providerBuilder.httpClientBuilder(httpClientBuilder);
+      }
+
       certificateProvider = providerBuilder.build();
 
       return new RSAAutoCertificateConfig(this);

core/src/main/java/com/wechat/pay/java/core/certificate/RSAAutoCertificateProvider.java

@@ -8,6 +8,7 @@
 import com.wechat.pay.java.core.cipher.AeadAesCipher;
 import com.wechat.pay.java.core.cipher.AeadCipher;
 import com.wechat.pay.java.core.cipher.RSASigner;
+import com.wechat.pay.java.core.http.AbstractHttpClientBuilder;
 import com.wechat.pay.java.core.http.DefaultHttpClientBuilder;
 import com.wechat.pay.java.core.http.HttpClient;
 import com.wechat.pay.java.core.http.HttpHeaders;
@@ -45,6 +46,7 @@ public static class Builder {
     private PrivateKey privateKey;
     private String merchantSerialNumber;
     private HttpClient httpClient;
+    private AbstractHttpClientBuilder<?> httpClientBuilder;
 
     public Builder merchantId(String merchantId) {
       this.merchantId = merchantId;
@@ -76,6 +78,12 @@ public Builder merchantSerialNumber(String merchantSerialNumber) {
       return this;
     }
 
+    public Builder httpClientBuilder(AbstractHttpClientBuilder<?> builder) {
+      // httpClientBuilder 不是不可变的，所以为了避免过程中修改入参或者值发生变化，这里制作了一个副本
+      this.httpClientBuilder = builder.newInstance();
+      return this;
+    }
+
     private final Validator emptyValidator =
         new Validator() {
           @Override
@@ -86,15 +94,18 @@ public boolean validate(HttpHeaders responseHeaders, String body) {
 
     public RSAAutoCertificateProvider build() {
       if (httpClient == null) {
-        DefaultHttpClientBuilder httpClientBuilder =
-            new DefaultHttpClientBuilder().validator(emptyValidator);
-        if (credential == null) {
+        if (httpClientBuilder == null) {
+          httpClientBuilder = new DefaultHttpClientBuilder();
+        }
+
+        if (credential == null && privateKey != null) {
           credential =
               new WechatPay2Credential(
                   requireNonNull(merchantId),
-                  new RSASigner(requireNonNull(merchantSerialNumber), requireNonNull(privateKey)));
+                  new RSASigner(requireNonNull(merchantSerialNumber), privateKey));
         }
-        httpClient = httpClientBuilder.credential(credential).build();
+
+        httpClient = httpClientBuilder.credential(credential).validator(emptyValidator).build();
       }
       return new RSAAutoCertificateProvider(
           merchantId, new AeadAesCipher(requireNonNull(apiV3Key)), httpClient);

core/src/main/java/com/wechat/pay/java/core/http/AbstractHttpClientBuilder.java

@@ -0,0 +1,37 @@
+package com.wechat.pay.java.core.http;
+
+import com.wechat.pay.java.core.auth.Credential;
+import com.wechat.pay.java.core.auth.Validator;
+
+public interface AbstractHttpClientBuilder<T extends AbstractHttpClientBuilder<T>> {
+
+  /**
+   * 复制工厂，复制一个当前对象
+   *
+   * @return 对象的副本
+   */
+  T newInstance();
+
+  /**
+   * 设置验证器
+   *
+   * @param validator 验证器
+   * @return the AbstractHttpClientBuilder
+   */
+  T validator(Validator validator);
+
+  /**
+   * 设置凭据生成器
+   *
+   * @param credential 凭据生成器
+   * @return the AbstractHttpClientBuilder
+   */
+  T credential(Credential credential);
+
+  /**
+   * 构建 AbstractHttpClient
+   *
+   * @return AbstractHttpClient
+   */
+  AbstractHttpClient build();
+}

core/src/main/java/com/wechat/pay/java/core/http/DefaultHttpClientBuilder.java

@@ -10,7 +10,8 @@
 import java.util.concurrent.TimeUnit;
 
 /** 默认HttpClient构造器 */
-public class DefaultHttpClientBuilder {
+public class DefaultHttpClientBuilder
+    implements AbstractHttpClientBuilder<DefaultHttpClientBuilder> {
 
   private Credential credential;
   private Validator validator;
@@ -21,6 +22,24 @@ public class DefaultHttpClientBuilder {
   private int connectTimeoutMs = -1;
   private Proxy proxy;
 
+  /**
+   * 复制工厂，复制一个当前对象
+   *
+   * @return 对象的副本
+   */
+  @Override
+  public DefaultHttpClientBuilder newInstance() {
+    DefaultHttpClientBuilder result = new DefaultHttpClientBuilder();
+    result.credential = this.credential;
+    result.validator = this.validator;
+    result.customizeOkHttpClient = this.customizeOkHttpClient;
+    result.readTimeoutMs = this.readTimeoutMs;
+    result.writeTimeoutMs = this.writeTimeoutMs;
+    result.connectTimeoutMs = this.connectTimeoutMs;
+    result.proxy = this.proxy;
+    return result;
+  }
+
   /**
    * 设置读超时
    *
@@ -60,6 +79,7 @@ public DefaultHttpClientBuilder connectTimeoutMs(int connectTimeoutMs) {
    * @param credential 凭据生成器
    * @return defaultHttpClientBuilder
    */
+  @Override
   public DefaultHttpClientBuilder credential(Credential credential) {
     this.credential = credential;
     return this;
@@ -71,6 +91,7 @@ public DefaultHttpClientBuilder credential(Credential credential) {
    * @param validator 验证器
    * @return defaultHttpClientBuilder
    */
+  @Override
   public DefaultHttpClientBuilder validator(Validator validator) {
     this.validator = validator;
     return this;
@@ -104,7 +125,8 @@ public DefaultHttpClientBuilder proxy(Proxy proxy) {
    *
    * @return httpClient
    */
-  public HttpClient build() {
+  @Override
+  public AbstractHttpClient build() {
     requireNonNull(credential);
     requireNonNull(validator);
     okhttp3.OkHttpClient.Builder okHttpClientBuilder =

core/src/main/java/com/wechat/pay/java/core/notification/AutoCertificateNotificationConfig.java

@@ -12,6 +12,13 @@
 import com.wechat.pay.java.core.http.HttpClient;
 import java.nio.charset.StandardCharsets;
 
+/**
+ * 通知回调配置类
+ *
+ * @deprecated 请使用 RSAAutoCertificateConfig。 从版本 v0.2.4 起, 该类是多余的，而且功能不完整。
+ *     开发者应尽快迁移。我们将在未来某个时间移除这段废弃的代码。
+ */
+@Deprecated
 public final class AutoCertificateNotificationConfig extends AbstractNotificationConfig {
 
   private AutoCertificateNotificationConfig(

core/src/test/java/com/wechat/pay/java/core/RSAAutoCertificateConfigTest.java

@@ -18,11 +18,14 @@
 import com.wechat.pay.java.core.certificate.model.DownloadCertificateResponse;
 import com.wechat.pay.java.core.certificate.model.EncryptCertificate;
 import com.wechat.pay.java.core.cipher.RSASigner;
+import com.wechat.pay.java.core.http.DefaultHttpClientBuilder;
 import com.wechat.pay.java.core.http.HttpClient;
 import com.wechat.pay.java.core.http.HttpHeaders;
 import com.wechat.pay.java.core.http.okhttp.OkHttpClientAdapter;
 import com.wechat.pay.java.core.util.GsonUtil;
 import com.wechat.pay.java.core.util.NonceUtil;
+import java.net.InetSocketAddress;
+import java.net.Proxy;
 import java.util.ArrayList;
 import java.util.stream.Stream;
 import okhttp3.MediaType;
@@ -31,13 +34,15 @@
 import okhttp3.Response;
 import okhttp3.ResponseBody;
 import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 
 class RSAAutoCertificateConfigTest implements ConfigTest {
 
   static HttpClient httpClient;
+  static OkHttpClient okHttpClient;
 
   @BeforeAll
   static void initHttpClient() {
@@ -48,7 +53,7 @@ public <T> boolean validate(HttpHeaders responseHeaders, String body) {
             return true;
           }
         };
-    OkHttpClient okHttpClient =
+    okHttpClient =
         new OkHttpClient.Builder()
             .addInterceptor(
                 chain -> {
@@ -121,7 +126,16 @@ static Stream<Builder> BuilderProvider() {
             .privateKeyFromPath(MERCHANT_PRIVATE_KEY_PATH)
             .merchantSerialNumber(MERCHANT_CERTIFICATE_SERIAL_NUMBER)
             .httpClient(httpClient)
-            .apiV3Key(API_V3_KEY));
+            .apiV3Key(API_V3_KEY),
+
+        // with http client builder
+        new Builder()
+            .merchantId("1123456")
+            .privateKeyFromPath(MERCHANT_PRIVATE_KEY_PATH)
+            .merchantSerialNumber(MERCHANT_CERTIFICATE_SERIAL_NUMBER)
+            .apiV3Key(API_V3_KEY)
+            .httpClientBuilder(
+                new DefaultHttpClientBuilder().writeTimeoutMs(1000).okHttpClient(okHttpClient)));
   }
 
   @Test
@@ -144,4 +158,23 @@ public Config createConfig() {
         .httpClient(httpClient)
         .build();
   }
+
+  @Disabled("only available in production environment")
+  @Test
+  void testAutoCertificateWithProxy() {
+    DefaultHttpClientBuilder clientBuilder =
+        new DefaultHttpClientBuilder()
+            .proxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", 12639)));
+
+    RSAAutoCertificateConfig config =
+        new Builder()
+            .merchantId("")
+            .privateKey("")
+            .merchantSerialNumber("")
+            .httpClientBuilder(clientBuilder)
+            .apiV3Key("")
+            .build();
+
+    assertNotNull(config.createValidator());
+  }
 }