mirror of
https://github.com/dromara/payment-spring-boot.git
synced 2026-03-14 05:43:46 +08:00
223 lines
7.2 KiB
Markdown
223 lines
7.2 KiB
Markdown
# 移动支付 Spring Boot 组件
|
||
提供聚合支付能力。
|
||
|
||
## 支持类型
|
||
|
||
- [x] **微信支付V2** 只提供V3不支持的部分，后续全面切向V3。
|
||
- [x] **微信支付V3** 全量支持。
|
||
- [x] **支付宝** 提供所有实现，具体以签约项目为准。
|
||
- [ ] **银联支付** 施工中……
|
||
|
||
## 采用技术
|
||
- Spring
|
||
- Jackson
|
||
- Okhttp
|
||
- Ali-pay-sdk
|
||
## 使用方法
|
||
### 集成
|
||
以**Spring Boot Starter**的形式集成到项目中。
|
||
|
||
```xml
|
||
<dependency>
|
||
<groupId>com.enongm.dianji</groupId>
|
||
<artifactId>payment-spring-boot-autoconfigure</artifactId>
|
||
<version>1.0.0.RELEASE</version>
|
||
</dependency>
|
||
```
|
||
### 配置
|
||
#### 微信支付
|
||
在Spring Boot项目中的`application.yaml`中配置`wechat.pay`相关参数。
|
||
```yaml
|
||
wechat:
|
||
pay:
|
||
v3:
|
||
# 沙盒模式 默认不开启 用于开发测试
|
||
sandbox-mode: true
|
||
# 服务商模式 默认不开启
|
||
partner-mode: false
|
||
# 应用appId 必填
|
||
app-id: wx55a89ae92r5d3b98
|
||
# api 密钥 必填
|
||
app-secret: 13194913301
|
||
# api v3 密钥 必填
|
||
app-v3-secret: 0e5f4fbd1333a3b44927e4355703ec
|
||
# 微信支付商户号 必填
|
||
mch-id: 1602325555
|
||
# 合作商 选填
|
||
partner-key:
|
||
# 商户服务器域名 用于回调 需要放开回调接口的安全策略 必填
|
||
domain: https://127.0.0.1
|
||
# 商户 api 证书 必填
|
||
cert-path: apiclient_cert.p12
|
||
```
|
||
然后启用`@EnableWechatPay`注解：
|
||
```java
|
||
@EnableMobilePay
|
||
@Configuration
|
||
public class PayConfig {
|
||
}
|
||
```
|
||
> 请注意：只有`wechat.pay.v3.app-id`设置了有效值才能启用下面的API。
|
||
##### API使用
|
||
微信支付 V2、V3开放接口引入：
|
||
```java
|
||
@Autowired
|
||
WechatPayV3Service wechatPayV3Service;
|
||
@Autowired
|
||
WechatPayV2Service wechatPayV2Service;
|
||
```
|
||
###### V2
|
||
例如V2转账到微信零钱：
|
||
```java
|
||
PayToWechatModel model = new PayToWechatModel();
|
||
model.setDesc("test");
|
||
model.setAmount("10000");
|
||
model.setDeviceInfo("IOS");
|
||
model.setOpenid("wx1232131231256655");
|
||
model.setPartnerTradeNo("X323994343345");
|
||
model.setSpbillCreateIp("127.0.0.1");
|
||
WechatResponseBody responseBody = wechatPayV2Service.model(model)
|
||
.payType(V2PayType.PAY_TO_WECHAT)
|
||
.request();
|
||
|
||
System.out.println("responseBody = " + responseBody);
|
||
```
|
||
打印返回（虚假的openId 预期结果应该是成功的）：
|
||
```
|
||
responseBody = WechatResponseBody(returnCode=SUCCESS, returnMsg=参数错误:openid字段不正确,请检查是否合法, mchAppid=wx55a75ae9fd5d3b98, mchid=1603257459, deviceInfo=null, nonceStr=null, resultCode=FAIL, errCode=PARAM_ERROR, errCodeDes=参数错误:openid输入有误, partnerTradeNo=null, paymentNo=null, paymentTime=null)
|
||
```
|
||
###### V3
|
||
例如V3 APP 支付
|
||
|
||
```java
|
||
/**
|
||
* App pay test.
|
||
*/
|
||
@Test
|
||
public void appPayTest() {
|
||
wechatPayV3Service
|
||
.request(baseModel -> new V3PayTypeBodyAndConsumer(V3PayType.APP,
|
||
baseModel.jsonBody()
|
||
,System.out::println))
|
||
.withModel(appPayModel());
|
||
}
|
||
|
||
|
||
|
||
/**
|
||
* 构造参数
|
||
*/
|
||
private static AppPayModel appPayModel() {
|
||
AppPayModel appPayModel = new AppPayModel();
|
||
|
||
appPayModel.setGoodsTag("WXG");
|
||
appPayModel.setNotifyUrl("/callback/app");
|
||
appPayModel.setDescription("中国移动-手机充值");
|
||
appPayModel.setOutTradeNo("100862342355223");
|
||
|
||
Amount amount = new Amount();
|
||
amount.setTotal(1000);
|
||
appPayModel.setAmount(amount);
|
||
|
||
SceneInfo sceneInfo = new SceneInfo();
|
||
|
||
sceneInfo.setDeviceId("12312");
|
||
sceneInfo.setPayerClientIp("129.122.0.1");
|
||
|
||
StoreInfo storeInfo = new StoreInfo();
|
||
storeInfo.setAddress("cn");
|
||
storeInfo.setAreaCode("471800");
|
||
storeInfo.setId("232313213");
|
||
storeInfo.setName("jack");
|
||
|
||
sceneInfo.setStoreInfo(storeInfo);
|
||
|
||
H5Info h5Info = new H5Info();
|
||
|
||
h5Info.setAppName("APP");
|
||
h5Info.setAppUrl("https://felord");
|
||
h5Info.setBundleId("1313213");
|
||
h5Info.setPackageName("com.dj");
|
||
h5Info.setType("IOS");
|
||
|
||
// sceneInfo.setH5Info(h5Info);
|
||
|
||
appPayModel.setSceneInfo(sceneInfo);
|
||
return appPayModel;
|
||
}
|
||
```
|
||
|
||
打印参数：
|
||
```json
|
||
{"prepay_id":"wx0414551907326482fbd40b51189c3e0000"}
|
||
```
|
||
|
||
#### 支付宝
|
||
##### 使用须知
|
||
请注意因为未来**SHA1withRSA**将被淘汰，因此采用最新的**SHA256withRSA**证书，旧的模式将不提供支持。步骤如下：
|
||
|
||
1.使用支付宝开发助手申请CSR文件
|
||
|
||
申请成功后看文件说明：
|
||
|
||
2.上传CSR设置证书
|
||
|
||
上传成功后需要下载证书，和配置的对应关系为：
|
||
|
||
3. 其它开发平台商户平台的配置，参考支付宝接入文档。
|
||
##### 项目开发配置
|
||
在Spring Boot项目中的`application.yaml`中配置`ali.pay`相关参数。
|
||
```yaml
|
||
ali:
|
||
pay:
|
||
v1:
|
||
# 可以替换为沙箱
|
||
server-url: https://openapi.alipaydev.com/gateway.do
|
||
# 蚂蚁开放平台申请并认证的应用appId
|
||
app-id: 2016102700769563
|
||
app-private-key-path: META-INF/app_rsa
|
||
alipay-public-cert-path: META-INF/alipayCertPublicKey_RSA2.crt
|
||
alipay-root-cert-path: META-INF/alipayRootCert.crt
|
||
app-cert-public-key-path: META-INF/appCertPublicKey_2016102700769563.crt
|
||
charset: utf-8
|
||
format: json
|
||
sign-type: RSA2
|
||
```
|
||
> 请注意：只有`ali.pay.v1.app-id`设置了有效值才能启用下面的API。
|
||
##### API的使用
|
||
|
||
引入接口：
|
||
```java
|
||
@Autowired
|
||
AlipayClient alipayClient;
|
||
```
|
||
调用，以现金红包为例：
|
||
```java
|
||
@SneakyThrows
|
||
public void campaignCash() {
|
||
AlipayMarketingCampaignCashCreateRequest request = new AlipayMarketingCampaignCashCreateRequest();
|
||
request.setBizContent("{" +
|
||
"\"coupon_name\":\"XXX周年庆红包\"," +
|
||
"\"prize_type\":\"random\"," +
|
||
"\"total_money\":\"10000.00\"," +
|
||
"\"total_num\":\"1000\"," +
|
||
"\"prize_msg\":\"XXX送您大红包\"," +
|
||
"\"start_time\":\"2020-11-02 22:48:30\"," +
|
||
"\"end_time\":\"2020-12-01 22:48:30\"," +
|
||
"\"merchant_link\":\"http://www.weibo.com\"," +
|
||
"\"send_freqency\":\"D3|L10\"" +
|
||
" }");
|
||
|
||
AlipayMarketingCampaignCashCreateResponse execute = alipayClient.certificateExecute(request);
|
||
|
||
System.out.println("execute = " + execute.getBody());
|
||
}
|
||
```
|
||
打印响应体：
|
||
```json
|
||
{"alipay_marketing_campaign_cash_create_response":{"code":"40004","msg":"Business Failed","sub_code":"isv.UNKNOW_SYSTEM_ERROR","sub_msg":"系统繁忙，请稍后再试"},"alipay_cert_sn":"e65893247c520d9d46db3000158505ee","sign":"M7gyi6ZwnRoHmdzd1IIxLc+XEE1pCx6ptOyQP4aRGMc01bJebNL7PbMpfU7TcB75KHmk3Oor2fYZfVEB7+5gxV9YwMuW3QtZbyACw3Gzt7wz4D1YCXkQD9PRvSsgw8xgNL+WnZxEI2yFdSp47Mc/Um73M101zFeo2dYKYXyVRdsGxnipY8fZs0JaXlX5OoROfHDcbvzBDjQyernspIoFoNiAwpaBwyQcEzh8V34ca4Rep/LSyI4N4VtU0n2nq3dO0Jor36n0o4j0QobWSE3c8StkVjbdP5XJB+adE51MUmh7xDdixQXE2fTRKw5wYlBO9O3bpF/uw78hWW/y3JwG9Q=="}
|
||
```
|
||
## CHANGELOG
|
||
### 1.0.0.RELEASE
|
||
|
||
- 支持微信支付、支付宝支付 |