Visitar URL original
:new: #3077【小程序】增加openApi管理的接口支持 · binarywang/WxJava@831aac3 · GitHub
Skip to content

Commit 831aac3

Browse files
shuiyihan12shuiyihan12
authored
🆕 #3077【小程序】增加openApi管理的接口支持
1 parent 9bd7940 commit 831aac3

10 files changed

Lines changed: 362 additions & 4 deletions

File tree

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxMaErrorMsgEnum.java‎

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,10 @@ public enum WxMaErrorMsgEnum {
7070
* appid不正确，或者不符合绑定关系要求.
7171
* 对应操作：<code>sendUniformMessage</code>
7272
* 对应地址：
73-
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN
74-
* 参考文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/open-api/uniform-message/sendUniformMessage.html
73+
* 参考文档地址： https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuota.html
7574
* </pre>
7675
*/
77-
CODE_40013(40013, "appid不正确，或者不符合绑定关系要求"),
76+
CODE_40013(40013, "appid不正确/不合法(避免异常字符,注意大小写)，或者不符合绑定关系要求"),
7877
/**
7978
* <pre>
8079
* template_id 不正确.
@@ -267,6 +266,50 @@ public enum WxMaErrorMsgEnum {
267266
* activity_id 过期.
268267
*/
269268
CODE_47504(47504, "activity_id 过期"),
269+
/**
270+
* api 禁止清零调用次数，因为清零次数达到上限
271+
*
272+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuota.html">参考文档</a>
273+
*/
274+
CODE_48006(48006, "api 禁止清零调用次数，因为清零次数达到上限"),
275+
276+
/**
277+
* rid不存在
278+
*
279+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getRidInfo.html">参考文档</a>
280+
*/
281+
CODE_76001(76001, "rid不存在"),
282+
/**
283+
* rid为空或者格式错误
284+
*
285+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getRidInfo.html">参考文档</a>
286+
*/
287+
CODE_76002(76002, "rid为空或者格式错误"),
288+
/**
289+
* 当前账号无权查询该rid，该rid属于其他账号调用所产生
290+
*
291+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getRidInfo.html">参考文档</a>
292+
*/
293+
CODE_76003(76003, "当前账号无权查询该rid，该rid属于其他账号调用所产生"),
294+
/**
295+
* rid过期
296+
*
297+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getRidInfo.html">参考文档</a>
298+
*/
299+
CODE_76004(76004, "rid过期，仅支持持续7天内的rid"),
300+
/**
301+
* cgi_path填错了
302+
*
303+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getApiQuota.html">参考文档</a>
304+
*/
305+
CODE_76021(76021, "cgi_path填错了"),
306+
/**
307+
* 当前调用接口使用的token与api所属账号不符
308+
*
309+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getApiQuota.html">参考文档</a>
310+
*/
311+
CODE_76022(76022, "当前调用接口使用的token与api所属账号不符，详情可看注意事项的说明"),
312+
270313
/**
271314
* 没有绑定开放平台帐号.
272315
*/
@@ -343,6 +386,17 @@ public enum WxMaErrorMsgEnum {
343386
CODE_91017(91017, "+号规则 不同类型关联名主体不一致"),
344387

345388
CODE_40097(40097, "参数错误"),
389+
/**
390+
* 缺少 appid 参数
391+
* <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuotaByAppSecret.html">参考文档</a>
392+
*/
393+
CODE_41002(41002, "缺少 appid 参数"),
394+
/**
395+
* 缺少 secret 参数
396+
* <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuotaByAppSecret.html">参考文档</a>
397+
*/
398+
CODE_41004(41004, "缺少 secret 参数"),
399+
346400

347401
CODE_41006(41006, "media_id 不能为空"),
348402

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaOpenApiService.java‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
package cn.binarywang.wx.miniapp.api;
2+
3+
import cn.binarywang.wx.miniapp.bean.openapi.WxMiniGetApiQuotaResult;
4+
import cn.binarywang.wx.miniapp.bean.openapi.WxMiniGetRidInfoResult;
5+
import me.chanjar.weixin.common.error.WxErrorException;
6+
7+
/**
8+
* openApi管理
9+
*
10+
* @author shuiyihan12
11+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuota.html">openApi管理 微信文档</a>
12+
* @since 2023/7/7 17:07
13+
*/
14+
public interface WxMaOpenApiService {
15+
16+
/**
17+
* 本接口用于清空公众号/小程序/第三方平台等接口的每日调用接口次数
18+
* HTTP调用：https://api.weixin.qq.com/cgi-bin/clear_quota?access_token=ACCESS_TOKEN
19+
*
20+
* @return 是否成功
21+
* @throws WxErrorException the wx error exception
22+
* @apiNote !!! 单小程序直接调用该方法 , 如多个appid调用此方法前请调用 {@link cn.binarywang.wx.miniapp.api.WxMaService#switchoverTo} 切换appid !!!
23+
* @code wxMaService.getWxMaOpenApiService().clearQuota() //单个
24+
* @code wxMaService.switchoverTo(" appid ").getWxMaOpenApiService().clearQuota() //多个
25+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuota.html">注意事项参考微信文档</a>
26+
*/
27+
boolean clearQuota() throws WxErrorException;
28+
29+
/**
30+
* 查询API调用额度
31+
* HTTP调用：https://api.weixin.qq.com/cgi-bin/openapi/quota/get?access_token=ACCESS_TOKEN
32+
*
33+
* @param cgiPath api的请求地址，例如"/cgi-bin/message/custom/send";不要前缀“https://api.weixin.qq.com” ，也不要漏了"/",否则都会76003的报错
34+
* @return 额度详情
35+
* @throws WxErrorException 微信异常
36+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getApiQuota.html">注意事项参考微信文档</a>
37+
*/
38+
WxMiniGetApiQuotaResult getApiQuota(String cgiPath) throws WxErrorException;
39+
40+
/**
41+
* 查询rid信息
42+
* HTTP调用：https://api.weixin.qq.com/cgi-bin/openapi/rid/get?access_token=ACCESS_TOKEN
43+
*
44+
* @param rid 调用接口报错返回的rid
45+
* @return 该rid对应的请求详情
46+
* @throws WxErrorException 微信异常
47+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getRidInfo.html">注意事项参考微信文档</a>
48+
*/
49+
WxMiniGetRidInfoResult getRidInfo(String rid) throws WxErrorException;
50+
51+
52+
/**
53+
* 使用AppSecret重置 API 调用次数
54+
* HTTP调用：https://api.weixin.qq.com/cgi-bin/clear_quota/v2
55+
*
56+
* @return 是否成功
57+
* @throws WxErrorException 微信异常
58+
* @apiNote !!! 单小程序直接调用该方法 , 如多个appid调用此方法前请调用 {@link cn.binarywang.wx.miniapp.api.WxMaService#switchoverTo} 切换appid!!!
59+
* 参考示例
60+
* @code wxMaService.getWxMaOpenApiService().clearQuotaByAppSecret() //单个
61+
* @code wxMaService.switchoverTo(" appid ").getWxMaOpenApiService().clearQuotaByAppSecret() //多个
62+
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuotaByAppSecret.html">注意事项参考微信文档</a>
63+
*/
64+
boolean clearQuotaByAppSecret() throws WxErrorException;
65+
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -523,4 +523,10 @@ public interface WxMaService extends WxService {
523523
* @return getWxMaShopPayService
524524
*/
525525
WxMaShopPayService getWxMaShopPayService();
526+
527+
/**
528+
* 小程序openApi管理
529+
* @return getWxMaOpenApiService
530+
*/
531+
WxMaOpenApiService getWxMaOpenApiService();
526532
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ public abstract class BaseWxMaServiceImpl<H, P> implements WxMaService, RequestH
8585
private final WxMaProductOrderService productOrderService = new WxMaProductOrderServiceImpl(this);
8686
private final WxMaShopCouponService wxMaShopCouponService = new WxMaShopCouponServiceImpl(this);
8787
private final WxMaShopPayService wxMaShopPayService = new WxMaShopPayServiceImpl(this);
88+
private final WxMaOpenApiService wxMaOpenApiService = new WxMaOpenApiServiceImpl(this);
8889
private Map<String, WxMaConfig> configMap;
8990
private int retrySleepMillis = 1000;
9091
private int maxRetryTimes = 5;
@@ -634,4 +635,9 @@ public WxMaShopCouponService getWxMaShopCouponService() {
634635
public WxMaShopPayService getWxMaShopPayService() {
635636
return this.wxMaShopPayService;
636637
}
638+
639+
@Override
640+
public WxMaOpenApiService getWxMaOpenApiService() {
641+
return this.wxMaOpenApiService;
642+
}
637643
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaOpenApiServiceImpl.java‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
package cn.binarywang.wx.miniapp.api.impl;
2+
3+
import cn.binarywang.wx.miniapp.api.WxMaOpenApiService;
4+
import cn.binarywang.wx.miniapp.api.WxMaService;
5+
import cn.binarywang.wx.miniapp.bean.openapi.WxMiniGetApiQuotaResult;
6+
import cn.binarywang.wx.miniapp.bean.openapi.WxMiniGetRidInfoResult;
7+
import cn.binarywang.wx.miniapp.constant.WxMaApiUrlConstants;
8+
import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
9+
import com.google.gson.JsonObject;
10+
import lombok.RequiredArgsConstructor;
11+
import me.chanjar.weixin.common.enums.WxType;
12+
import me.chanjar.weixin.common.error.WxError;
13+
import me.chanjar.weixin.common.error.WxErrorException;
14+
import me.chanjar.weixin.common.util.json.GsonParser;
15+
16+
import static me.chanjar.weixin.common.api.WxConsts.ERR_CODE;
17+
18+
/**
19+
* @author shuiyihan12
20+
* @since 2023/7/7 17:08
21+
*/
22+
@RequiredArgsConstructor
23+
public class WxMaOpenApiServiceImpl implements WxMaOpenApiService {
24+
private final WxMaService wxMaService;
25+
26+
private static final String QUOTA = "quota";
27+
private static final String REQUEST = "request";
28+
29+
30+
@Override
31+
public boolean clearQuota() throws WxErrorException {
32+
JsonObject params = new JsonObject();
33+
params.addProperty("appid", this.wxMaService.getWxMaConfig().getAppid());
34+
String responseContent = this.wxMaService.post(WxMaApiUrlConstants.OpenApi.CLEAR_QUOTA, params.toString());
35+
parseErrorResponse(responseContent);
36+
return true;
37+
}
38+
39+
@Override
40+
public WxMiniGetApiQuotaResult getApiQuota(String cgiPath) throws WxErrorException {
41+
JsonObject params = new JsonObject();
42+
params.addProperty("cgi_path", cgiPath);
43+
String responseContent = this.wxMaService.post(WxMaApiUrlConstants.OpenApi.GET_API_QUOTA, params.toString());
44+
parseErrorResponse(responseContent);
45+
JsonObject response = GsonParser.parse(responseContent);
46+
if (response.has(QUOTA)) {
47+
return WxMaGsonBuilder.create().fromJson(response.getAsJsonObject(QUOTA), WxMiniGetApiQuotaResult.class);
48+
}
49+
return null;
50+
}
51+
52+
53+
@Override
54+
public WxMiniGetRidInfoResult getRidInfo(String rid) throws WxErrorException {
55+
JsonObject params = new JsonObject();
56+
params.addProperty("rid", rid);
57+
String responseContent = this.wxMaService.post(WxMaApiUrlConstants.OpenApi.GET_RID_INFO, params.toString());
58+
parseErrorResponse(responseContent);
59+
JsonObject response = GsonParser.parse(responseContent);
60+
if (response.has(REQUEST)) {
61+
return WxMaGsonBuilder.create().fromJson(response.getAsJsonObject(QUOTA), WxMiniGetRidInfoResult.class);
62+
}
63+
return null;
64+
}
65+
66+
@Override
67+
public boolean clearQuotaByAppSecret() throws WxErrorException {
68+
String url = String.format(WxMaApiUrlConstants.OpenApi.CLEAR_QUOTA_BY_APP_SECRET, this.wxMaService.getWxMaConfig().getAppid(), this.wxMaService.getWxMaConfig().getSecret());
69+
String responseContent = this.wxMaService.post(url, "");
70+
parseErrorResponse(responseContent);
71+
return true;
72+
}
73+
74+
75+
private void parseErrorResponse(String response) throws WxErrorException {
76+
JsonObject jsonObject = GsonParser.parse(response);
77+
if (jsonObject.get(ERR_CODE).getAsInt() != 0) {
78+
throw new WxErrorException(WxError.fromJson(response, WxType.MiniApp));
79+
}
80+
}
81+
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/openapi/WxMiniGetApiQuotaResult.java‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
package cn.binarywang.wx.miniapp.bean.openapi;
2+
3+
import com.google.gson.annotations.SerializedName;
4+
import lombok.Data;
5+
6+
/**
7+
* 查询API调用额度 返回数据
8+
*
9+
* @author shuiyihan12
10+
* @since 2023/7/10 16:52
11+
*/
12+
@Data
13+
public class WxMiniGetApiQuotaResult {
14+
15+
/**
16+
* 当天该账号可调用该接口的次数
17+
*/
18+
@SerializedName("daily_limit")
19+
private Integer dailyLimit;
20+
/**
21+
* 当天已经调用的次数
22+
*/
23+
private Integer used;
24+
/**
25+
* 当天剩余调用次数
26+
*/
27+
private Integer remain;
28+
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/openapi/WxMiniGetRidInfoResult.java‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
package cn.binarywang.wx.miniapp.bean.openapi;
2+
3+
import com.google.gson.annotations.SerializedName;
4+
import lombok.Data;
5+
6+
/**
7+
* 查询rid信息 返回数据
8+
* @author shuiyihan12
9+
* @since 2023/7/10 16:53
10+
*/
11+
@Data
12+
public class WxMiniGetRidInfoResult {
13+
14+
/**
15+
* 发起请求的时间戳
16+
*/
17+
@SerializedName("invoke_time")
18+
private Integer invokeTime;
19+
/**
20+
* 请求毫秒级耗时
21+
*/
22+
@SerializedName("cost_in_ms")
23+
private Integer costInMs;
24+
/**
25+
* 请求的URL参数
26+
*/
27+
@SerializedName("request_url")
28+
private String requestUrl;
29+
/**
30+
* post请求的请求参数
31+
*/
32+
@SerializedName("request_body")
33+
private String requestBody;
34+
/**
35+
* 接口请求返回参数
36+
*/
37+
@SerializedName("response_body")
38+
private String responseBody;
39+
/**
40+
* 接口请求的客户端ip
41+
*/
42+
@SerializedName("client_ip")
43+
private String clientIp;
44+
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,30 @@
1010
*/
1111
@UtilityClass
1212
public class WxMaApiUrlConstants {
13+
14+
/**
15+
* openApi管理
16+
*/
17+
public interface OpenApi {
18+
/**
19+
* 重置API调用次数
20+
*/
21+
String CLEAR_QUOTA = "https://api.weixin.qq.com/cgi-bin/clear_quota";
22+
/**
23+
* 查询API调用额度
24+
*/
25+
String GET_API_QUOTA = "https://api.weixin.qq.com/cgi-bin/openapi/quota/get";
26+
/**
27+
* 查询rid信息
28+
*/
29+
String GET_RID_INFO = "https://api.weixin.qq.com/cgi-bin/openapi/rid/get";
30+
/**
31+
* 使用AppSecret重置 API 调用次数
32+
*/
33+
String CLEAR_QUOTA_BY_APP_SECRET = "https://api.weixin.qq.com/cgi-bin/clear_quota/v2?appid=%s&appsecret=%s";
34+
35+
}
36+
1337
public interface Analysis {
1438
String GET_DAILY_SUMMARY_TREND_URL = "https://api.weixin.qq.com/datacube/getweanalysisappiddailysummarytrend";
1539
String GET_DAILY_VISIT_TREND_URL = "https://api.weixin.qq.com/datacube/getweanalysisappiddailyvisittrend";

0 commit comments

Comments
 (0)