Skip to content

Commit e9e263a

Browse files
Copilotbinarywang
andauthored
文档:说明 wx-java-cp-multi-spring-boot-starter 中 corp-secret 的配置方式
- 增加 corp-secret 类型说明章节(自建应用/通讯录同步/客户联系) - 更新配置示例展示多种 Secret 同时使用的方式 - 改善 WxCpSingleProperties 的 Javadoc - 在 AbstractWxCpConfiguration 中增加设计意图注释 Agent-Logs-Url: https://github.com/binarywang/WxJava/sessions/c3b71887-e0c8-4297-b740-a39dc15c7d69 Co-authored-by: binarywang <1343140+binarywang@users.noreply.github.com>
1 parent 31ee4c0 commit e9e263a

File tree

6 files changed

+144
-78
lines changed

6 files changed

+144
-78
lines changed

solon-plugins/wx-java-cp-multi-solon-plugin/README.md

Lines changed: 40 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@
66
- 未实现 WxCpTpService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
77
- 未实现 WxCpCgService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
88

9+
## 关于 corp-secret 的说明
10+
11+
企业微信中不同功能模块对应不同的 `corp-secret`,每种 Secret 只对对应模块的接口具有调用权限:
12+
13+
| Secret 类型 | 获取位置 | 可调用的接口 | 是否需要 agent-id |
14+
|---|---|---|---|
15+
| 自建应用 Secret | 应用管理 → 自建应用 → 选择应用 → 查看 Secret | 该应用有权限的接口 | **必填** |
16+
| 通讯录同步 Secret | 管理工具 → 通讯录同步 → 查看 Secret | 部门/成员增删改查等通讯录接口 | **不填** |
17+
| 客户联系 Secret | 客户联系 → API → Secret | 客户联系相关接口 | 不填 |
18+
19+
> **常见问题**
20+
> - 使用自建应用 Secret + agent-id 可以获取部门列表,但**无法更新部门**(因为写接口需要通讯录同步权限)
21+
> - 使用通讯录同步 Secret 可以同步部门,但**调用某些需要 agent-id 的应用接口会报错**
22+
23+
如需同时使用多种权限范围,可在 `wx.cp.corps` 下配置多个条目,每个条目使用对应权限的 Secret,通过不同的 `tenantId` 区分后使用。
24+
925
## 快速开始
1026

1127
1. 引入依赖
@@ -18,25 +34,21 @@
1834
```
1935
2. 添加配置(app.properties)
2036
```properties
21-
# 应用 1 配置
22-
wx.cp.corps.tenantId1.corp-id = @corp-id
23-
wx.cp.corps.tenantId1.corp-secret = @corp-secret
37+
# 自建应用 1 配置(使用自建应用 Secret,需填写 agent-id)
38+
wx.cp.corps.app1.corp-id = @corp-id
39+
wx.cp.corps.app1.corp-secret = @自建应用的Secret(在"应用管理-自建应用"中查看)
40+
wx.cp.corps.app1.agent-id = @自建应用的AgentId
2441
## 选填
25-
wx.cp.corps.tenantId1.agent-id = @agent-id
26-
wx.cp.corps.tenantId1.token = @token
27-
wx.cp.corps.tenantId1.aes-key = @aes-key
28-
wx.cp.corps.tenantId1.msg-audit-priKey = @msg-audit-priKey
29-
wx.cp.corps.tenantId1.msg-audit-lib-path = @msg-audit-lib-path
30-
31-
# 应用 2 配置
32-
wx.cp.corps.tenantId2.corp-id = @corp-id
33-
wx.cp.corps.tenantId2.corp-secret = @corp-secret
34-
## 选填
35-
wx.cp.corps.tenantId2.agent-id = @agent-id
36-
wx.cp.corps.tenantId2.token = @token
37-
wx.cp.corps.tenantId2.aes-key = @aes-key
38-
wx.cp.corps.tenantId2.msg-audit-priKey = @msg-audit-priKey
39-
wx.cp.corps.tenantId2.msg-audit-lib-path = @msg-audit-lib-path
42+
wx.cp.corps.app1.token = @token
43+
wx.cp.corps.app1.aes-key = @aes-key
44+
wx.cp.corps.app1.msg-audit-priKey = @msg-audit-priKey
45+
wx.cp.corps.app1.msg-audit-lib-path = @msg-audit-lib-path
46+
47+
# 通讯录同步配置(使用通讯录同步 Secret,不需要填写 agent-id)
48+
# 此配置用于部门、成员的增删改查等通讯录管理操作
49+
wx.cp.corps.contact.corp-id = @corp-id
50+
wx.cp.corps.contact.corp-secret = @通讯录同步的Secret(在"管理工具-通讯录同步"中查看)
51+
## agent-id 不填,通讯录同步不需要 agentId
4052

