Merge pull request #28 from alipay/using_lombok

Using lombok

Author: ScottWryyyyy

README.md

@@ -12,7 +12,7 @@ https://mvnrepository.com/artifact/com.alipay.global.sdk/global-open-sdk-java
 <dependency>
     <groupId>com.alipay.global.sdk</groupId>
     <artifactId>global-open-sdk-java</artifactId>
-    <version>2.0.25</version>
+    <version>2.0.26</version>
 </dependency>
 ```
 

pom.xml

@@ -4,7 +4,7 @@
     <groupId>com.alipay.global.sdk</groupId>
     <artifactId>global-open-sdk-java</artifactId>
     <packaging>jar</packaging>
-    <version>2.0.25</version>
+    <version>2.0.26</version>
     <name>global-open-sdk-java</name>
     <url>https://github.com/alipay/global-open-sdk-java</url>
     <description>

src/main/java/com/alipay/global/api/BaseAlipayClient.java

@@ -29,6 +29,14 @@ public abstract class BaseAlipayClient implements AlipayClient {
      * alipay public key
      */
     private String alipayPublicKey;
+    /**
+     * client id
+     */
+    private String clientId;
+    /**
+     * is sandbox mode
+     */
+    private boolean isSandboxMode = false;
 
     public BaseAlipayClient() {
     }
@@ -39,9 +47,28 @@ public BaseAlipayClient(String gatewayUrl, String merchantPrivateKey, String ali
         this.alipayPublicKey = alipayPublicKey;
     }
 
+    public BaseAlipayClient(String gatewayUrl, String merchantPrivateKey, String alipayPublicKey, String clientId) {
+        this.gatewayUrl = gatewayUrl;
+        this.merchantPrivateKey = merchantPrivateKey;
+        this.alipayPublicKey = alipayPublicKey;
+        this.clientId = clientId;
+
+        // if client id starts with SANDBOX_, set to sandbox mode
+        if (clientId.startsWith("SANDBOX_")) {
+            this.isSandboxMode = true;
+        }
+    }
+
     public <T extends AlipayResponse> T execute(AlipayRequest<T> alipayRequest) throws AlipayApiException {
 
-        checkRequestParam(alipayRequest);
+        // compatible with old version which clientId does not exist in BaseAlipayClient
+        alipayRequest.setClientId(alipayRequest.getClientId() == null ? this.clientId : alipayRequest.getClientId());
+
+        // replace with sandbox url if needed
+        adjustSandboxUrl(alipayRequest);
+
+        // check request params
+        checkRequestParams(alipayRequest);
 
         String clientId = alipayRequest.getClientId();
         String httpMethod = alipayRequest.getHttpMethod();
@@ -108,22 +135,20 @@ private String genSignValue(String httpMethod, String path, String clientId, Str
         try {
             signatureValue = SignatureTool.sign(httpMethod, path, clientId, requestTime, reqBody, merchantPrivateKey);
         } catch (Exception e) {
-            throw new AlipayApiException(e);
+            throw new AlipayApiException("generate signature error", e);
         }
         return signatureValue;
     }
 
     private boolean checkRspSign(String httpMethod, String path, String clientId, String responseTime, String rspBody, String rspSignValue) throws AlipayApiException {
         try {
-            boolean isVerify = SignatureTool.verify(httpMethod, path, clientId, responseTime, rspBody, rspSignValue, alipayPublicKey);
-            return isVerify;
+            return SignatureTool.verify(httpMethod, path, clientId, responseTime, rspBody, rspSignValue, alipayPublicKey);
         } catch (Exception e) {
-            throw new AlipayApiException(e);
+            throw new AlipayApiException("verify signature error", e);
         }
-
     }
 
-    private void checkRequestParam(AlipayRequest alipayRequest) throws AlipayApiException {
+    private void checkRequestParams(AlipayRequest alipayRequest) throws AlipayApiException {
         if (alipayRequest == null) {
             throw new AlipayApiException("alipayRequest can't null");
         }
@@ -141,7 +166,7 @@ private void checkRequestParam(AlipayRequest alipayRequest) throws AlipayApiExce
         }
 
         if (StringUtils.isBlank(httpMethod)) {
-            throw new AlipayApiException("httpMehod can't null");
+            throw new AlipayApiException("httpMethod can't null");
         }
 
         if (StringUtils.isBlank(path)) {
@@ -166,6 +191,18 @@ private String genRequestUrl(String path) {
 
     }
 
+    /**
+     * If is sandbox mode, modify the path
+     *
+     * @param alipayRequest
+     */
+    private void adjustSandboxUrl(AlipayRequest alipayRequest) {
+        if (isSandboxMode) {
+            String originPath = alipayRequest.getPath();
+            alipayRequest.setPath(originPath.replaceFirst("/ams/api", "/ams/sandbox/api"));
+        }
+    }
+
     /**
      * Generate required headers
      *

src/main/java/com/alipay/global/api/DefaultAlipayClient.java

@@ -12,6 +12,10 @@ public DefaultAlipayClient(String gatewayUrl, String merchantPrivateKey, String
         super(gatewayUrl, merchantPrivateKey, alipayPublicKey);
     }
 
+    public DefaultAlipayClient(String gatewayUrl, String merchantPrivateKey, String alipayPublicKey, String clientId) {
+        super(gatewayUrl, merchantPrivateKey, alipayPublicKey, clientId);
+    }
+
     @Override
     public Map<String, String> buildCustomHeader() {
         return null;

src/main/java/com/alipay/global/api/example/excutable/CashierExecutableDemoCode.java

@@ -3,17 +3,9 @@
 import com.alipay.global.api.AlipayClient;
 import com.alipay.global.api.DefaultAlipayClient;
 import com.alipay.global.api.exception.AlipayApiException;
-import com.alipay.global.api.model.ams.Amount;
-import com.alipay.global.api.model.ams.Buyer;
-import com.alipay.global.api.model.ams.Env;
-import com.alipay.global.api.model.ams.Order;
-import com.alipay.global.api.model.ams.PaymentFactor;
-import com.alipay.global.api.model.ams.PaymentMethod;
-import com.alipay.global.api.model.ams.ProductCodeType;
-import com.alipay.global.api.model.ams.SettlementStrategy;
-import com.alipay.global.api.model.ams.TerminalType;
+import com.alipay.global.api.model.ams.*;
+import com.alipay.global.api.model.constants.AntomPathConstants;
 import com.alipay.global.api.model.constants.EndPointConstants;
-import com.alipay.global.api.model.constants.PathConstants;
 import com.alipay.global.api.request.ams.pay.AlipayPayQueryRequest;
 import com.alipay.global.api.request.ams.pay.AlipayPayRequest;
 import com.alipay.global.api.response.ams.pay.AlipayPayQueryResponse;
@@ -25,30 +17,27 @@
 public class CashierExecutableDemoCode {
 
 
-    private static final String       merchantPrivateKey  = "";
+    private static final String merchantPrivateKey = "";
 
-    private static final String       alipayPublicKey     = "";
+    private static final String alipayPublicKey = "";
 
-    private static final String       CLIENT_ID           = "";
+    private static final String CLIENT_ID = "";
 
 
-
-
-    public static void main(String[] args){
+    public static void main(String[] args) {
 
     }
 
 
-
-    private static void cashierPay(){
+    private static void cashierPay() {
 
         // Select your gateway address according to the recommendations of the developer center.
         AlipayClient defaultAlipayClient = new DefaultAlipayClient(EndPointConstants.SG,
                 merchantPrivateKey, alipayPublicKey);
 
         AlipayPayRequest alipayPayRequest = new AlipayPayRequest();
         alipayPayRequest.setClientId(CLIENT_ID);
-        alipayPayRequest.setPath(PathConstants.PAY_PROD_PATH);
+        alipayPayRequest.setPath(AntomPathConstants.PAYMENT_PATH);
         alipayPayRequest.setProductCode(ProductCodeType.CASHIER_PAYMENT);
 
         // replace to your paymentRequestId
@@ -116,8 +105,7 @@ private static void cashierPay(){
     }
 
 
-
-    private static void cashierInquiryPayment(){
+    private static void cashierInquiryPayment() {
 
         AlipayClient defaultAlipayClient = new DefaultAlipayClient(EndPointConstants.SG,
                 merchantPrivateKey, alipayPublicKey);
@@ -136,8 +124,4 @@ private static void cashierInquiryPayment(){
     }
 
 
-
-
-
-
 }

src/main/java/com/alipay/global/api/example/excutable/EasyPayExecutableDemoCode.java

@@ -3,13 +3,9 @@
 import com.alipay.global.api.AlipayClient;
 import com.alipay.global.api.DefaultAlipayClient;
 import com.alipay.global.api.exception.AlipayApiException;
-import com.alipay.global.api.model.ams.Amount;
-import com.alipay.global.api.model.ams.Order;
-import com.alipay.global.api.model.ams.PaymentMethod;
-import com.alipay.global.api.model.ams.ProductCodeType;
-import com.alipay.global.api.model.ams.SettlementStrategy;
+import com.alipay.global.api.model.ams.*;
+import com.alipay.global.api.model.constants.AntomPathConstants;
 import com.alipay.global.api.model.constants.EndPointConstants;
-import com.alipay.global.api.model.constants.PathConstants;
 import com.alipay.global.api.model.constants.ProductSceneConstants;
 import com.alipay.global.api.request.ams.pay.AlipayPaymentSessionRequest;
 import com.alipay.global.api.response.ams.pay.AlipayPaymentSessionResponse;
@@ -19,25 +15,25 @@
 public class EasyPayExecutableDemoCode {
 
 
-    private static final String       merchantPrivateKey  = "";
+    private static final String merchantPrivateKey = "";
 
-    private static final String       alipayPublicKey     = "";
+    private static final String alipayPublicKey = "";
 
-    private static final String       CLIENT_ID           = "";
+    private static final String CLIENT_ID = "";
 
-    public static void main(String[] args){
+    public static void main(String[] args) {
 
 
     }
 
 
-    public static void easyPaySession(){
+    public static void easyPaySession() {
 
         AlipayClient defaultAlipayClient = new DefaultAlipayClient(EndPointConstants.SG,
                 merchantPrivateKey, alipayPublicKey);
 
         AlipayPaymentSessionRequest alipayPaymentSessionRequest = new AlipayPaymentSessionRequest();
-        alipayPaymentSessionRequest.setPath(PathConstants.CREATE_SESSION_PROD_PATH);
+        alipayPaymentSessionRequest.setPath(AntomPathConstants.CREATE_SESSION_PATH);
         alipayPaymentSessionRequest.setClientId(CLIENT_ID);
 
         alipayPaymentSessionRequest.setProductScene(ProductSceneConstants.EASY_PAY);
@@ -73,7 +69,7 @@ public static void easyPaySession(){
         order.setOrderDescription("antom test order");
         order.setOrderAmount(amount);
 
-        AlipayPaymentSessionResponse alipayPaymentSessionResponse  = null;
+        AlipayPaymentSessionResponse alipayPaymentSessionResponse = null;
 
         try {
             alipayPaymentSessionResponse = defaultAlipayClient.execute(alipayPaymentSessionRequest);

src/main/java/com/alipay/global/api/example/excutable/SubscriptionExecutableDemoCode.java

@@ -4,16 +4,9 @@
 import com.alipay.global.api.AlipayClient;
 import com.alipay.global.api.DefaultAlipayClient;
 import com.alipay.global.api.exception.AlipayApiException;
-import com.alipay.global.api.model.ams.Amount;
-import com.alipay.global.api.model.ams.Env;
-import com.alipay.global.api.model.ams.OrderInfo;
-import com.alipay.global.api.model.ams.OsType;
-import com.alipay.global.api.model.ams.PaymentMethod;
-import com.alipay.global.api.model.ams.PeriodRule;
-import com.alipay.global.api.model.ams.SettlementStrategy;
-import com.alipay.global.api.model.ams.TerminalType;
+import com.alipay.global.api.model.ams.*;
+import com.alipay.global.api.model.constants.AntomPathConstants;
 import com.alipay.global.api.model.constants.EndPointConstants;
-import com.alipay.global.api.model.constants.PathConstants;
 import com.alipay.global.api.request.ams.subscription.AlipaySubscriptionCreateRequest;
 import com.alipay.global.api.response.ams.subscription.AlipaySubscriptionCreateResponse;
 
@@ -22,25 +15,25 @@
 public class SubscriptionExecutableDemoCode {
 
 
-    private static final String       merchantPrivateKey = "";
+    private static final String merchantPrivateKey = "";
 
-    private static final String       alipayPublicKey     = "";
+    private static final String alipayPublicKey = "";
 
-    private static final String       CLIENT_ID           = "";
+    private static final String CLIENT_ID = "";
 
-    public static void main(String[] args){
+    public static void main(String[] args) {
 
         createSubScription();
 
     }
 
-    public static void createSubScription(){
+    public static void createSubScription() {
 
         AlipayClient defaultAlipayClient = new DefaultAlipayClient(EndPointConstants.SG,
                 merchantPrivateKey, alipayPublicKey);
 
         AlipaySubscriptionCreateRequest alipaySubscriptionCreateRequest = new AlipaySubscriptionCreateRequest();
-        alipaySubscriptionCreateRequest.setPath(PathConstants.SUBSCRIPTION_CREATE_PROD_PATH);
+        alipaySubscriptionCreateRequest.setPath(AntomPathConstants.SUBSCRIPTION_CREATE_PATH);
         alipaySubscriptionCreateRequest.setClientId(CLIENT_ID);
 
         String subscriptionRequestId = UUID.randomUUID().toString();
@@ -55,7 +48,7 @@ public static void createSubScription(){
         periodRule.setPeriodCount(1);
         alipaySubscriptionCreateRequest.setPeriodRule(periodRule);
 
-        PaymentMethod paymentMethod =new PaymentMethod();
+        PaymentMethod paymentMethod = new PaymentMethod();
         paymentMethod.setPaymentMethodType("GCASH");
         alipaySubscriptionCreateRequest.setPaymentMethod(paymentMethod);
 
@@ -82,7 +75,7 @@ public static void createSubScription(){
         env.setOsType(OsType.ANDROID);
         alipaySubscriptionCreateRequest.setEnv(env);
 
-        AlipaySubscriptionCreateResponse alipaySubscriptionCreateResponse =null;
+        AlipaySubscriptionCreateResponse alipaySubscriptionCreateResponse = null;
 
         System.out.println(JSON.toJSON(alipaySubscriptionCreateRequest));
 
@@ -99,6 +92,4 @@ public static void createSubScription(){
     }
 
 
-
-
 }

src/main/java/com/alipay/global/api/model/constants/AntomPathConstants.java

@@ -0,0 +1,28 @@
+/*
+ * Ant Group
+ * Copyright (c) 2004-2024 All Rights Reserved.
+ */
+package com.alipay.global.api.model.constants;
+
+/**
+ * @author zhangtianren
+ * @version AntomPathConstants.java, v 0.1 2024年06月13日 下午4:20 zhangtianren
+ */
+public class AntomPathConstants {
+
+    public static final String PAYMENT_PATH = "/ams/api/v1/payments/pay";
+    public static final String REFUND_PATH = "/ams/api/v1/payments/refund";
+    public static final String INQUIRY_PATH = "/ams/api/v1/payments/inquiryPayment";
+    public static final String CAPTURE_PATH = "/ams/api/v1/payments/capture";
+    public static final String CREATE_SESSION_PATH = "/ams/api/v1/payments/createPaymentSession";
+    public static final String CANCEL_PATH = "/ams/api/v1/payments/cancel";
+    public static final String CONSULT_PATH = "/ams/api/v1/payments/consult";
+    public static final String AUTH_CONSULT_PATH = "/ams/api/v1/authorizations/consult";
+    public static final String AUTH_APPLY_TOKEN_PATH = "/ams/api/v1/authorizations/applyToken";
+    public static final String VAULTING_SESSION_PATH = "/ams/api/v1/vaults/createVaultingSession";
+    public static final String VAULT_PAYMENTMETHOD_PATH = "/ams/api/v1/vaults/createVaultingSession";
+    public static final String SUBSCRIPTION_CREATE_PATH = "/ams/api/v1/subscriptions/create";
+    public static final String SUBSCRIPTION_CANCEL_PATH = "/ams/api/v1/subscriptions/cancel";
+    public static final String SUBSCRIPTION_CHANGE_PATH = "/ams/api/v1/subscriptions/change";
+
+}

src/main/java/com/alipay/global/api/model/constants/PathConstants.java

@@ -1,5 +1,6 @@
 package com.alipay.global.api.model.constants;
 
+@Deprecated
 public class PathConstants {
 
     public static final String PAY_PROD_PATH = "/ams/api/v1/payments/pay";