Skip to content

Commit 0affa26

Browse files
binarywangbinarywang
committed
🎨 统一抽取errcode常量，同步优化规范部分代码
1 parent 54d1b92 commit 0affa26

47 files changed

Lines changed: 166 additions & 144 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/api/WxConsts.java‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
package me.chanjar.weixin.common.api;
22

3+
import lombok.experimental.UtilityClass;
4+
35
import java.util.Arrays;
46
import java.util.HashMap;
57
import java.util.List;
@@ -12,6 +14,7 @@
1214
*
1315
* @author Daniel Qian & binarywang & Wang_Wong
1416
*/
17+
@UtilityClass
1518
public class WxConsts {
1619
/**
1720
* access_token 相关错误代码
@@ -25,9 +28,15 @@ public class WxConsts {
2528
public static final List<Integer> ACCESS_TOKEN_ERROR_CODES = Arrays.asList(CODE_40001.getCode(),
2629
CODE_40014.getCode(), CODE_42001.getCode());
2730

31+
/**
32+
* 微信接口返回的参数errcode.
33+
*/
34+
public static final String ERR_CODE = "errcode";
35+
2836
/**
2937
* 微信推送过来的消息的类型，和发送给微信xml格式消息的消息类型.
3038
*/
39+
@UtilityClass
3140
public static class XmlMsgType {
3241
public static final String TEXT = "text";
3342
public static final String IMAGE = "image";
@@ -51,6 +60,7 @@ public static class XmlMsgType {
5160
/**
5261
* 主动发送消息(即客服消息)的消息类型.
5362
*/
63+
@UtilityClass
5464
public static class KefuMsgType {
5565
/**
5666
* 文本消息.
@@ -137,6 +147,7 @@ public static class KefuMsgType {
137147
* 发送「学校通知」类型
138148
* https://developer.work.weixin.qq.com/document/path/92321
139149
*/
150+
@UtilityClass
140151
public static class SchoolContactMsgType {
141152

142153
/**
@@ -184,6 +195,7 @@ public static class SchoolContactMsgType {
184195
/**
185196
* 企业微信模板卡片消息的卡片类型
186197
*/
198+
@UtilityClass
187199
public static class TemplateCardType {
188200
/**
189201
* 文本通知型卡片
@@ -210,6 +222,7 @@ public static class TemplateCardType {
210222
/**
211223
* 表示是否是保密消息，0表示否，1表示是，默认0.
212224
*/
225+
@UtilityClass
213226
public static class KefuMsgSafe {
214227
public static final String NO = "0";
215228
public static final String YES = "1";
@@ -218,6 +231,7 @@ public static class KefuMsgSafe {
218231
/**
219232
* 群发消息的消息类型.
220233
*/
234+
@UtilityClass
221235
public static class MassMsgType {
222236
public static final String MPNEWS = "mpnews";
223237
public static final String TEXT = "text";
@@ -230,6 +244,7 @@ public static class MassMsgType {
230244
/**
231245
* 群发消息后微信端推送给服务器的反馈消息.
232246
*/
247+
@UtilityClass
233248
public static class MassMsgStatus {
234249
public static final String SEND_SUCCESS = "send success";
235250
public static final String SEND_FAIL = "send fail";
@@ -277,6 +292,7 @@ public static class MassMsgStatus {
277292
/**
278293
* 微信端推送过来的事件类型.
279294
*/
295+
@UtilityClass
280296
public static class EventType {
281297
public static final String SUBSCRIBE = "subscribe";
282298
public static final String UNSUBSCRIBE = "unsubscribe";
@@ -417,7 +433,7 @@ public static class EventType {
417433
/**
418434
* 小程序自定义交易组件支付通知
419435
*/
420-
public static final String OPEN_PRODUCT_ORDER_PAY = "open_product_order_pay";
436+
public static final String OPEN_PRODUCT_ORDER_PAY = "open_product_order_pay";
421437
/**
422438
* 点击菜单跳转小程序的事件推送
423439
*/
@@ -453,6 +469,7 @@ public static class MediaFileType {
453469
/**
454470
* 自定义菜单的按钮类型.
455471
*/
472+
@UtilityClass
456473
public static class MenuButtonType {
457474
/**
458475
* 点击推事件.
@@ -503,6 +520,7 @@ public static class MenuButtonType {
503520
/**
504521
* oauth2网页授权的scope.
505522
*/
523+
@UtilityClass
506524
public static class OAuth2Scope {
507525
/**
508526
* 不弹出授权页面，直接跳转，只能获取用户openid.
@@ -523,13 +541,15 @@ public static class OAuth2Scope {
523541
/**
524542
* 网页应用登录授权作用域.
525543
*/
544+
@UtilityClass
526545
public static class QrConnectScope {
527546
public static final String SNSAPI_LOGIN = "snsapi_login";
528547
}
529548

530549
/**
531550
* 永久素材类型.
532551
*/
552+
@UtilityClass
533553
public static class MaterialType {
534554
public static final String NEWS = "news";
535555
public static final String VOICE = "voice";
@@ -541,6 +561,7 @@ public static class MaterialType {
541561
/**
542562
* 网络检测入参.
543563
*/
564+
@UtilityClass
544565
public static class NetCheckArgs {
545566
public static final String ACTIONDNS = "dns";
546567
public static final String ACTIONPING = "ping";
@@ -554,6 +575,7 @@ public static class NetCheckArgs {
554575
/**
555576
* appId 类型
556577
*/
578+
@UtilityClass
557579
public static class AppIdType {
558580
/**
559581
* 公众号appId类型

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/bean/result/WxMinishopImageUploadCustomizeResult.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import com.google.gson.JsonObject;
44
import com.google.gson.JsonParser;
55
import lombok.Data;
6+
import me.chanjar.weixin.common.api.WxConsts;
67
import me.chanjar.weixin.common.util.json.WxGsonBuilder;
78

89
import java.io.Serializable;
@@ -17,7 +18,7 @@ public class WxMinishopImageUploadCustomizeResult implements Serializable {
1718
public static WxMinishopImageUploadCustomizeResult fromJson(String json) {
1819
JsonObject jsonObject = new JsonParser().parse(json).getAsJsonObject();
1920
WxMinishopImageUploadCustomizeResult result = new WxMinishopImageUploadCustomizeResult();
20-
result.setErrcode(jsonObject.get("errcode").getAsNumber().toString());
21+
result.setErrcode(jsonObject.get(WxConsts.ERR_CODE).getAsNumber().toString());
2122
if (result.getErrcode().equals("0")) {
2223
WxMinishopPicFileCustomizeResult picFileResult = new WxMinishopPicFileCustomizeResult();
2324
JsonObject picObject = jsonObject.get("img_info").getAsJsonObject();

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/bean/result/WxMinishopImageUploadResult.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import com.google.gson.JsonObject;
55
import com.google.gson.JsonParser;
66
import lombok.Data;
7+
import me.chanjar.weixin.common.api.WxConsts;
78
import me.chanjar.weixin.common.util.json.WxGsonBuilder;
89

910
import java.io.Serializable;
@@ -22,7 +23,7 @@ public class WxMinishopImageUploadResult implements Serializable {
2223
public static WxMinishopImageUploadResult fromJson(String json) {
2324
JsonObject jsonObject = new JsonParser().parse(json).getAsJsonObject();
2425
WxMinishopImageUploadResult result = new WxMinishopImageUploadResult();
25-
result.setErrcode(jsonObject.get("errcode").getAsNumber().toString());
26+
result.setErrcode(jsonObject.get(WxConsts.ERR_CODE).getAsNumber().toString());
2627
if (result.getErrcode().equals("0")) {
2728
WxMinishopPicFileResult picFileResult = new WxMinishopPicFileResult();
2829
JsonObject picObject = jsonObject.get("pic_file").getAsJsonObject();

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxErrorAdapter.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package me.chanjar.weixin.common.util.json;
22

33
import com.google.gson.*;
4+
import me.chanjar.weixin.common.api.WxConsts;
45
import me.chanjar.weixin.common.error.WxError;
56

67
import java.lang.reflect.Type;
@@ -16,8 +17,8 @@ public WxError deserialize(JsonElement json, Type typeOfT, JsonDeserializationCo
1617
WxError.WxErrorBuilder errorBuilder = WxError.builder();
1718
JsonObject wxErrorJsonObject = json.getAsJsonObject();
1819

19-
if (wxErrorJsonObject.get("errcode") != null && !wxErrorJsonObject.get("errcode").isJsonNull()) {
20-
errorBuilder.errorCode(GsonHelper.getAsPrimitiveInt(wxErrorJsonObject.get("errcode")));
20+
if (wxErrorJsonObject.get(WxConsts.ERR_CODE) != null && !wxErrorJsonObject.get(WxConsts.ERR_CODE).isJsonNull()) {
21+
errorBuilder.errorCode(GsonHelper.getAsPrimitiveInt(wxErrorJsonObject.get(WxConsts.ERR_CODE)));
2122
}
2223
if (wxErrorJsonObject.get("errmsg") != null && !wxErrorJsonObject.get("errmsg").isJsonNull()) {
2324
errorBuilder.errorMsg(GsonHelper.getAsString(wxErrorJsonObject.get("errmsg")));

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import com.google.gson.JsonObject;
44
import com.google.gson.reflect.TypeToken;
55
import lombok.RequiredArgsConstructor;
6+
import me.chanjar.weixin.common.api.WxConsts;
67
import me.chanjar.weixin.common.enums.WxType;
78
import me.chanjar.weixin.common.error.WxError;
89
import me.chanjar.weixin.common.error.WxErrorException;
@@ -46,7 +47,7 @@ public void set(WxCpAgent agentInfo) throws WxErrorException {
4647
String url = this.mainService.getWxCpConfigStorage().getApiUrl(AGENT_SET);
4748
String responseContent = this.mainService.post(url, agentInfo.toJson());
4849
JsonObject jsonObject = GsonParser.parse(responseContent);
49-
if (jsonObject.get("errcode").getAsInt() != 0) {
50+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() != 0) {
5051
throw new WxErrorException(WxError.fromJson(responseContent, WxType.CP));
5152
}
5253
}
@@ -56,7 +57,7 @@ public List<WxCpAgent> list() throws WxErrorException {
5657
String url = this.mainService.getWxCpConfigStorage().getApiUrl(AGENT_LIST);
5758
String responseContent = this.mainService.get(url, null);
5859
JsonObject jsonObject = GsonParser.parse(responseContent);
59-
if (jsonObject.get("errcode").getAsInt() != 0) {
60+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() != 0) {
6061
throw new WxErrorException(WxError.fromJson(responseContent, WxType.CP));
6162
}
6263

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/BaseWxCpTpServiceImpl.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import com.google.gson.JsonObject;
66
import lombok.SneakyThrows;
77
import lombok.extern.slf4j.Slf4j;
8+
import me.chanjar.weixin.common.api.WxConsts;
89
import me.chanjar.weixin.common.bean.WxAccessToken;
910
import me.chanjar.weixin.common.bean.WxJsapiSignature;
1011
import me.chanjar.weixin.common.enums.WxType;
@@ -163,7 +164,7 @@ public String getSuiteJsApiTicket(String authCorpId) throws WxErrorException {
163164
"type=agent_config&access_token=" + this.configStorage.getAccessToken(authCorpId), true);
164165

165166
JsonObject jsonObject = GsonParser.parse(resp);
166-
if (jsonObject.get("errcode").getAsInt() == 0) {
167+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() == 0) {
167168
String jsApiTicket = jsonObject.get("ticket").getAsString();
168169
int expiredInSeconds = jsonObject.get("expires_in").getAsInt();
169170
synchronized (globalJsApiTicketRefreshLock) {
@@ -193,7 +194,7 @@ public String getAuthCorpJsApiTicket(String authCorpId) throws WxErrorException
193194
"access_token=" + this.configStorage.getAccessToken(authCorpId), true);
194195

195196
JsonObject jsonObject = GsonParser.parse(resp);
196-
if (jsonObject.get("errcode").getAsInt() == 0) {
197+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() == 0) {
197198
String jsApiTicket = jsonObject.get("ticket").getAsString();
198199
int expiredInSeconds = jsonObject.get("expires_in").getAsInt();
199200

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
import cn.binarywang.wx.miniapp.api.WxMaService;
55
import cn.binarywang.wx.miniapp.bean.cloud.*;
66
import cn.binarywang.wx.miniapp.bean.cloud.request.WxCloudSendSmsV2Request;
7-
import cn.binarywang.wx.miniapp.constant.WxMaConstants;
87
import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
98
import cn.binarywang.wx.miniapp.util.JoinerUtils;
109
import com.google.common.collect.ImmutableMap;
@@ -14,6 +13,7 @@
1413
import com.google.gson.JsonObject;
1514
import lombok.RequiredArgsConstructor;
1615
import lombok.extern.slf4j.Slf4j;
16+
import me.chanjar.weixin.common.api.WxConsts;
1717
import me.chanjar.weixin.common.error.WxError;
1818
import me.chanjar.weixin.common.error.WxErrorException;
1919
import me.chanjar.weixin.common.util.json.GsonParser;
@@ -65,7 +65,7 @@ public List<String> add(String collection, List list) throws WxErrorException {
6565

6666
String responseContent = wxMaService.post(DATABASE_ADD_URL, params.toString());
6767
JsonObject jsonObject = GsonParser.parse(responseContent);
68-
if (jsonObject.get(WxMaConstants.ERRCODE).getAsInt() != 0) {
68+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() != 0) {
6969
throw new WxErrorException(WxError.fromJson(responseContent));
7070
}
7171
JsonArray idArray = jsonObject.getAsJsonArray("id_list");
@@ -89,7 +89,7 @@ public String add(String collection, Object obj) throws WxErrorException {
8989

9090
String responseContent = wxMaService.post(DATABASE_ADD_URL, params.toString());
9191
JsonObject jsonObject = GsonParser.parse(responseContent);
92-
if (jsonObject.get(WxMaConstants.ERRCODE).getAsInt() != 0) {
92+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() != 0) {
9393
throw new WxErrorException(WxError.fromJson(responseContent));
9494
}
9595
JsonArray idArray = jsonObject.getAsJsonArray("id_list");
@@ -120,7 +120,7 @@ public Integer delete(String collection, String whereJson) throws WxErrorExcepti
120120

121121
String responseContent = wxMaService.post(DATABASE_DELETE_URL, params.toString());
122122
JsonObject jsonObject = GsonParser.parse(responseContent);
123-
if (jsonObject.get(WxMaConstants.ERRCODE).getAsInt() != 0) {
123+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() != 0) {
124124
throw new WxErrorException(WxError.fromJson(responseContent));
125125
}
126126
return jsonObject.get("deleted").getAsInt();

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
import cn.binarywang.wx.miniapp.constant.WxMaConstants;
88
import com.google.gson.JsonObject;
99
import lombok.RequiredArgsConstructor;
10+
import me.chanjar.weixin.common.api.WxConsts;
1011
import me.chanjar.weixin.common.enums.WxType;
1112
import me.chanjar.weixin.common.error.WxError;
1213
import me.chanjar.weixin.common.error.WxErrorException;
@@ -32,7 +33,7 @@ public class WxMaDeviceSubscribeServiceImpl implements WxMaDeviceSubscribeServic
3233
public String getSnTicket(WxMaDeviceTicketRequest deviceTicketRequest) throws WxErrorException {
3334
String responseContent = this.service.post(GET_SN_TICKET_URL, deviceTicketRequest.toJson());
3435
JsonObject jsonObject = GsonParser.parse(responseContent);
35-
if (jsonObject.get(WxMaConstants.ERRCODE).getAsInt() != 0) {
36+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() != 0) {
3637
throw new WxErrorException(WxError.fromJson(responseContent, WxType.MiniApp));
3738
}
3839
String snTicket = jsonObject.get("sn_ticket").getAsString();
@@ -43,7 +44,7 @@ public String getSnTicket(WxMaDeviceTicketRequest deviceTicketRequest) throws Wx
4344
public void sendDeviceSubscribeMsg(WxMaDeviceSubscribeMessageRequest deviceSubscribeMessageRequest) throws WxErrorException {
4445
String responseContent = this.service.post(SEND_DEVICE_SUBSCRIBE_MSG_URL, deviceSubscribeMessageRequest.toJson());
4546
JsonObject jsonObject = GsonParser.parse(responseContent);
46-
if (jsonObject.get(WxMaConstants.ERRCODE).getAsInt() != 0) {
47+
if (jsonObject.get(WxConsts.ERR_CODE).getAsInt() != 0) {
4748
throw new WxErrorException(WxError.fromJson(responseContent, WxType.MiniApp));
4849
}
4950
}

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@
3636
import org.apache.commons.lang3.ObjectUtils;
3737
import org.apache.commons.lang3.StringUtils;
3838

39+
import static me.chanjar.weixin.common.api.WxConsts.ERR_CODE;
40+
3941
/**
4042
* 微信小程序即时配送服务.
4143
* <pre>
@@ -49,11 +51,6 @@
4951
@RequiredArgsConstructor
5052
public class WxMaImmediateDeliveryServiceImpl implements WxMaImmediateDeliveryService {
5153

52-
/**
53-
* 微信响应码.
54-
*/
55-
public static final String ERR_CODE = "errcode";
56-
5754
/**
5855
* 顺丰同城响应码.
5956
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import java.util.Map;
2020

2121
import static cn.binarywang.wx.miniapp.constant.WxMaApiUrlConstants.Broadcast.Room;
22+
import static me.chanjar.weixin.common.api.WxConsts.ERR_CODE;
2223

2324
/**
2425
* <pre>
@@ -30,7 +31,6 @@
3031
@Slf4j
3132
@RequiredArgsConstructor
3233
public class WxMaLiveServiceImpl implements WxMaLiveService {
33-
private static final String ERR_CODE = "errcode";
3434
private static final String ROOM_ID = "roomId";
3535
private final WxMaService wxMaService;
3636

0 commit comments

Comments
 (0)