支付宝官方sdk笔记

公共配置

引入包：

<dependency>   
    <groupId>com.alipay.sdk</groupId>   
    <artifactId>alipay-sdk-java</artifactId>   
    <version>3.0.0</version> 
</dependency>

Alipay几个重要的对象：

• AlipayClient 接口

  • 声明了调用各种请求的方法。

  • 主要实现类：DefaultAlipayClient

  • 实现类实现了接口中的各个方法

  • 主要封装支付请求的公共参数，如请求网关，签名等信息。

  • 主要方法：

    • excute(AlipayRequest request)：发起请求
    • pageExcute(AlipayRequest request)：网页支付的请求

• AlipayRequest 接口

  • 声明了一些参数的get 和 set 方法

  • 主要实现类：AlipayTrade***Request

    • 封装了各个请求的业务参数。

  • 主要方法：

    • setBizContent(String jsonContent)：设置请求的业务参数
    • setNotifyUrl(String url)：设置异步通知的地址
    • setReturnUrl(String url)：设置同步通知的地址

• AlipayResponse 类

  • 声明了返回的 code，错误信息 和一些返回参数

  • 主要子类：AlipayTrade***Response

    • 提供了对各类请求的返回数据进行处理的方法

  • 主要方法：

    • getSubCode：获取错误代码（官网上可对照，以ACQ开头）

    • getMsg：获取错误原因

    • getBody：获取返回内容，封装了响应内容

    • getParams：获取传入的请求业务参数

    • isSuccess：判断本次请求是否调用成功。是判断 subCode 是否为空
      
      配置支付宝参数：

// 应用ID,您的APPID，收款账号既是您的APPID对应支付宝账号 
public static String APP_ID = "20132101000652145"; 
// 商户私钥，您的PKCS8格式RSA2私钥 
public static String MERCHANT_PRIVATE_KEY = ""; 
// 支付宝公钥,查看地址：https://openhome.alipay.com/platform/keyManage.htm 对应APPID下的支付宝公钥。 
public static String ALIPAY_PUBLIC_KEY = ""; 
/** * 异步通知，这里我们设计自己的后台代码 */ 
public static String notify_url = "http://127.0.0.1:8003/order/notifyUrl"; 
// 页面跳转同步通知页面路径 需http://格式的完整路径，不能加?id=123这类自定义参数，必须外网可以正常访问
public static String return_url = "http://127.0.0.1:8003/order/returnUrl"; 
// 签名方式 
public static String SIGN_TYPE = "RSA2"; 
// 字符编码格式 
public static String CHARSET = "utf-8"; 
// 支付宝网关 
public static String GATEWAYURL = "https://openapi.alipaydev.com/gateway.do";
public static String SUBJECT = "我的订单";

使用流程（以电脑网站发起支付请求为例）：

• 初始化一个 AlipayClient客户端

AlipayClient alipayClient = new DefaultAlipayClient(URL,APP_ID,APP_PRIVATE_KEY,FORMAT,CHARSET,ALIPAY_PUBLIC_KEY,SIGN_TYPE);

• 声明发向支付宝的请求 request

AlipayTradePagePayRequest alipayRequest = new AlipayTradePagePayRequest(); 
//设置请求的同步返回地址 
alipayRequest.setReturnUrl(AlipayConfig.return_url); 
//设置请求的异步返回地址 
alipayRequest.setReturnUrl(AlipayConfig.notify_url); 
//设置业务请求参数，方式1（推荐）
AlipayTradePagePayModel model = new AlipayTradePagePayModel();
model.setOutTradeNo("xxxxx");
model.setTotalAmount("33.2");
alipayRequest.setBizModel(model);
//设置业务请求参数 ，方式2
alipayRequest.setBizContent("{\"out_trade_no\":\"" + outTradeNo + "\","       
                            + "\"total_amount\":\"" + totalAmount + "\","       
                            + "\"subject\":\"" + subject + "\","      
                            + "\"body\":\"商品名称\","       
                            + "\"timeout_express\":\"90m\","      
                            + "\"product_code\":\"FAST_INSTANT_TRADE_PAY\"}"); 
