Skip to content

Commit 0a9e488

Browse files
CopilotCopilot
authored
feat: 支持通讯录同步使用单独的secret获取独立access token
1 parent 3298814 commit 0a9e488

13 files changed

Lines changed: 683 additions & 0 deletions

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,19 @@ public interface WxCpService extends WxService {
5757
*/
5858
String getAccessToken(boolean forceRefresh) throws WxErrorException;
5959

60+
/**
61+
* <pre>
62+
* 获取通讯录同步access_token，本方法线程安全
63+
* 通讯录同步相关接口仅支持通过"通讯录同步secret"调用，需要使用独立的access_token
64+
* 详情请见: https://developer.work.weixin.qq.com/document/path/91579
65+
* </pre>
66+
*
67+
* @param forceRefresh 强制刷新
68+
* @return 通讯录同步专用的access token
69+
* @throws WxErrorException the wx error exception
70+
*/
71+
String getContactAccessToken(boolean forceRefresh) throws WxErrorException;
72+
6073
/**
6174
* <pre>
6275
* 获取会话存档access_token，本方法线程安全
@@ -220,6 +233,32 @@ public interface WxCpService extends WxService {
220233
*/
221234
String postForMsgAudit(String url, String postData) throws WxErrorException;
222235

236+
/**
237+
* <pre>
238+
* 使用通讯录同步access token发起get请求
239+
* 通讯录同步相关API需要使用通讯录同步专用的secret获取独立的access token
240+
* </pre>
241+
*
242+
* @param url 接口地址
243+
* @param queryParam 请求参数
244+
* @return the string
245+
* @throws WxErrorException the wx error exception
246+
*/
247+
String getForContact(String url, String queryParam) throws WxErrorException;
248+
249+
/**
250+
* <pre>
251+
* 使用通讯录同步access token发起post请求
252+
* 通讯录同步相关API需要使用通讯录同步专用的secret获取独立的access token
253+
* </pre>
254+
*
255+
* @param url 接口地址
256+
* @param postData 请求body字符串
257+
* @return the string
258+
* @throws WxErrorException the wx error exception
259+
*/
260+
String postForContact(String url, String postData) throws WxErrorException;
261+
223262
/**
224263
* <pre>
225264
* Service没有实现某个API的时候，可以用这个，

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,29 @@ public String postForMsgAudit(String url, String postData) throws WxErrorExcepti
313313
return this.executeNormal(SimplePostRequestExecutor.create(this), urlWithToken, postData);
314314
}
315315

316+
@Override
317+
public String getForContact(String url, String queryParam) throws WxErrorException {
318+
// 获取通讯录同步专用的access token
319+
String contactAccessToken = getContactAccessToken(false);
320+
// 拼接access_token参数
321+
String urlWithToken = url + (url.contains("?") ? "&" : "?") + "access_token=" + contactAccessToken;
322+
if (queryParam != null && !queryParam.isEmpty()) {
323+
urlWithToken = urlWithToken + "&" + queryParam;
324+
}
325+
// 使用executeNormal方法，不自动添加token
326+
return this.executeNormal(SimpleGetRequestExecutor.create(this), urlWithToken, null);
327+
}
328+
329+
@Override
330+
public String postForContact(String url, String postData) throws WxErrorException {
331+
// 获取通讯录同步专用的access token
332+
String contactAccessToken = getContactAccessToken(false);
333+
// 拼接access_token参数
334+
String urlWithToken = url + (url.contains("?") ? "&" : "?") + "access_token=" + contactAccessToken;
335+
// 使用executeNormal方法，不自动添加token
336+
return this.executeNormal(SimplePostRequestExecutor.create(this), urlWithToken, postData);
337+
}
338+
316339
/**
317340
* 向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求.
318341
*/

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

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,51 @@ public String getAccessToken(boolean forceRefresh) throws WxErrorException {
7575
return this.configStorage.getAccessToken();
7676
}
7777

78+
@Override
79+
public String getContactAccessToken(boolean forceRefresh) throws WxErrorException {
80+
if (!this.configStorage.isContactAccessTokenExpired() && !forceRefresh) {
81+
return this.configStorage.getContactAccessToken();
82+
}
83+
84+
Lock lock = this.configStorage.getContactAccessTokenLock();
85+
lock.lock();
86+
try {
87+
// 拿到锁之后，再次判断一下最新的token是否过期，避免重刷
88+
if (!this.configStorage.isContactAccessTokenExpired() && !forceRefresh) {
89+
return this.configStorage.getContactAccessToken();
90+
}
91+
// 使用通讯录同步secret获取access_token
92+
String contactSecret = this.configStorage.getContactSecret();
93+
if (contactSecret == null || contactSecret.trim().isEmpty()) {
94+
throw new WxErrorException("通讯录同步secret未配置");
95+
}
96+
String url = String.format(this.configStorage.getApiUrl(WxCpApiPathConsts.GET_TOKEN),
97+
this.configStorage.getCorpId(), contactSecret);
98+
99+
try {
100+
HttpGet httpGet = new HttpGet(url);
101+
if (this.httpProxy != null) {
102+
RequestConfig config = RequestConfig.custom()
103+
.setProxy(this.httpProxy).build();
104+
httpGet.setConfig(config);
105+
}
106+
String resultContent = getRequestHttpClient().execute(httpGet, ApacheBasicResponseHandler.INSTANCE);
107+
WxError error = WxError.fromJson(resultContent, WxType.CP);
108+
if (error.getErrorCode() != 0) {
109+
throw new WxErrorException(error);
110+
}
111+
112+
WxAccessToken accessToken = WxAccessToken.fromJson(resultContent);
113+
this.configStorage.updateContactAccessToken(accessToken.getAccessToken(), accessToken.getExpiresIn());
114+
} catch (IOException e) {
115+
throw new WxRuntimeException(e);
116+
}
117+
} finally {
118+
lock.unlock();
119+
}
120+
return this.configStorage.getContactAccessToken();
121+
}
122+
78123
@Override
79124
public String getMsgAuditAccessToken(boolean forceRefresh) throws WxErrorException {
80125
if (!this.configStorage.isMsgAuditAccessTokenExpired() && !forceRefresh) {

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

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,51 @@ public String getAccessToken(boolean forceRefresh) throws WxErrorException {
7676
return this.configStorage.getAccessToken();
7777
}
7878

79+
@Override
80+
public String getContactAccessToken(boolean forceRefresh) throws WxErrorException {
81+
if (!this.configStorage.isContactAccessTokenExpired() && !forceRefresh) {
82+
return this.configStorage.getContactAccessToken();
83+
}
84+
85+
Lock lock = this.configStorage.getContactAccessTokenLock();
86+
lock.lock();
87+
try {
88+
// 拿到锁之后，再次判断一下最新的token是否过期，避免重刷
89+
if (!this.configStorage.isContactAccessTokenExpired() && !forceRefresh) {
90+
return this.configStorage.getContactAccessToken();
91+
}
92+
// 使用通讯录同步secret获取access_token
93+
String contactSecret = this.configStorage.getContactSecret();
94+
if (contactSecret == null || contactSecret.trim().isEmpty()) {
95+
throw new WxErrorException("通讯录同步secret未配置");
96+
}
97+
String url = String.format(this.configStorage.getApiUrl(WxCpApiPathConsts.GET_TOKEN),
98+
this.configStorage.getCorpId(), contactSecret);
99+
100+
try {
101+
HttpGet httpGet = new HttpGet(url);
102+
if (this.httpProxy != null) {
103+
RequestConfig config = RequestConfig.custom()
104+
.setProxy(this.httpProxy).build();
105+
httpGet.setConfig(config);
106+
}
107+
String resultContent = getRequestHttpClient().execute(httpGet, BasicResponseHandler.INSTANCE);
108+
WxError error = WxError.fromJson(resultContent, WxType.CP);
109+
if (error.getErrorCode() != 0) {
110+
throw new WxErrorException(error);
111+
}
112+
113+
WxAccessToken accessToken = WxAccessToken.fromJson(resultContent);
114+
this.configStorage.updateContactAccessToken(accessToken.getAccessToken(), accessToken.getExpiresIn());
115+
} catch (IOException e) {
116+
throw new WxRuntimeException(e);
117+
}
118+
} finally {
119+
lock.unlock();
120+
}
121+
return this.configStorage.getContactAccessToken();
122+
}
123+
79124
@Override
80125
public String getMsgAuditAccessToken(boolean forceRefresh) throws WxErrorException {
81126
if (!this.configStorage.isMsgAuditAccessTokenExpired() && !forceRefresh) {

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,49 @@ public String getAccessToken(boolean forceRefresh) throws WxErrorException {
7070
return configStorage.getAccessToken();
7171
}
7272

73+
@Override
74+
public String getContactAccessToken(boolean forceRefresh) throws WxErrorException {
75+
final WxCpConfigStorage configStorage = getWxCpConfigStorage();
76+
if (!configStorage.isContactAccessTokenExpired() && !forceRefresh) {
77+
return configStorage.getContactAccessToken();
78+
}
79+
Lock lock = configStorage.getContactAccessTokenLock();
80+
lock.lock();
81+
try {
82+
// 拿到锁之后，再次判断一下最新的token是否过期，避免重刷
83+
if (!configStorage.isContactAccessTokenExpired() && !forceRefresh) {
84+
return configStorage.getContactAccessToken();
85+
}
86+
// 使用通讯录同步secret获取access_token
87+
String contactSecret = configStorage.getContactSecret();
88+
if (contactSecret == null || contactSecret.trim().isEmpty()) {
89+
throw new WxErrorException("通讯录同步secret未配置");
90+
}
91+
String url = String.format(configStorage.getApiUrl(WxCpApiPathConsts.GET_TOKEN),
92+
this.configStorage.getCorpId(), contactSecret);
93+
try {
94+
HttpGet httpGet = new HttpGet(url);
95+
if (getRequestHttpProxy() != null) {
96+
RequestConfig config = RequestConfig.custom().setProxy(getRequestHttpProxy()).build();
97+
httpGet.setConfig(config);
98+
}
99+
String resultContent = getRequestHttpClient().execute(httpGet, ApacheBasicResponseHandler.INSTANCE);
100+
WxError error = WxError.fromJson(resultContent, WxType.CP);
101+
if (error.getErrorCode() != 0) {
102+
throw new WxErrorException(error);
103+
}
104+
105+
WxAccessToken accessToken = WxAccessToken.fromJson(resultContent);
106+
configStorage.updateContactAccessToken(accessToken.getAccessToken(), accessToken.getExpiresIn());
107+
} catch (IOException e) {
108+
throw new WxRuntimeException(e);
109+
}
110+
} finally {
111+
lock.unlock();
112+
}
113+
return configStorage.getContactAccessToken();
114+
}
115+
73116
@Override
74117
public String getMsgAuditAccessToken(boolean forceRefresh) throws WxErrorException {
75118
final WxCpConfigStorage configStorage = getWxCpConfigStorage();

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,45 @@ public String getAccessToken(boolean forceRefresh) throws WxErrorException {
6565
return this.configStorage.getAccessToken();
6666
}
6767

68+
@Override
69+
public String getContactAccessToken(boolean forceRefresh) throws WxErrorException {
70+
if (!this.configStorage.isContactAccessTokenExpired() && !forceRefresh) {
71+
return this.configStorage.getContactAccessToken();
72+
}
73+
74+
Lock lock = this.configStorage.getContactAccessTokenLock();
75+
lock.lock();
76+
try {
77+
// 拿到锁之后，再次判断一下最新的token是否过期，避免重刷
78+
if (!this.configStorage.isContactAccessTokenExpired() && !forceRefresh) {
79+
return this.configStorage.getContactAccessToken();
80+
}
81+
// 使用通讯录同步secret获取access_token
82+
String contactSecret = this.configStorage.getContactSecret();
83+
if (contactSecret == null || contactSecret.trim().isEmpty()) {
84+
throw new WxErrorException("通讯录同步secret未配置");
85+
}
86+
HttpRequest request = HttpRequest.get(String.format(this.configStorage.getApiUrl(WxCpApiPathConsts.GET_TOKEN),
87+
this.configStorage.getCorpId(), contactSecret));
88+
if (this.httpProxy != null) {
89+
httpClient.useProxy(this.httpProxy);
90+
}
91+
request.withConnectionProvider(httpClient);
92+
HttpResponse response = request.send();
93+
94+
String resultContent = response.bodyText();
95+
WxError error = WxError.fromJson(resultContent, WxType.CP);
96+
if (error.getErrorCode() != 0) {
97+
throw new WxErrorException(error);
98+
}
99+
WxAccessToken accessToken = WxAccessToken.fromJson(resultContent);
100+
this.configStorage.updateContactAccessToken(accessToken.getAccessToken(), accessToken.getExpiresIn());
101+
} finally {
102+
lock.unlock();
103+
}
104+
return this.configStorage.getContactAccessToken();
105+
}
106+
68107
@Override
69108
public String getMsgAuditAccessToken(boolean forceRefresh) throws WxErrorException {
70109
if (!this.configStorage.isMsgAuditAccessTokenExpired() && !forceRefresh) {

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,52 @@ public String getAccessToken(boolean forceRefresh) throws WxErrorException {
7575
return this.configStorage.getAccessToken();
7676
}
7777

78+
@Override
79+
public String getContactAccessToken(boolean forceRefresh) throws WxErrorException {
80+
if (!this.configStorage.isContactAccessTokenExpired() && !forceRefresh) {
81+
return this.configStorage.getContactAccessToken();
82+
}
83+
84+
Lock lock = this.configStorage.getContactAccessTokenLock();
85+
lock.lock();
86+
try {
87+
// 拿到锁之后，再次判断一下最新的token是否过期，避免重刷
88+
if (!this.configStorage.isContactAccessTokenExpired() && !forceRefresh) {
89+
return this.configStorage.getContactAccessToken();
90+
}
91+
// 使用通讯录同步secret获取access_token
92+
String contactSecret = this.configStorage.getContactSecret();
93+
if (contactSecret == null || contactSecret.trim().isEmpty()) {
94+
throw new WxErrorException("通讯录同步secret未配置");
95+
}
96+
//得到httpClient
97+
OkHttpClient client = getRequestHttpClient();
98+
//请求的request
99+
Request request = new Request.Builder()
100+
.url(String.format(this.configStorage.getApiUrl(GET_TOKEN), this.configStorage.getCorpId(),
101+
contactSecret))
102+
.get()
103+
.build();
104+
String resultContent = null;
105+
try (Response response = client.newCall(request).execute()) {
106+
resultContent = response.body().string();
107+
} catch (IOException e) {
108+
log.error(e.getMessage(), e);
109+
}
110+
111+
WxError error = WxError.fromJson(resultContent, WxType.CP);
112+
if (error.getErrorCode() != 0) {
113+
throw new WxErrorException(error);
114+
}
115+
WxAccessToken accessToken = WxAccessToken.fromJson(resultContent);
116+
this.configStorage.updateContactAccessToken(accessToken.getAccessToken(),
117+
accessToken.getExpiresIn());
118+
} finally {
119+
lock.unlock();
120+
}
121+
return this.configStorage.getContactAccessToken();
122+
}
123+
78124
@Override
79125
public String getMsgAuditAccessToken(boolean forceRefresh) throws WxErrorException {
80126
if (!this.configStorage.isMsgAuditAccessTokenExpired() && !forceRefresh) {

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpConfigStorage.java‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,47 @@ public interface WxCpConfigStorage {
258258
*/
259259
String getWebhookKey();
260260

261+
/**
262+
* 获取通讯录同步的secret
263+
*
264+
* @return contact secret
265+
*/
266+
String getContactSecret();
267+
268+
/**
269+
* 获取通讯录同步的access token
270+
*
271+
* @return contact access token
272+
*/
273+
String getContactAccessToken();
274+
275+
/**
276+
* 获取通讯录同步access token的锁
277+
*
278+
* @return contact access token lock
279+
*/
280+
Lock getContactAccessTokenLock();
281+
282+
/**
283+
* 检查通讯录同步access token是否已过期
284+
*
285+
* @return true: 已过期, false: 未过期
286+
*/
287+
boolean isContactAccessTokenExpired();
288+
289+
/**
290+
* 强制将通讯录同步access token过期掉
291+
*/
292+
void expireContactAccessToken();
293+
294+
/**
295+
* 更新通讯录同步access token
296+
*
297+
* @param accessToken 通讯录同步access token
298+
* @param expiresInSeconds 过期时间（秒）
299+
*/
300+
void updateContactAccessToken(String accessToken, int expiresInSeconds);
301+
261302
/**
262303
* 获取会话存档的secret
263304
*

0 commit comments

Comments
 (0)