微信官方支付sdk的使用(微信公眾號)
微信對多方呼叫微信支付已經給出了眾多api文件,地址為:https://pay.weixin.qq.com/wiki/doc/api/index.html
官方已經給出了SDK與DEMO,但是估計有些小夥伴還不清楚這個sdk該如何快速便捷的使用,今天就是講這個的。
開發步驟:
(1)首先下載微信支付sdk,官方sdk於demo的類如下:
這個sdk就已經把微信支付的功能封裝在裡面了,已經算是一個成形的程式碼級應用了.sdk已經把要做的工作都做了,剩下的就是你去呼叫了,就這麼簡單。首先我們看一下這些類的作用(就算不是很清楚內部,我們也可以開發,但作為一個有理想的程式設計師,還是要看一下):
(1.1) IWXPayDomain.java
實現域名管理的,不需要我們做工作。這個抽象介面,測試包中已經幫助我們實現了,我們可以拿過來直接用。複製貼上改個名字。
(1.2) WXPayConstants.java
這是一個微信支付的常量類,裡面有各種定義好的常量,在類裡面定義了一個內部列舉,它的作用是限定了簽名方式只能是MD5或者HMACSHA256。這裡要注意的是,簽名也是有SDK內部實現的,只有在使用到沙箱環境時,才用MD5簽名。
(1.3).WXPayConfig.java
這是一個抽象類,裡邊是一些微信支付的基本配置。是需要你自己繼承並完善的。但是這個實現在SDK自帶的測試包中已經實現了,直接把他複製過來。把自己的配置搞進去。
這一步主要的就是下載證書,在商戶平臺下載證書後,生產環境或者測試的電腦主機才可以呼叫微信支付下載證書後,放到指定位置,在配置一下路徑,很簡單,例如:
這樣配置的實現類就完成了。
(1.4).WXPay.java
最重要的類。就是這個類中已經封裝好了所有方法
|方法名 | 說明 |
|--------|--------|
|microPay| 刷卡支付 |
|unifiedOrder | 統一下單|
|orderQuery | 查詢訂單 |
|reverse | 撤銷訂單 |
|closeOrder|關閉訂單|
|refund|申請退款|
|refundQuery|查詢退款|
|downloadBill|下載對賬單|
|report|交易保障|
|shortUrl|轉換短連結|
|authCodeToOpenid|授權碼查詢openid|
(1.5)WXPayUtil.java
工具類,裡邊包含了要用到的方法,很全面。
微信支付介面傳輸資料是通過XML字串來傳輸的,然後再兩端再分別解析成對映結合。這是封裝在內部的我們瞭解一下就可以了。還包括符號的生成,你看,簽名都給你寫好了。
當然,你也可以根據自己的需求在放一些其他的工具方法。
* 注意:
* 證書檔案不能放在web伺服器虛擬目錄,應放在有訪問許可權控制的目錄中,防止被他人下載
* 建議將證書檔名改為複雜且不容易猜測的檔名
* 商戶伺服器要做好病毒和木馬防護工作,不被非法侵入者竊取證書檔案
* 請妥善保管商戶支付金鑰、公眾帳號SECRET,避免金鑰洩露
* 引數為`Map<String, String>`物件,返回型別也是`Map<String, String>`
* 方法內部會將引數會轉換成含有`appid`、`mch_id`、`nonce_str`、`sign\_type`和`sign`的XML
* 可選HMAC-SHA256演算法和MD5演算法簽名
* 通過HTTPS請求得到返回資料後會對其做必要的處理(例如驗證簽名,簽名錯誤則丟擲異常)
* 對於downloadBill,無論是否成功都返回Map,且都含有`return_code`和`return_msg`,若成功,其中`return_code`為`SUCCESS`,另外`data`對應對賬單資料
(2)官方測試例項:
## 示例
配置類MyConfig:
```java
import com.github.wxpay.sdk.WXPayConfig;
import java.io.*;
public class MyConfig implements WXPayConfig{
private byte[] certData;
public MyConfig() throws Exception {
String certPath = "/path/to/apiclient_cert.p12";
File file = new File(certPath);
InputStream certStream = new FileInputStream(file);
this.certData = new byte[(int) file.length()];
certStream.read(this.certData);
certStream.close();
}
public String getAppID() {
return "wx8888888888888888";
}
public String getMchID() {
return "12888888";
}
public String getKey() {
return "88888888888888888888888888888888";
}
public InputStream getCertStream() {
ByteArrayInputStream certBis = new ByteArrayInputStream(this.certData);
return certBis;
}
public int getHttpConnectTimeoutMs() {
return 8000;
}
public int getHttpReadTimeoutMs() {
return 10000;
}
}
```
統一下單:
```java
import com.github.wxpay.sdk.WXPay;
import java.util.HashMap;
import java.util.Map;
public class WXPayExample {
public static void main(String[] args) throws Exception {
MyConfig config = new MyConfig();
WXPay wxpay = new WXPay(config);
Map<String, String> data = new HashMap<String, String>();
data.put("body", "騰訊充值中心-QQ會員充值");
data.put("out_trade_no", "2016090910595900000012");
data.put("device_info", "");
data.put("fee_type", "CNY");
data.put("total_fee", "1");
data.put("spbill_create_ip", "123.12.12.123");
data.put("notify_url", "http://www.example.com/wxpay/notify");
data.put("trade_type", "NATIVE"); // 此處指定為掃碼支付
data.put("product_id", "12");
try {
Map<String, String> resp = wxpay.unifiedOrder(data);
System.out.println(resp);
} catch (Exception e) {
e.printStackTrace();
}
}
}
```
訂單查詢:
```java
import com.github.wxpay.sdk.WXPay;
import java.util.HashMap;
import java.util.Map;
public class WXPayExample {
public static void main(String[] args) throws Exception {
MyConfig config = new MyConfig();
WXPay wxpay = new WXPay(config);
Map<String, String> data = new HashMap<String, String>();
data.put("out_trade_no", "2016090910595900000012");
try {
Map<String, String> resp = wxpay.orderQuery(data);
System.out.println(resp);
} catch (Exception e) {
e.printStackTrace();
}
}
}
```
退款查詢:
```java
import com.github.wxpay.sdk.WXPay;
import java.util.HashMap;
import java.util.Map;
public class WXPayExample {
public static void main(String[] args) throws Exception {
MyConfig config = new MyConfig();
WXPay wxpay = new WXPay(config);
Map<String, String> data = new HashMap<String, String>();
data.put("out_trade_no", "2016090910595900000012");
try {
Map<String, String> resp = wxpay.refundQuery(data);
System.out.println(resp);
} catch (Exception e) {
e.printStackTrace();
}
}
}
```
下載對賬單:
```java
import com.github.wxpay.sdk.WXPay;
import java.util.HashMap;
import java.util.Map;
public class WXPayExample {
public static void main(String[] args) throws Exception {
MyConfig config = new MyConfig();
WXPay wxpay = new WXPay(config);
Map<String, String> data = new HashMap<String, String>();
data.put("bill_date", "20140603");
data.put("bill_type", "ALL");
try {
Map<String, String> resp = wxpay.downloadBill(data);
System.out.println(resp);
} catch (Exception e) {
e.printStackTrace();
}
}
}
```
其他API的使用和上面類似。
暫時不支援下載壓縮格式的對賬單,但可以使用該SDK生成請求用的XML資料:
```java
import com.github.wxpay.sdk.WXPay;
import com.github.wxpay.sdk.WXPayUtil;
import java.util.HashMap;
import java.util.Map;
public class WXPayExample {
public static void main(String[] args) throws Exception {
MyConfig config = new MyConfig();
WXPay wxpay = new WXPay(config);
Map<String, String> data = new HashMap<String, String>();
data.put("bill_date", "20140603");
data.put("bill_type", "ALL");
data.put("tar_type", "GZIP");
try {
data = wxpay.fillRequestData(data);
System.out.println(WXPayUtil.mapToXml(data));
} catch (Exception e) {
e.printStackTrace();
}
}
}
```
收到支付結果通知時,需要驗證簽名,可以這樣做:
```java
import com.github.wxpay.sdk.WXPay;
import com.github.wxpay.sdk.WXPayUtil;
import java.util.Map;
public class WXPayExample {
public static void main(String[] args) throws Exception {
String notifyData = "...."; // 支付結果通知的xml格式資料
MyConfig config = new MyConfig();
WXPay wxpay = new WXPay(config);
Map<String, String> notifyMap = WXPayUtil.xmlToMap(notifyData); // 轉換成map
if (wxpay.isPayResultNotifySignatureValid(notifyMap)) {
// 簽名正確
// 進行處理。
// 注意特殊情況:訂單已經退款,但收到了支付結果成功的通知,不應把商戶側訂單狀態從退款改成支付成功
}
else {
// 簽名錯誤,如果資料裡沒有sign欄位,也認為是簽名錯誤
}
}
}
```
HTTPS請求可選HMAC-SHA256演算法和MD5演算法簽名:
```
import com.github.wxpay.sdk.WXPay;
import com.github.wxpay.sdk.WXPayConstants;
public class WXPayExample {
public static void main(String[] args) throws Exception {
MyConfig config = new MyConfig();
WXPay wxpay = new WXPay(config, WXPayConstants.SignType.HMACSHA256);
// ......
}
}
```
若需要使用sandbox環境:
```
import com.github.wxpay.sdk.WXPay;
import com.github.wxpay.sdk.WXPayConstants;
public class WXPayExample {
public static void main(String[] args) throws Exception {
MyConfig config = new MyConfig();
WXPay wxpay = new WXPay(config, WXPayConstants.SignType.MD5, true);
// ......
}
}