4153
# 公共配置
4254
## ConfigStorage 配置(选填)
@@ -59,6 +71,7 @@
5971

6072
```java
6173
import com.binarywang.solon.wxjava.cp_multi.service.WxCpMultiServices;
74+
import me.chanjar.weixin.cp.api.WxCpDepartmentService;
6275
import me.chanjar.weixin.cp.api.WxCpService;
6376
import me.chanjar.weixin.cp.api.WxCpUserService;
6477
import org.noear.solon.annotation.Component;
@@ -70,27 +83,17 @@ public class DemoService {
7083
private WxCpMultiServices wxCpMultiServices;
7184

7285
public void test() {
73-
// 应用 1 的 WxCpService
74-
WxCpService wxCpService1 = wxCpMultiServices.getWxCpService("tenantId1");
75-
WxCpUserService userService1 = wxCpService1.getUserService();
76-
userService1.getUserId("xxx");
77-
// todo ...
78-
79-
// 应用 2 的 WxCpService
80-
WxCpService wxCpService2 = wxCpMultiServices.getWxCpService("tenantId2");
81-
WxCpUserService userService2 = wxCpService2.getUserService();
82-
userService2.getUserId("xxx");
86+
// 使用自建应用的 WxCpService(对应 corp-secret 为自建应用 Secret)
87+
WxCpService appService = wxCpMultiServices.getWxCpService("app1");
88+
WxCpUserService userService = appService.getUserService();
89+
userService.getUserId("xxx");
8390
// todo ...
8491

85-
// 应用 3 的 WxCpService
86-
WxCpService wxCpService3 = wxCpMultiServices.getWxCpService("tenantId3");
87-
// 判断是否为空
88-
if (wxCpService3 == null) {
89-
// todo wxCpService3 为空,请先配置 tenantId3 企业微信应用参数
90-
return;
91-
}
92-
WxCpUserService userService3 = wxCpService3.getUserService();
93-
userService3.getUserId("xxx");
92+
// 使用通讯录同步的 WxCpService(对应 corp-secret 为通讯录同步 Secret)
93+
// 通讯录同步 Secret 具有部门/成员增删改查等权限
94+
WxCpService contactService = wxCpMultiServices.getWxCpService("contact");
95+
WxCpDepartmentService departmentService = contactService.getDepartmentService();
96+
departmentService.update(department);
9497
// todo ...
9598
}
9699
}

solon-plugins/wx-java-cp-multi-solon-plugin/src/main/java/com/binarywang/solon/wxjava/cp_multi/configuration/services/AbstractWxCpConfiguration.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ protected WxCpMultiServices wxCpMultiServices(WxCpMultiProperties wxCpMultiPrope
3737
/**
3838
* 校验同一个企业下,agentId 是否唯一,避免使用 redis 缓存 token、ticket 时错乱。
3939
*
40+
* <p>同一企业(corpId 相同)下可配置多个条目以使用不同的权限 Secret,例如:
41+
* <ul>
42+
* <li>自建应用条目:填写应用对应的 corpSecret 和 agentId</li>
43+
* <li>通讯录同步条目:填写通讯录同步 Secret,agentId 可不填(null)</li>
44+
* </ul>
45+
* 但同一 corpId 下不允许出现重复的 agentId(包括多个 null)。
46+
* </p>
47+
*
4048
* 查看 {@link me.chanjar.weixin.cp.config.impl.AbstractWxCpInRedisConfigImpl#setAgentId(Integer)}
4149
*/
4250
Collection<WxCpSingleProperties> corpList = corps.values();

solon-plugins/wx-java-cp-multi-solon-plugin/src/main/java/com/binarywang/solon/wxjava/cp_multi/properties/WxCpSingleProperties.java

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@
88
/**
99
* 企业微信企业相关配置属性
1010
*
11+
* <p>企业微信中不同的 corpSecret 对应不同的权限范围,常见的有:</p>
12+
* <ul>
13+
* <li>自建应用 Secret:在"应用管理 - 自建应用"中查看,只能调用该应用有权限的接口</li>
14+
* <li>通讯录同步 Secret:在"管理工具 - 通讯录同步"中查看,用于管理部门和成员(增删改查)</li>
15+
* <li>客户联系 Secret:在"客户联系"中查看,用于客户联系相关接口</li>
16+
* </ul>
17+
* <p>如需同时使用多种权限范围(例如:既要操作通讯录,又要调用自建应用接口),
18+
* 可在 {@code wx.cp.corps} 下配置多个条目,每个条目使用对应权限的 {@code corpSecret},
19+
* 其中通讯录同步的条目无需填写 {@code agentId}。</p>
20+
*
1121
* @author yl
1222
* created on 2023/10/16
1323
*/
@@ -20,15 +30,27 @@ public class WxCpSingleProperties implements Serializable {
2030
*/
2131
private String corpId;
2232
/**
23-
* 微信企业号 corpSecret
33+
* 微信企业号 corpSecret(权限密钥)
34+
*
35+
* <p>企业微信针对不同的功能模块提供了不同的 Secret,每种 Secret 只对对应模块的接口有调用权限:</p>
36+
* <ul>
37+
* <li>自建应用 Secret:在"应用管理 - 自建应用"中找到对应应用,查看其 Secret,
38+
* 使用时需同时配置对应的 {@code agentId}</li>
39+
* <li>通讯录同步 Secret:在"管理工具 - 通讯录同步"中查看,
40+
* 使用此 Secret 可管理部门、成员,无需配置 {@code agentId}</li>
41+
* <li>其他 Secret(客户联系等):根据需要在企业微信后台查看对应 Secret</li>
42+
* </ul>
2443
*/
2544
private String corpSecret;
2645
/**
2746
* 微信企业号应用 token
2847
*/
2948
private String token;
3049
/**
31-
* 微信企业号应用 ID
50+
* 微信企业号应用 ID(AgentId)
51+
*
52+
* <p>使用自建应用 Secret 时,需要填写对应应用的 AgentId。</p>
53+
* <p>使用通讯录同步 Secret 时,无需填写此字段。</p>
3254
*/
3355
private Integer agentId;
3456
/**

spring-boot-starters/wx-java-cp-multi-spring-boot-starter/README.md

Lines changed: 40 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@
66
- 未实现 WxCpTpService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
77
- 未实现 WxCpCgService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
88

9+
## 关于 corp-secret 的说明
10+
11+
企业微信中不同功能模块对应不同的 `corp-secret`,每种 Secret 只对对应模块的接口具有调用权限:
12+
13+
| Secret 类型 | 获取位置 | 可调用的接口 | 是否需要 agent-id |
14+
|---|---|---|---|
15+
| 自建应用 Secret | 应用管理 → 自建应用 → 选择应用 → 查看 Secret | 该应用有权限的接口 | **必填** |
16+
| 通讯录同步 Secret | 管理工具 → 通讯录同步 → 查看 Secret | 部门/成员增删改查等通讯录接口 | **不填** |
17+
| 客户联系 Secret | 客户联系 → API → Secret | 客户联系相关接口 | 不填 |
18+
19+
> **常见问题**
20+
> - 使用自建应用 Secret + agent-id 可以获取部门列表,但**无法更新部门**(因为写接口需要通讯录同步权限)
21+
> - 使用通讯录同步 Secret 可以同步部门,但**调用某些需要 agent-id 的应用接口会报错**
22+
23+
如需同时使用多种权限范围,可在 `wx.cp.corps` 下配置多个条目,每个条目使用对应权限的 Secret,通过不同的 `tenantId` 区分后使用。
24+
925
## 快速开始
1026

1127
1. 引入依赖
@@ -18,25 +34,21 @@
1834
```
1935
2. 添加配置(application.properties)
2036
```properties
21-
# 应用 1 配置
22-
wx.cp.corps.tenantId1.corp-id = @corp-id
23-
wx.cp.corps.tenantId1.corp-secret = @corp-secret
37+
# 自建应用 1 配置(使用自建应用 Secret,需填写 agent-id)
38+
wx.cp.corps.app1.corp-id = @corp-id
39+
wx.cp.corps.app1.corp-secret = @自建应用的Secret(在"应用管理-自建应用"中查看)
40+
wx.cp.corps.app1.agent-id = @自建应用的AgentId
2441
## 选填
25-
wx.cp.corps.tenantId1.agent-id = @agent-id
26-
wx.cp.corps.tenantId1.token = @token
27-
wx.cp.corps.tenantId1.aes-key = @aes-key
28-
wx.cp.corps.tenantId1.msg-audit-priKey = @msg-audit-priKey
29-
wx.cp.corps.tenantId1.msg-audit-lib-path = @msg-audit-lib-path
30-
31-
# 应用 2 配置
32-
wx.cp.corps.tenantId2.corp-id = @corp-id
33-
wx.cp.corps.tenantId2.corp-secret = @corp-secret
34-
## 选填
35-
wx.cp.corps.tenantId2.agent-id = @agent-id
36-
wx.cp.corps.tenantId2.token = @token
37-
wx.cp.corps.tenantId2.aes-key = @aes-key
38-
wx.cp.corps.tenantId2.msg-audit-priKey = @msg-audit-priKey
39-
wx.cp.corps.tenantId2.msg-audit-lib-path = @msg-audit-lib-path
42+
wx.cp.corps.app1.token = @token
43+
wx.cp.corps.app1.aes-key = @aes-key
44+
wx.cp.corps.app1.msg-audit-priKey = @msg-audit-priKey
45+
wx.cp.corps.app1.msg-audit-lib-path = @msg-audit-lib-path
46+
47+
# 通讯录同步配置(使用通讯录同步 Secret,不需要填写 agent-id)
48+
# 此配置用于部门、成员的增删改查等通讯录管理操作
49+
wx.cp.corps.contact.corp-id = @corp-id
50+
wx.cp.corps.contact.corp-secret = @通讯录同步的Secret(在"管理工具-通讯录同步"中查看)
51+
## agent-id 不填,通讯录同步不需要 agentId
4052

4153
# 公共配置
4254
## ConfigStorage 配置(选填)
@@ -59,6 +71,7 @@
5971

6072
```java
6173
import com.binarywang.spring.starter.wxjava.cp.service.WxCpMultiServices;
74+
import me.chanjar.weixin.cp.api.WxCpDepartmentService;
6275
import me.chanjar.weixin.cp.api.WxCpService;
6376
import me.chanjar.weixin.cp.api.WxCpUserService;
6477
import org.springframework.beans.factory.annotation.Autowired;
@@ -70,27 +83,17 @@ public class DemoService {
7083
private WxCpMultiServices wxCpMultiServices;
7184

7285
public void test() {
73-
// 应用 1 的 WxCpService
74-
WxCpService wxCpService1 = wxCpMultiServices.getWxCpService("tenantId1");
75-
WxCpUserService userService1 = wxCpService1.getUserService();
76-
userService1.getUserId("xxx");
77-
// todo ...
78-
79-
// 应用 2 的 WxCpService
80-
WxCpService wxCpService2 = wxCpMultiServices.getWxCpService("tenantId2");
81-
WxCpUserService userService2 = wxCpService2.getUserService();
82-
userService2.getUserId("xxx");
86+
// 使用自建应用的 WxCpService(对应 corp-secret 为自建应用 Secret)
87+
WxCpService appService = wxCpMultiServices.getWxCpService("app1");
88+
WxCpUserService userService = appService.getUserService();
89+
userService.getUserId("xxx");
8390
// todo ...
8491

85-
// 应用 3 的 WxCpService
86-
WxCpService wxCpService3 = wxCpMultiServices.getWxCpService("tenantId3");
87-
// 判断是否为空
88-
if (wxCpService3 == null) {
89-
// todo wxCpService3 为空,请先配置 tenantId3 企业微信应用参数
90-
return;
91-
}
92-
WxCpUserService userService3 = wxCpService3.getUserService();
93-
userService3.getUserId("xxx");
92+
// 使用通讯录同步的 WxCpService(对应 corp-secret 为通讯录同步 Secret)
93+
// 通讯录同步 Secret 具有部门/成员增删改查等权限
94+
WxCpService contactService = wxCpMultiServices.getWxCpService("contact");
95+
WxCpDepartmentService departmentService = contactService.getDepartmentService();
96+
departmentService.update(department);
9497
// todo ...
9598
}
9699
}

