Skip to content

Commit 52471fc

Browse files
0katekate00katekate0
authored
🎨 完善微信支付部分文档
1 parent 05f0fa2 commit 52471fc

8 files changed

Lines changed: 155 additions & 23 deletions

File tree

‎spring-boot-starters/wx-java-pay-spring-boot-starter/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
</dependency>
99
```
1010
2. 添加配置(application.yml)
11+
###### 1）V2版本
1112
```yml
1213
wx:
1314
pay:
@@ -18,6 +19,17 @@ wx:
1819
subMchId:
1920
keyPath:
2021
```
22+
###### 2）V3版本
23+
```yml
24+
wx:
25+
pay:
26+
appId: xxxxxxxxxxx
27+
mchId: 15xxxxxxxxx #商户id
28+
apiV3Key: Dc1DBwSc094jACxxxxxxxxxxxxxxx #V3密钥
29+
certSerialNo: 62C6CEAA360BCxxxxxxxxxxxxxxx
30+
privateKeyPath: classpath:cert/apiclient_key.pem #apiclient_key.pem证书文件的绝对路径或者以classpath:开头的类路径
31+
privateCertPath: classpath:cert/apiclient_cert.pem #apiclient_cert.pem证书文件的绝对路径或者以classpath:开头的类路径
32+
```
2133
2234
2335

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import me.chanjar.weixin.cp.bean.WxCpUser;
66
import me.chanjar.weixin.cp.bean.WxCpUseridToOpenUseridResult;
77
import me.chanjar.weixin.cp.bean.external.contact.WxCpExternalContactInfo;
8+
import me.chanjar.weixin.cp.bean.user.WxCpDeptUserResult;
89

910
import java.util.ArrayList;
1011
import java.util.Date;
@@ -224,9 +225,25 @@ public interface WxCpUserService {
224225
* userid转换为open_userid
225226
* 将自建应用或代开发应用获取的userid转换为第三方应用的userid
226227
* https://developer.work.weixin.qq.com/document/path/95603
228+
*
227229
* @param useridList
228230
* @return the WxCpUseridToOpenUseridResult
229231
* @throws WxErrorException
230232
*/
231233
WxCpUseridToOpenUseridResult useridToOpenUserid(ArrayList<String> useridList) throws WxErrorException;
234+
235+
/**
236+
* 获取成员ID列表
237+
* 获取企业成员的userid与对应的部门ID列表，预计于2022年8月8号发布。若需要获取其他字段，参见「适配建议」。
238+
* <p>
239+
* 请求方式：POST（HTTPS）
240+
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/list_id?access_token=ACCESS_TOKEN
241+
*
242+
* @param cursor
243+
* @param limit
244+
* @return
245+
* @throws WxErrorException
246+
*/
247+
WxCpDeptUserResult getUserListId(String cursor, Integer limit) throws WxErrorException;
248+
232249
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpUserServiceImpl.java‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
import me.chanjar.weixin.cp.bean.WxCpUser;
1515
import me.chanjar.weixin.cp.bean.WxCpUseridToOpenUseridResult;
1616
import me.chanjar.weixin.cp.bean.external.contact.WxCpExternalContactInfo;
17-
import me.chanjar.weixin.cp.constant.WxCpApiPathConsts;
17+
import me.chanjar.weixin.cp.bean.user.WxCpDeptUserResult;
1818
import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
1919
import org.apache.commons.lang3.time.FastDateFormat;
2020

@@ -231,7 +231,7 @@ public Integer getActiveStat(Date date) throws WxErrorException {
231231
public WxCpUseridToOpenUseridResult useridToOpenUserid(ArrayList<String> useridList) throws WxErrorException {
232232
JsonObject jsonObject = new JsonObject();
233233
JsonArray jsonArray = new JsonArray();
234-
for(String userid:useridList){
234+
for (String userid : useridList) {
235235
jsonArray.add(userid);
236236
}
237237
jsonObject.add("userid_list", jsonArray);
@@ -240,4 +240,19 @@ public WxCpUseridToOpenUseridResult useridToOpenUserid(ArrayList<String> useridL
240240
return WxCpUseridToOpenUseridResult.fromJson(responseContent);
241241
}
242242

243+
@Override
244+
public WxCpDeptUserResult getUserListId(String cursor, Integer limit) throws WxErrorException {
245+
String apiUrl = this.mainService.getWxCpConfigStorage().getApiUrl(USER_LIST_ID);
246+
JsonObject jsonObject = new JsonObject();
247+
if (cursor != null) {
248+
jsonObject.addProperty("cursor", cursor);
249+
}
250+
if (limit != null) {
251+
jsonObject.addProperty("limit", limit);
252+
}
253+
String responseContent = this.mainService.post(apiUrl, jsonObject.toString());
254+
return WxCpDeptUserResult.fromJson(responseContent);
255+
}
256+
257+
243258
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/user/WxCpDeptUserResult.java‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
package me.chanjar.weixin.cp.bean.user;
2+
3+
import com.google.gson.annotations.SerializedName;
4+
import lombok.Data;
5+
import lombok.Getter;
6+
import lombok.Setter;
7+
import me.chanjar.weixin.cp.bean.WxCpBaseResp;
8+
import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
9+
10+
import java.io.Serializable;
11+
import java.util.List;
12+
13+
/**
14+
* 获取成员ID列表返回参数
15+
*
16+
* @author <a href="https://gitee.com/Wang_Wong/">Wang_Wong</a>
17+
* @date 2022/08/09
18+
*/
19+
@Data
20+
public class WxCpDeptUserResult extends WxCpBaseResp {
21+
private static final long serialVersionUID = 1420065684270213578L;
22+
23+
@SerializedName("next_cursor")
24+
private String nextCursor;
25+
26+
@SerializedName("dept_user")
27+
private List<DeptUserList> deptUser;
28+
29+
@Getter
30+
@Setter
31+
public static class DeptUserList implements Serializable {
32+
private static final long serialVersionUID = 1420065684270213578L;
33+
34+
@SerializedName("userid")
35+
private String userId;
36+
37+
@SerializedName("department")
38+
private Long department;
39+
40+
public static DeptUserList fromJson(String json) {
41+
return WxCpGsonBuilder.create().fromJson(json, DeptUserList.class);
42+
}
43+
44+
public String toJson() {
45+
return WxCpGsonBuilder.create().toJson(this);
46+
}
47+
48+
}
49+
50+
public static WxCpDeptUserResult fromJson(String json) {
51+
return WxCpGsonBuilder.create().fromJson(json, WxCpDeptUserResult.class);
52+
}
53+
54+
public String toJson() {
55+
return WxCpGsonBuilder.create().toJson(this);
56+
}
57+
58+
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/constant/WxCpApiPathConsts.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,8 @@ interface User {
325325
String GET_JOIN_QR_CODE = "/cgi-bin/corp/get_join_qrcode?size_type=";
326326
String GET_ACTIVE_STAT = "/cgi-bin/user/get_active_stat";
327327
String USERID_TO_OPEN_USERID = "/cgi-bin/batch/userid_to_openuserid";
328+
329+
String USER_LIST_ID = "/cgi-bin/user/list_id";
328330
}
329331

330332
interface ExternalContact {

‎weixin-java-cp/src/test/java/me/chanjar/weixin/cp/api/impl/WxCpDepartmentServiceImplTest.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,13 @@ public void testDelete() throws Exception {
7272
this.wxCpService.getDepartmentService().delete(this.depart.getId());
7373
}
7474

75+
/**
76+
* 获取子部门ID列表
77+
* https://developer.work.weixin.qq.com/document/path/95350
78+
*
79+
* @param id
80+
* @throws WxErrorException
81+
*/
7582
@Test(dataProvider = "departIds")
7683
public void testSimpleList(Long id) throws WxErrorException {
7784
System.out.println("=================获取子部门ID列表");

‎weixin-java-cp/src/test/java/me/chanjar/weixin/cp/api/impl/WxCpUserServiceImplTest.java‎

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
package me.chanjar.weixin.cp.api.impl;
22

3-
import java.util.Date;
4-
import java.util.List;
5-
import java.util.Map;
6-
7-
import org.apache.commons.lang3.builder.ToStringBuilder;
8-
import org.apache.commons.lang3.builder.ToStringStyle;
9-
import org.testng.annotations.*;
10-
113
import com.google.common.collect.Lists;
124
import com.google.inject.Inject;
5+
import lombok.extern.slf4j.Slf4j;
136
import me.chanjar.weixin.common.error.WxErrorException;
147
import me.chanjar.weixin.cp.api.ApiTestModule;
158
import me.chanjar.weixin.cp.api.WxCpService;
169
import me.chanjar.weixin.cp.bean.Gender;
1710
import me.chanjar.weixin.cp.bean.WxCpInviteResult;
1811
import me.chanjar.weixin.cp.bean.WxCpUser;
12+
import me.chanjar.weixin.cp.bean.user.WxCpDeptUserResult;
13+
import org.apache.commons.lang3.builder.ToStringBuilder;
14+
import org.apache.commons.lang3.builder.ToStringStyle;
15+
import org.testng.annotations.Guice;
16+
import org.testng.annotations.Test;
1917

20-
import static org.testng.Assert.*;
18+
import java.util.Date;
19+
import java.util.List;
20+
import java.util.Map;
21+
22+
import static org.testng.Assert.assertNotEquals;
23+
import static org.testng.Assert.assertNotNull;
2124

2225
/**
2326
* <pre>
@@ -26,6 +29,7 @@
2629
*
2730
* @author <a href="https://github.com/binarywang">Binary Wang</a>
2831
*/
32+
@Slf4j
2933
@Guice(modules = ApiTestModule.class)
3034
public class WxCpUserServiceImplTest {
3135
@Inject
@@ -129,4 +133,20 @@ public void testGetActiveStat() throws WxErrorException {
129133
System.out.printf("active stat: %d", activeStat);
130134
assertNotNull(activeStat);
131135
}
136+
137+
/**
138+
* 获取成员ID列表
139+
* 获取企业成员的userid与对应的部门ID列表，预计于2022年8月8号发布。若需要获取其他字段，参见「适配建议」。
140+
* <p>
141+
* https://developer.work.weixin.qq.com/document/40856
142+
*
143+
* @throws WxErrorException
144+
*/
145+
@Test
146+
public void testGetUserListId() throws WxErrorException {
147+
WxCpDeptUserResult result = this.wxCpService.getUserService().getUserListId(null, 10);
148+
log.info("返回结果为：{}", result.toJson());
149+
assertNotNull(result);
150+
}
151+
132152
}

‎weixin-java-pay/src/test/resources/test-config.sample.xml‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
<xml>
22
<appId>公众号appid</appId>
33
<mchId>微信商户平台ID</mchId>
4-
<mchKey>商户平台设置的API密钥</mchKey>
54
<!---
6-
以下为官网文档所提供样例参数，仅供部分接口测试使用
7-
<appId>wxd930ea5d5a258f4f</appId>
8-
<mchId>10000100</mchId>
9-
<mchKey>192006250b4c09247ec02edce69f6a2d</mchKey>
10-
-->
5+
以下为官网文档所提供样例参数，仅供部分接口测试使用
6+
<appId>wxd930ea5d5a258f4f</appId>
7+
<mchId>10000100</mchId>
8+
<mchKey>192006250b4c09247ec02edce69f6a2d</mchKey>
9+
-->
10+
<!-- v2版本 -->
11+
<mchKey>商户平台设置的API密钥</mchKey>
1112
<keyPath>商户平台的证书文件地址</keyPath>
12-
<openid>某个openId</openid>
1313

14-
<!--
15-
apiv3 模式下所需配置
16-
<privateKeyPath>apiclient_key.pem证书文件的绝对路径或者以classpath:开头的类路径.</privateKeyPath>
17-
<privateCertPath>apiclient_cert.pem证书文件的绝对路径或者以classpath:开头的类路径.</privateCertPath>
14+
<!-- v3版本 模式下所需配置 -->
1815
<apiV3Key> apiV3 秘钥值.</apiV3Key>
1916
<certSerialNo>apiV3 证书序列号值</certSerialNo>
20-
-->
17+
<privateKeyPath>apiclient_key.pem证书文件的绝对路径或者以classpath:开头的类路径.</privateKeyPath>
18+
<privateCertPath>apiclient_cert.pem证书文件的绝对路径或者以classpath:开头的类路径.</privateCertPath>
19+
20+
<!-- other配置 -->
21+
<openid>某个openId</openid>
2122
</xml>

0 commit comments

Comments
 (0)