//执行request获得结果,会获取到一个form 表单，前端只需将form 表单提交就可跳转到支付宝支付 
String result = alipayClient.pageExecute(alipayRequest).getBody(); AlipayTradeRefundRequest alipayRequest = new AlipayTradeRefundRequest(); Order orderByOrderId = orderService.getOrderByOrderId(outTradeNo); /** 调取接口*/ alipayRequest.setBizContent("{\"out_trade_no\":\"" + outTradeNo + "\","       
        + "\"refund_amount\":\"" + orderByOrderId.getOrderPrice() + "\","       
        + "\"refund_reason\":\"" + "不想要了" + "\","      
        + "\"out_request_no\":\"" + outTradeNo + "\"}");

电脑网站支付

1、发起支付：

1.1、支付请求

调用支付宝接口及对应请求：alipay.trade.page.pay -----> AlipayTradePagePayRequest

注意：

• 支付结果必须以异步通知、查询结果为准
• 收到结果后必须验签
• 验签通过后，要对比请求中的 app_id、out_trade_no、total_amout与之前请求的是否一致
• out_trade_no 为本地上传的订单号，必须保证不可重复

请求参数说明：

业务参数错误：

后端收不到错误信息，错误信息只会显示在前端，对照错误码可差错。

常见错误码：

公共参数错误：

• 私钥或公钥配置错误（直接报错）
  

编码步骤

发起支付请求：

//1、封装client客户端 
DefaultAlipayClient alipayClient = new DefaultAlipayClient(AlipayConfig.GATEWAYURL, AlipayConfig.APP_ID, AlipayConfig.MERCHANT_PRIVATE_KEY, "json", AlipayConfig.CHARSET, AlipayConfig.ALIPAY_PUBLIC_KEY, AlipayConfig.SIGN_TYPE); 
//2、封装 Request 
AlipayTradePagePayRequest alipayRequest = new AlipayTradePagePayRequest(); alipayRequest.setNotifyUrl(AlipayConfig.notify_url); alipayRequest.setReturnUrl(AlipayConfig.return_url); 
alipayRequest.setBizContent("{\"out_trade_no\":\"" + outTradeNo + "\","    
                            + "\"total_amount\":\"" + totalAmount + "\","    
                            + "\"subject\":\"" + subject + "\","    
                            + "\"body\":\"商品名称\","   
                            + "\"timeout_express\":\"90m\","    
                            + "\"product_code\":\"FAST_INSTANT_TRADE_PAY\"}"); 
//3、封装 Response，也就是返回给前端的数据。此 Response 是ali sdk封装的 
AlipayTradePagePayResponse payResponse = alipayClient.pageExecute(alipayRequest); 
//4、获取 responseBody 返回给前端即可
String responseBody = payResponse.getBody();

支付宝的支付时序图感觉不是很清楚，所以我就自己画了一个。
而且在支付宝发起电脑网页，手机网页支付的请求是，后端发起的Request并未真正发起请求，只是将所有请求参数封装成了表单，然后将表单返回给前端，由前端提交表单，才会跳转到支付页面。

• 支付页面
  

支付发起请求后返回的表单：

<form name='punchout_form' method='post'
      action='https://openapi.alipaydev.com/gateway.do'>  
    <input type='hidden' name='biz_content' value=''>  
    <input type='submit' value='立即支付' style='display:none' > 
</form> 
<script>document.forms[0].submit();</script>

• biz_content 的内容为上面封装 AlipayTradePagePayRequest 时设置的请求参数。

• action 的URL后面还会加上配置的公共参数，以及请求的接口。会将下面的封装成请求参数并进行url编码后加到网关地址的后面

charset=utf-8 
method=alipay.trade.page.pay
sign=签名 
return_url=http://127.0.0.1:8003/order/returnUrl 
notify_url=http://127.0.0.1:8003/order/notifyUrl 
version=1.0 
app_id=2016101000652345 
sign_type=RSA2 
timestamp=2019-12-19 14:18:38 
alipay_sdk=alipay-sdk-java-dynamicVersionNo 
format=json

1.2、支付校验

在设置的同步、异步返回的url所对应的 Controller 中解析 Request作用域即可。以异步校验为准

对返回结果进行验签：

//支付返回结果都封装在 Request 作用域中。所以要对 request 进行解析 
Map<String, String[]> requestParams = request.getParameterMap(); 
for (String name : requestParams.keySet()) {    
    String[] values = requestParams.get(name);    
    String valueStr = "";    
    for (int i = 0; i < values.length; i++) {        v
        alueStr = (i == values.length-1) ? valueStr+values[i] : valueStr+values[i] + ",";  		}    
    params.put(name, valueStr); 
} 
//验签 
boolean signVerified = AlipaySignature.rsaCheckV1(params, AlipayConfig.ALIPAY_PUBLIC_KEY, AlipayConfig.CHARSET, AlipayConfig.SIGN_TYPE); 
if (signVerified) {    
    // TODO 验签成功后，按照支付结果异步通知中的描述，对支付结果中的业务内容进行二次校验，校验成功后在response中返回success并继续商户自身业务处理，校验失败返回failure 
}else{    
    // TODO 验签失败则记录异常日志，并在response中返回failure. 
}