spring-boot-starters/wx-java-cp-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/cp/configuration/services/AbstractWxCpConfiguration.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,14 @@ protected WxCpMultiServices wxCpMultiServices(WxCpMultiProperties wxCpMultiPrope
4040
/**
4141
* 校验同一个企业下,agentId 是否唯一,避免使用 redis 缓存 token、ticket 时错乱。
4242
*
43+
* <p>同一企业(corpId 相同)下可配置多个条目以使用不同的权限 Secret,例如:
44+
* <ul>
45+
* <li>自建应用条目:填写应用对应的 corpSecret 和 agentId</li>
46+
* <li>通讯录同步条目:填写通讯录同步 Secret,agentId 可不填(null)</li>
47+
* </ul>
48+
* 但同一 corpId 下不允许出现重复的 agentId(包括多个 null)。
49+
* </p>
50+
*
4351
* 查看 {@link me.chanjar.weixin.cp.config.impl.AbstractWxCpInRedisConfigImpl#setAgentId(Integer)}
4452
*/
4553
Collection<WxCpSingleProperties> corpList = corps.values();

spring-boot-starters/wx-java-cp-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/cp/properties/WxCpSingleProperties.java

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@
88
/**
99
* 企业微信企业相关配置属性
1010
*
11+
* <p>企业微信中不同的 corpSecret 对应不同的权限范围,常见的有:</p>
12+
* <ul>
13+
* <li>自建应用 Secret:在"应用管理 - 自建应用"中查看,只能调用该应用有权限的接口</li>
14+
* <li>通讯录同步 Secret:在"管理工具 - 通讯录同步"中查看,用于管理部门和成员(增删改查)</li>
15+
* <li>客户联系 Secret:在"客户联系"中查看,用于客户联系相关接口</li>
16+
* </ul>
17+
* <p>如需同时使用多种权限范围(例如:既要操作通讯录,又要调用自建应用接口),
18+
* 可在 {@code wx.cp.corps} 下配置多个条目,每个条目使用对应权限的 {@code corpSecret},
19+
* 其中通讯录同步的条目无需填写 {@code agentId}。</p>
20+
*
1121
* @author yl
1222
* created on 2023/10/16
1323
*/
@@ -20,15 +30,27 @@ public class WxCpSingleProperties implements Serializable {
2030
*/
2131
private String corpId;
2232
/**
23-
* 微信企业号 corpSecret
33+
* 微信企业号 corpSecret(权限密钥)
34+
*
35+
* <p>企业微信针对不同的功能模块提供了不同的 Secret,每种 Secret 只对对应模块的接口有调用权限:</p>
36+
* <ul>
37+
* <li>自建应用 Secret:在"应用管理 - 自建应用"中找到对应应用,查看其 Secret,
38+
* 使用时需同时配置对应的 {@code agentId}</li>
39+
* <li>通讯录同步 Secret:在"管理工具 - 通讯录同步"中查看,
40+
* 使用此 Secret 可管理部门、成员,无需配置 {@code agentId}</li>
41+
* <li>其他 Secret(客户联系等):根据需要在企业微信后台查看对应 Secret</li>
42+
* </ul>
2443
*/
2544
private String corpSecret;
2645
/**
2746
* 微信企业号应用 token
2847
*/
2948
private String token;
3049
/**
31-
* 微信企业号应用 ID
50+
* 微信企业号应用 ID(AgentId)
51+
*
52+
* <p>使用自建应用 Secret 时,需要填写对应应用的 AgentId。</p>
53+
* <p>使用通讯录同步 Secret 时,无需填写此字段。</p>
3254
*/
3355
private Integer agentId;
3456
/**

0 commit comments

Comments
 (0)