📝 明确说明 wx-java-cp-multi-spring-boot-starter 中 corp-secret 的配置方式
This commit is contained in:
@@ -6,6 +6,25 @@
|
|||||||
- 未实现 WxCpTpService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
|
- 未实现 WxCpTpService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
|
||||||
- 未实现 WxCpCgService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
|
- 未实现 WxCpCgService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
|
||||||
|
|
||||||
|
## 关于 corp-secret 的说明
|
||||||
|
|
||||||
|
企业微信中不同功能模块对应不同的 `corp-secret`,每种 Secret 只对对应模块的接口具有调用权限:
|
||||||
|
|
||||||
|
| Secret 类型 | 获取位置 | 可调用的接口 | 是否需要 agent-id |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 自建应用 Secret | 应用管理 → 自建应用 → 选择应用 → 查看 Secret | 该应用有权限的接口 | **必填** |
|
||||||
|
| 通讯录同步 Secret | 管理工具 → 通讯录同步 → 查看 Secret | 部门/成员增删改查等通讯录接口 | **不填** |
|
||||||
|
| 客户联系 Secret | 客户联系 → API → Secret | 客户联系相关接口 | 不填 |
|
||||||
|
|
||||||
|
> **常见问题**:
|
||||||
|
> - 使用自建应用 Secret + agent-id 可以获取部门列表,但**无法更新部门**(因为写接口需要通讯录同步权限)
|
||||||
|
> - 使用通讯录同步 Secret 可以同步部门,但**调用某些需要 agent-id 的应用接口会报错**
|
||||||
|
|
||||||
|
如需同时使用多种权限范围,可在 `wx.cp.corps` 下配置多个条目,每个条目使用对应权限的 Secret,通过不同的 `tenantId` 区分后使用。
|
||||||
|
|
||||||
|
> **注意**:
|
||||||
|
> 当前插件实现会校验同一 `corp-id` 下的 `agent-id` **必须唯一**,并且 **只能有一个条目不填写 `agent-id`**。
|
||||||
|
> 如果在同一 `corp-id` 下同时配置多个未填写 `agent-id` 的条目,会因 token/ticket 缓存 key 冲突而在启动时直接抛异常。
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
1. 引入依赖
|
1. 引入依赖
|
||||||
@@ -18,25 +37,21 @@
|
|||||||
```
|
```
|
||||||
2. 添加配置(app.properties)
|
2. 添加配置(app.properties)
|
||||||
```properties
|
```properties
|
||||||
# 应用 1 配置
|
# 自建应用 1 配置(使用自建应用 Secret,需填写 agent-id)
|
||||||
wx.cp.corps.tenantId1.corp-id = @corp-id
|
wx.cp.corps.app1.corp-id = @corp-id
|
||||||
wx.cp.corps.tenantId1.corp-secret = @corp-secret
|
wx.cp.corps.app1.corp-secret = @自建应用的Secret(在"应用管理-自建应用"中查看)
|
||||||
|
wx.cp.corps.app1.agent-id = @自建应用的AgentId
|
||||||
## 选填
|
## 选填
|
||||||
wx.cp.corps.tenantId1.agent-id = @agent-id
|
wx.cp.corps.app1.token = @token
|
||||||
wx.cp.corps.tenantId1.token = @token
|
wx.cp.corps.app1.aes-key = @aes-key
|
||||||
wx.cp.corps.tenantId1.aes-key = @aes-key
|
wx.cp.corps.app1.msg-audit-priKey = @msg-audit-priKey
|
||||||
wx.cp.corps.tenantId1.msg-audit-priKey = @msg-audit-priKey
|
wx.cp.corps.app1.msg-audit-lib-path = @msg-audit-lib-path
|
||||||
wx.cp.corps.tenantId1.msg-audit-lib-path = @msg-audit-lib-path
|
|
||||||
|
|
||||||
# 应用 2 配置
|
# 通讯录同步配置(使用通讯录同步 Secret,不需要填写 agent-id)
|
||||||
wx.cp.corps.tenantId2.corp-id = @corp-id
|
# 此配置用于部门、成员的增删改查等通讯录管理操作
|
||||||
wx.cp.corps.tenantId2.corp-secret = @corp-secret
|
wx.cp.corps.contact.corp-id = @corp-id
|
||||||
## 选填
|
wx.cp.corps.contact.corp-secret = @通讯录同步的Secret(在"管理工具-通讯录同步"中查看)
|
||||||
wx.cp.corps.tenantId2.agent-id = @agent-id
|
## agent-id 不填,通讯录同步不需要 agentId
|
||||||
wx.cp.corps.tenantId2.token = @token
|
|
||||||
wx.cp.corps.tenantId2.aes-key = @aes-key
|
|
||||||
wx.cp.corps.tenantId2.msg-audit-priKey = @msg-audit-priKey
|
|
||||||
wx.cp.corps.tenantId2.msg-audit-lib-path = @msg-audit-lib-path
|
|
||||||
|
|
||||||
# 公共配置
|
# 公共配置
|
||||||
## ConfigStorage 配置(选填)
|
## ConfigStorage 配置(选填)
|
||||||
@@ -59,8 +74,10 @@
|
|||||||
|
|
||||||
```java
|
```java
|
||||||
import com.binarywang.solon.wxjava.cp_multi.service.WxCpMultiServices;
|
import com.binarywang.solon.wxjava.cp_multi.service.WxCpMultiServices;
|
||||||
|
import me.chanjar.weixin.cp.api.WxCpDepartmentService;
|
||||||
import me.chanjar.weixin.cp.api.WxCpService;
|
import me.chanjar.weixin.cp.api.WxCpService;
|
||||||
import me.chanjar.weixin.cp.api.WxCpUserService;
|
import me.chanjar.weixin.cp.api.WxCpUserService;
|
||||||
|
import me.chanjar.weixin.cp.bean.WxCpDepart;
|
||||||
import org.noear.solon.annotation.Component;
|
import org.noear.solon.annotation.Component;
|
||||||
import org.noear.solon.annotation.Inject;
|
import org.noear.solon.annotation.Inject;
|
||||||
|
|
||||||
@@ -70,27 +87,21 @@ public class DemoService {
|
|||||||
private WxCpMultiServices wxCpMultiServices;
|
private WxCpMultiServices wxCpMultiServices;
|
||||||
|
|
||||||
public void test() {
|
public void test() {
|
||||||
// 应用 1 的 WxCpService
|
// 使用自建应用的 WxCpService(对应 corp-secret 为自建应用 Secret)
|
||||||
WxCpService wxCpService1 = wxCpMultiServices.getWxCpService("tenantId1");
|
WxCpService appService = wxCpMultiServices.getWxCpService("app1");
|
||||||
WxCpUserService userService1 = wxCpService1.getUserService();
|
WxCpUserService userService = appService.getUserService();
|
||||||
userService1.getUserId("xxx");
|
userService.getUserId("xxx");
|
||||||
// todo ...
|
// todo ...
|
||||||
|
|
||||||
// 应用 2 的 WxCpService
|
// 使用通讯录同步的 WxCpService(对应 corp-secret 为通讯录同步 Secret)
|
||||||
WxCpService wxCpService2 = wxCpMultiServices.getWxCpService("tenantId2");
|
// 通讯录同步 Secret 具有部门/成员增删改查等权限
|
||||||
WxCpUserService userService2 = wxCpService2.getUserService();
|
WxCpService contactService = wxCpMultiServices.getWxCpService("contact");
|
||||||
userService2.getUserId("xxx");
|
WxCpDepartmentService departmentService = contactService.getDepartmentService();
|
||||||
// todo ...
|
// 更新部门示例(WxCpDepart 包含 id、name、parentId 等字段)
|
||||||
|
WxCpDepart depart = new WxCpDepart();
|
||||||
// 应用 3 的 WxCpService
|
depart.setId(100L);
|
||||||
WxCpService wxCpService3 = wxCpMultiServices.getWxCpService("tenantId3");
|
depart.setName("新部门名称");
|
||||||
// 判断是否为空
|
departmentService.update(depart);
|
||||||
if (wxCpService3 == null) {
|
|
||||||
// todo wxCpService3 为空,请先配置 tenantId3 企业微信应用参数
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
WxCpUserService userService3 = wxCpService3.getUserService();
|
|
||||||
userService3.getUserId("xxx");
|
|
||||||
// todo ...
|
// todo ...
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ import org.apache.commons.lang3.StringUtils;
|
|||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
|
import java.util.Objects;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
import java.util.stream.Collectors;
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
@@ -37,6 +38,13 @@ public abstract class AbstractWxCpConfiguration {
|
|||||||
/**
|
/**
|
||||||
* 校验同一个企业下,agentId 是否唯一,避免使用 redis 缓存 token、ticket 时错乱。
|
* 校验同一个企业下,agentId 是否唯一,避免使用 redis 缓存 token、ticket 时错乱。
|
||||||
*
|
*
|
||||||
|
* <p>同一企业(corpId 相同)下可配置多个条目以使用不同的权限 Secret,例如:</p>
|
||||||
|
* <ul>
|
||||||
|
* <li>自建应用条目:填写应用对应的 corpSecret 和 agentId</li>
|
||||||
|
* <li>通讯录同步条目:填写通讯录同步 Secret,agentId 可不填(null)</li>
|
||||||
|
* </ul>
|
||||||
|
* <p>但同一 corpId 下不允许出现重复的 agentId(包括多个 null)。</p>
|
||||||
|
*
|
||||||
* 查看 {@link me.chanjar.weixin.cp.config.impl.AbstractWxCpInRedisConfigImpl#setAgentId(Integer)}
|
* 查看 {@link me.chanjar.weixin.cp.config.impl.AbstractWxCpInRedisConfigImpl#setAgentId(Integer)}
|
||||||
*/
|
*/
|
||||||
Collection<WxCpSingleProperties> corpList = corps.values();
|
Collection<WxCpSingleProperties> corpList = corps.values();
|
||||||
@@ -49,8 +57,8 @@ public abstract class AbstractWxCpConfiguration {
|
|||||||
String corpId = entry.getKey();
|
String corpId = entry.getKey();
|
||||||
// 校验每个企业下,agentId 是否唯一
|
// 校验每个企业下,agentId 是否唯一
|
||||||
boolean multi = entry.getValue().stream()
|
boolean multi = entry.getValue().stream()
|
||||||
// 通讯录没有 agentId,如果不判断是否为空,这里会报 NPE 异常
|
// 通讯录没有 agentId,使用字符串转换避免 null 与 agentId=0 冲突
|
||||||
.collect(Collectors.groupingBy(c -> c.getAgentId() == null ? 0 : c.getAgentId(), Collectors.counting()))
|
.collect(Collectors.groupingBy(c -> Objects.toString(c.getAgentId(), "null"), Collectors.counting()))
|
||||||
.entrySet().stream().anyMatch(e -> e.getValue() > 1);
|
.entrySet().stream().anyMatch(e -> e.getValue() > 1);
|
||||||
if (multi) {
|
if (multi) {
|
||||||
throw new RuntimeException("请确保企业微信配置唯一性[" + corpId + "]");
|
throw new RuntimeException("请确保企业微信配置唯一性[" + corpId + "]");
|
||||||
|
|||||||
@@ -8,6 +8,16 @@ import java.io.Serializable;
|
|||||||
/**
|
/**
|
||||||
* 企业微信企业相关配置属性
|
* 企业微信企业相关配置属性
|
||||||
*
|
*
|
||||||
|
* <p>企业微信中不同的 corpSecret 对应不同的权限范围,常见的有:</p>
|
||||||
|
* <ul>
|
||||||
|
* <li>自建应用 Secret:在"应用管理 - 自建应用"中查看,只能调用该应用有权限的接口</li>
|
||||||
|
* <li>通讯录同步 Secret:在"管理工具 - 通讯录同步"中查看,用于管理部门和成员(增删改查)</li>
|
||||||
|
* <li>客户联系 Secret:在"客户联系"中查看,用于客户联系相关接口</li>
|
||||||
|
* </ul>
|
||||||
|
* <p>如需同时使用多种权限范围(例如:既要操作通讯录,又要调用自建应用接口),
|
||||||
|
* 可在 {@code wx.cp.corps} 下配置多个条目,每个条目使用对应权限的 {@code corpSecret},
|
||||||
|
* 其中通讯录同步的条目无需填写 {@code agentId}。</p>
|
||||||
|
*
|
||||||
* @author yl
|
* @author yl
|
||||||
* created on 2023/10/16
|
* created on 2023/10/16
|
||||||
*/
|
*/
|
||||||
@@ -20,7 +30,16 @@ public class WxCpSingleProperties implements Serializable {
|
|||||||
*/
|
*/
|
||||||
private String corpId;
|
private String corpId;
|
||||||
/**
|
/**
|
||||||
* 微信企业号 corpSecret
|
* 微信企业号 corpSecret(权限密钥)
|
||||||
|
*
|
||||||
|
* <p>企业微信针对不同的功能模块提供了不同的 Secret,每种 Secret 只对对应模块的接口有调用权限:</p>
|
||||||
|
* <ul>
|
||||||
|
* <li>自建应用 Secret:在"应用管理 - 自建应用"中找到对应应用,查看其 Secret,
|
||||||
|
* 使用时需同时配置对应的 {@code agentId}</li>
|
||||||
|
* <li>通讯录同步 Secret:在"管理工具 - 通讯录同步"中查看,
|
||||||
|
* 使用此 Secret 可管理部门、成员,无需配置 {@code agentId}</li>
|
||||||
|
* <li>其他 Secret(客户联系等):根据需要在企业微信后台查看对应 Secret</li>
|
||||||
|
* </ul>
|
||||||
*/
|
*/
|
||||||
private String corpSecret;
|
private String corpSecret;
|
||||||
/**
|
/**
|
||||||
@@ -28,7 +47,10 @@ public class WxCpSingleProperties implements Serializable {
|
|||||||
*/
|
*/
|
||||||
private String token;
|
private String token;
|
||||||
/**
|
/**
|
||||||
* 微信企业号应用 ID
|
* 微信企业号应用 ID(AgentId)
|
||||||
|
*
|
||||||
|
* <p>使用自建应用 Secret 时,需要填写对应应用的 AgentId。</p>
|
||||||
|
* <p>使用通讯录同步 Secret 时,无需填写此字段。</p>
|
||||||
*/
|
*/
|
||||||
private Integer agentId;
|
private Integer agentId;
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -6,6 +6,29 @@
|
|||||||
- 未实现 WxCpTpService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
|
- 未实现 WxCpTpService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
|
||||||
- 未实现 WxCpCgService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
|
- 未实现 WxCpCgService 初始化,需要的小伙伴可以参考多 WxCpService 配置的实现。
|
||||||
|
|
||||||
|
## 关于 corp-secret 的说明
|
||||||
|
|
||||||
|
企业微信中不同功能模块对应不同的 `corp-secret`,每种 Secret 只对对应模块的接口具有调用权限:
|
||||||
|
|
||||||
|
| Secret 类型 | 获取位置 | 可调用的接口 | 是否需要 agent-id |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 自建应用 Secret | 应用管理 → 自建应用 → 选择应用 → 查看 Secret | 该应用有权限的接口 | **必填** |
|
||||||
|
| 通讯录同步 Secret | 管理工具 → 通讯录同步 → 查看 Secret | 部门/成员增删改查等通讯录接口 | **不填** |
|
||||||
|
| 客户联系 Secret | 客户联系 → API → Secret | 客户联系相关接口 | 不填 |
|
||||||
|
|
||||||
|
> **常见问题**:
|
||||||
|
> - 使用自建应用 Secret + agent-id 可以获取部门列表,但**无法更新部门**(因为写接口需要通讯录同步权限)
|
||||||
|
> - 使用通讯录同步 Secret 可以同步部门,但**调用某些需要 agent-id 的应用接口会报错**
|
||||||
|
|
||||||
|
如需同时使用多种权限范围,可在 `wx.cp.corps` 下配置多个条目,每个条目使用对应权限的 Secret,通过不同的 `tenantId` 区分后使用。
|
||||||
|
|
||||||
|
> **配置限制说明**:
|
||||||
|
> - 当前 starter 实现会校验:同一 `corp-id` 下,`agent-id` **必须唯一**
|
||||||
|
> - 同一 `corp-id` 下,**只能有一个条目不填 `agent-id`**
|
||||||
|
> - 否则会因为 token/ticket 缓存 key 冲突而在启动时直接抛异常
|
||||||
|
>
|
||||||
|
> 因此,像"通讯录同步 Secret""客户联系 Secret"这类通常不填写 `agent-id` 的配置,**不能**在同一个 `corp-id` 下同时配置多个 `agent-id` 均为空的条目;如确有多个条目,请确保其中最多只有一个未填写 `agent-id`。
|
||||||
|
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
1. 引入依赖
|
1. 引入依赖
|
||||||
@@ -18,25 +41,21 @@
|
|||||||
```
|
```
|
||||||
2. 添加配置(application.properties)
|
2. 添加配置(application.properties)
|
||||||
```properties
|
```properties
|
||||||
# 应用 1 配置
|
# 自建应用 1 配置(使用自建应用 Secret,需填写 agent-id)
|
||||||
wx.cp.corps.tenantId1.corp-id = @corp-id
|
wx.cp.corps.app1.corp-id = @corp-id
|
||||||
wx.cp.corps.tenantId1.corp-secret = @corp-secret
|
wx.cp.corps.app1.corp-secret = @自建应用的Secret(在"应用管理-自建应用"中查看)
|
||||||
|
wx.cp.corps.app1.agent-id = @自建应用的AgentId
|
||||||
## 选填
|
## 选填
|
||||||
wx.cp.corps.tenantId1.agent-id = @agent-id
|
wx.cp.corps.app1.token = @token
|
||||||
wx.cp.corps.tenantId1.token = @token
|
wx.cp.corps.app1.aes-key = @aes-key
|
||||||
wx.cp.corps.tenantId1.aes-key = @aes-key
|
wx.cp.corps.app1.msg-audit-priKey = @msg-audit-priKey
|
||||||
wx.cp.corps.tenantId1.msg-audit-priKey = @msg-audit-priKey
|
wx.cp.corps.app1.msg-audit-lib-path = @msg-audit-lib-path
|
||||||
wx.cp.corps.tenantId1.msg-audit-lib-path = @msg-audit-lib-path
|
|
||||||
|
|
||||||
# 应用 2 配置
|
# 通讯录同步配置(使用通讯录同步 Secret,不需要填写 agent-id)
|
||||||
wx.cp.corps.tenantId2.corp-id = @corp-id
|
# 此配置用于部门、成员的增删改查等通讯录管理操作
|
||||||
wx.cp.corps.tenantId2.corp-secret = @corp-secret
|
wx.cp.corps.contact.corp-id = @corp-id
|
||||||
## 选填
|
wx.cp.corps.contact.corp-secret = @通讯录同步的Secret(在"管理工具-通讯录同步"中查看)
|
||||||
wx.cp.corps.tenantId2.agent-id = @agent-id
|
## agent-id 不填,通讯录同步不需要 agentId
|
||||||
wx.cp.corps.tenantId2.token = @token
|
|
||||||
wx.cp.corps.tenantId2.aes-key = @aes-key
|
|
||||||
wx.cp.corps.tenantId2.msg-audit-priKey = @msg-audit-priKey
|
|
||||||
wx.cp.corps.tenantId2.msg-audit-lib-path = @msg-audit-lib-path
|
|
||||||
|
|
||||||
# 公共配置
|
# 公共配置
|
||||||
## ConfigStorage 配置(选填)
|
## ConfigStorage 配置(选填)
|
||||||
@@ -59,8 +78,10 @@
|
|||||||
|
|
||||||
```java
|
```java
|
||||||
import com.binarywang.spring.starter.wxjava.cp.service.WxCpMultiServices;
|
import com.binarywang.spring.starter.wxjava.cp.service.WxCpMultiServices;
|
||||||
|
import me.chanjar.weixin.cp.api.WxCpDepartmentService;
|
||||||
import me.chanjar.weixin.cp.api.WxCpService;
|
import me.chanjar.weixin.cp.api.WxCpService;
|
||||||
import me.chanjar.weixin.cp.api.WxCpUserService;
|
import me.chanjar.weixin.cp.api.WxCpUserService;
|
||||||
|
import me.chanjar.weixin.cp.bean.WxCpDepart;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
import org.springframework.stereotype.Service;
|
import org.springframework.stereotype.Service;
|
||||||
|
|
||||||
@@ -70,27 +91,21 @@ public class DemoService {
|
|||||||
private WxCpMultiServices wxCpMultiServices;
|
private WxCpMultiServices wxCpMultiServices;
|
||||||
|
|
||||||
public void test() {
|
public void test() {
|
||||||
// 应用 1 的 WxCpService
|
// 使用自建应用的 WxCpService(对应 corp-secret 为自建应用 Secret)
|
||||||
WxCpService wxCpService1 = wxCpMultiServices.getWxCpService("tenantId1");
|
WxCpService appService = wxCpMultiServices.getWxCpService("app1");
|
||||||
WxCpUserService userService1 = wxCpService1.getUserService();
|
WxCpUserService userService = appService.getUserService();
|
||||||
userService1.getUserId("xxx");
|
userService.getUserId("xxx");
|
||||||
// todo ...
|
// todo ...
|
||||||
|
|
||||||
// 应用 2 的 WxCpService
|
// 使用通讯录同步的 WxCpService(对应 corp-secret 为通讯录同步 Secret)
|
||||||
WxCpService wxCpService2 = wxCpMultiServices.getWxCpService("tenantId2");
|
// 通讯录同步 Secret 具有部门/成员增删改查等权限
|
||||||
WxCpUserService userService2 = wxCpService2.getUserService();
|
WxCpService contactService = wxCpMultiServices.getWxCpService("contact");
|
||||||
userService2.getUserId("xxx");
|
WxCpDepartmentService departmentService = contactService.getDepartmentService();
|
||||||
// todo ...
|
// 更新部门示例(WxCpDepart 包含 id、name、parentId 等字段)
|
||||||
|
WxCpDepart depart = new WxCpDepart();
|
||||||
// 应用 3 的 WxCpService
|
depart.setId(100L);
|
||||||
WxCpService wxCpService3 = wxCpMultiServices.getWxCpService("tenantId3");
|
depart.setName("新部门名称");
|
||||||
// 判断是否为空
|
departmentService.update(depart);
|
||||||
if (wxCpService3 == null) {
|
|
||||||
// todo wxCpService3 为空,请先配置 tenantId3 企业微信应用参数
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
WxCpUserService userService3 = wxCpService3.getUserService();
|
|
||||||
userService3.getUserId("xxx");
|
|
||||||
// todo ...
|
// todo ...
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ import org.apache.commons.lang3.StringUtils;
|
|||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
|
import java.util.Objects;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
import java.util.stream.Collectors;
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
@@ -40,6 +41,13 @@ public abstract class AbstractWxCpConfiguration {
|
|||||||
/**
|
/**
|
||||||
* 校验同一个企业下,agentId 是否唯一,避免使用 redis 缓存 token、ticket 时错乱。
|
* 校验同一个企业下,agentId 是否唯一,避免使用 redis 缓存 token、ticket 时错乱。
|
||||||
*
|
*
|
||||||
|
* <p>同一企业(corpId 相同)下可配置多个条目以使用不同的权限 Secret,例如:</p>
|
||||||
|
* <ul>
|
||||||
|
* <li>自建应用条目:填写应用对应的 corpSecret 和 agentId</li>
|
||||||
|
* <li>通讯录同步条目:填写通讯录同步 Secret,agentId 可不填(null)</li>
|
||||||
|
* </ul>
|
||||||
|
* <p>但同一 corpId 下不允许出现重复的 agentId(包括多个 null)。</p>
|
||||||
|
*
|
||||||
* 查看 {@link me.chanjar.weixin.cp.config.impl.AbstractWxCpInRedisConfigImpl#setAgentId(Integer)}
|
* 查看 {@link me.chanjar.weixin.cp.config.impl.AbstractWxCpInRedisConfigImpl#setAgentId(Integer)}
|
||||||
*/
|
*/
|
||||||
Collection<WxCpSingleProperties> corpList = corps.values();
|
Collection<WxCpSingleProperties> corpList = corps.values();
|
||||||
@@ -52,8 +60,8 @@ public abstract class AbstractWxCpConfiguration {
|
|||||||
String corpId = entry.getKey();
|
String corpId = entry.getKey();
|
||||||
// 校验每个企业下,agentId 是否唯一
|
// 校验每个企业下,agentId 是否唯一
|
||||||
boolean multi = entry.getValue().stream()
|
boolean multi = entry.getValue().stream()
|
||||||
// 通讯录没有 agentId,如果不判断是否为空,这里会报 NPE 异常
|
// 通讯录没有 agentId,使用字符串转换避免 null 与 agentId=0 冲突
|
||||||
.collect(Collectors.groupingBy(c -> c.getAgentId() == null ? 0 : c.getAgentId(), Collectors.counting()))
|
.collect(Collectors.groupingBy(c -> Objects.toString(c.getAgentId(), "null"), Collectors.counting()))
|
||||||
.entrySet().stream().anyMatch(e -> e.getValue() > 1);
|
.entrySet().stream().anyMatch(e -> e.getValue() > 1);
|
||||||
if (multi) {
|
if (multi) {
|
||||||
throw new RuntimeException("请确保企业微信配置唯一性[" + corpId + "]");
|
throw new RuntimeException("请确保企业微信配置唯一性[" + corpId + "]");
|
||||||
|
|||||||
@@ -8,6 +8,16 @@ import java.io.Serializable;
|
|||||||
/**
|
/**
|
||||||
* 企业微信企业相关配置属性
|
* 企业微信企业相关配置属性
|
||||||
*
|
*
|
||||||
|
* <p>企业微信中不同的 corpSecret 对应不同的权限范围,常见的有:</p>
|
||||||
|
* <ul>
|
||||||
|
* <li>自建应用 Secret:在"应用管理 - 自建应用"中查看,只能调用该应用有权限的接口</li>
|
||||||
|
* <li>通讯录同步 Secret:在"管理工具 - 通讯录同步"中查看,用于管理部门和成员(增删改查)</li>
|
||||||
|
* <li>客户联系 Secret:在"客户联系"中查看,用于客户联系相关接口</li>
|
||||||
|
* </ul>
|
||||||
|
* <p>如需同时使用多种权限范围(例如:既要操作通讯录,又要调用自建应用接口),
|
||||||
|
* 可在 {@code wx.cp.corps} 下配置多个条目,每个条目使用对应权限的 {@code corpSecret},
|
||||||
|
* 其中通讯录同步的条目无需填写 {@code agentId}。</p>
|
||||||
|
*
|
||||||
* @author yl
|
* @author yl
|
||||||
* created on 2023/10/16
|
* created on 2023/10/16
|
||||||
*/
|
*/
|
||||||
@@ -20,7 +30,16 @@ public class WxCpSingleProperties implements Serializable {
|
|||||||
*/
|
*/
|
||||||
private String corpId;
|
private String corpId;
|
||||||
/**
|
/**
|
||||||
* 微信企业号 corpSecret
|
* 微信企业号 corpSecret(权限密钥)
|
||||||
|
*
|
||||||
|
* <p>企业微信针对不同的功能模块提供了不同的 Secret,每种 Secret 只对对应模块的接口有调用权限:</p>
|
||||||
|
* <ul>
|
||||||
|
* <li>自建应用 Secret:在"应用管理 - 自建应用"中找到对应应用,查看其 Secret,
|
||||||
|
* 使用时需同时配置对应的 {@code agentId}</li>
|
||||||
|
* <li>通讯录同步 Secret:在"管理工具 - 通讯录同步"中查看,
|
||||||
|
* 使用此 Secret 可管理部门、成员,无需配置 {@code agentId}</li>
|
||||||
|
* <li>其他 Secret(客户联系等):根据需要在企业微信后台查看对应 Secret</li>
|
||||||
|
* </ul>
|
||||||
*/
|
*/
|
||||||
private String corpSecret;
|
private String corpSecret;
|
||||||
/**
|
/**
|
||||||
@@ -28,7 +47,10 @@ public class WxCpSingleProperties implements Serializable {
|
|||||||
*/
|
*/
|
||||||
private String token;
|
private String token;
|
||||||
/**
|
/**
|
||||||
* 微信企业号应用 ID
|
* 微信企业号应用 ID(AgentId)
|
||||||
|
*
|
||||||
|
* <p>使用自建应用 Secret 时,需要填写对应应用的 AgentId。</p>
|
||||||
|
* <p>使用通讯录同步 Secret 时,无需填写此字段。</p>
|
||||||
*/
|
*/
|
||||||
private Integer agentId;
|
private Integer agentId;
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user