//同步返回结果信息 
{    
    charset=utf-8,     
    out_trade_no=12019122014253806498300476623439, 
    method=alipay.trade.page.pay.return,     
    total_amount=38.70,     
    sign=xxxxxx,     
    trade_no=2019122022001483381000111417,   
    auth_app_id=2016101000652145,    
    version=1.0,   
    app_id=2016101000652145,   
    sign_type=RSA2xxxxx,     
    seller_id=2088102178915714,    
    timestamp=2019-12-20 14:34:09 
}

1.3、支付查询

调用支付宝接口及对应请求：alipay.trade.query-----> AlipayTradeQueryRequest

请求参数

代码示例：

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); 
AlipayTradeQueryRequest request = new AlipayTradeQueryRequest(); 
request.setBizContent("{" + 
                      "    \"out_trade_no\":\"20150320010101001\"," + 
                      "    \"trade_no\":\"2014112611001004680 073956707\"" + "  }"); 
AlipayTradeQueryResponse response = alipayClient.execute(request); if(response.isSuccess()){   
    System.out.println("调用成功"); 
} else {    
    System.out.println("调用失败");
}

//查询结果信息，如果失败会携带 sub_code，包含错误码
{    
    "alipay_trade_query_response":{       
        "code":"10000",     
        "msg":"Success",      
        "buyer_logon_id":"gtd***@sandbox.com",     
        "buyer_pay_amount":"0.00",     
        "buyer_user_id":"2088102178983386",    
        "buyer_user_type":"PRIVATE",   
        "invoice_amount":"0.00",       
        "out_trade_no":"12019122010290014797630089677739",     
        "point_amount":"0.00",      
        "receipt_amount":"0.00",    
        "send_pay_date":"2019-12-20 11:42:49",   
        "total_amount":"38.70",  
        "trade_no":"2019122022001483381000108109",    
        "trade_status":"TRADE_SUCCESS" 
    }
}

2、退款

调用支付宝接口及对应请求：alipay.trade.refund -----> AlipayTradeRefundRequest

注意：

• 同步返回结果也是准确的。

请求参数：

代码示例：

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key"); 
AlipayTradeRefundRequest request = new AlipayTradeRefundRequest(); request.setBizContent("{" + "    \"out_trade_no\":\"20150320010101001\","                                           + "    \"trade_no\":\"2014112611001004680073956707\","                                   + "    \"refund_amount\":200.12,"                                                   + "    \"refund_reason\":\"正常退款\","                                                  + "    \"out_request_no\":\"HZ01RF001\","                                                    + "    \"operator_id\":\"OP001\","                                                       + "    \"store_id\":\"NJ_S_001\","                                                          + "    \"terminal_id\":\"NJ_T_001\""                                                                               + "  }"); 
AlipayTradeRefundResponse response = alipayClient.execute(request); if(response.isSuccess()){ 
    System.out.println("调用成功");
} else { 
    System.out.println("调用失败"); 
}

常见错误码：

退款查询：

调用支付宝接口及对应请求：alipay.trade.fastpay.refund.query -----> AlipayTradeFastpayRefundQueryRequest

请求参数：

常见错误码：

3、下载账单

调用支付宝接口及对应请求： alipay.data.dataservice.bill.downloadurl.query -----> AlipayDataDataserviceBillDownloadurlQueryRequest

请求参数：

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); 
//获得初始化的
AlipayClient AlipayDataDataserviceBillDownloadurlQueryRequest request = new AlipayDataDataserviceBillDownloadurlQueryRequest();
//创建API对应的request类 
request.setBizContent("{" + "    \"bill_type\":\"trade\"," +  //账单类型，必填 " 
                      \"bill_date\":\"2016-04-05\"" //账单时间，获取多少时间以后的账单 
                      "}");
//设置业务参数 
AlipayDataDataserviceBillDownloadurlQueryResponse response = 	alipayClient.execute(request); 
System.out.print(response.getBody()); //根据response中的结果继续业务逻辑处理

错误码（全部）：

常用接口：