Skip to content

Commit 57ab245

Browse files
binarywangbinarywang
committed
🎨 规范变量名
1 parent 1bac8f9 commit 57ab245

File tree

2 files changed

+38
-31
lines changed

2 files changed

+38
-31
lines changed

‎weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpCardService.java‎

Lines changed: 35 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ public interface WxMpCardService {
1616
/**
1717
* 得到WxMpService.
1818
*
19-
* @return WxMpService
19+
* @return WxMpService wx mp service
2020
*/
2121
WxMpService getWxMpService();
2222

2323
/**
2424
* 获得卡券api_ticket，不强制刷新卡券api_ticket.
2525
*
26-
* @return 卡券api_ticket
26+
* @return 卡券api_ticket card api ticket
2727
* @throws WxErrorException 异常
28-
* @see #getCardApiTicket(boolean)
28+
* @see #getCardApiTicket(boolean) #getCardApiTicket(boolean)
2929
*/
3030
String getCardApiTicket() throws WxErrorException;
3131

@@ -38,7 +38,7 @@ public interface WxMpCardService {
3838
* </pre>
3939
*
4040
* @param forceRefresh 强制刷新
41-
* @return 卡券api_ticket
41+
* @return 卡券api_ticket card api ticket
4242
* @throws WxErrorException 异常
4343
*/
4444
String getCardApiTicket(boolean forceRefresh) throws WxErrorException;
@@ -52,9 +52,8 @@ public interface WxMpCardService {
5252
* .9F.E6.88.90.E7.AE.97.E6.B3.95
5353
* </pre>
5454
*
55-
* @param optionalSignParam 参与签名的参数数组。可以为下列字段：app_id, card_id, card_type, code, openid, location_id
56-
* </br>注意：当做wx.chooseCard调用时，必须传入app_id参与签名，否则会造成签名失败导致拉取卡券列表为空
57-
* @return 卡券Api签名对象
55+
* @param optionalSignParam 参与签名的参数数组。可以为下列字段：app_id, card_id, card_type, code, openid, location_id </br>注意：当做wx.chooseCard调用时，必须传入app_id参与签名，否则会造成签名失败导致拉取卡券列表为空
56+
* @return 卡券Api签名对象 wx card api signature
5857
* @throws WxErrorException 异常
5958
*/
6059
WxCardApiSignature createCardApiSignature(String... optionalSignParam) throws WxErrorException;
@@ -63,7 +62,7 @@ public interface WxMpCardService {
6362
* 卡券Code解码.
6463
*
6564
* @param encryptCode 加密Code，通过JSSDK的chooseCard接口获得
66-
* @return 解密后的Code
65+
* @return 解密后的Code string
6766
* @throws WxErrorException 异常
6867
*/
6968
String decryptCardCode(String encryptCode) throws WxErrorException;
@@ -75,7 +74,7 @@ public interface WxMpCardService {
7574
* @param cardId 卡券ID代表一类卡券
7675
* @param code 单张卡券的唯一标准
7776
* @param checkConsume 是否校验code核销状态，填入true和false时的code异常状态返回数据不同
78-
* @return WxMpCardResult对象
77+
* @return WxMpCardResult对象 wx mp card result
7978
* @throws WxErrorException 异常
8079
*/
8180
WxMpCardResult queryCardCode(String cardId, String code, boolean checkConsume) throws WxErrorException;
@@ -84,7 +83,7 @@ public interface WxMpCardService {
8483
* 卡券Code核销。核销失败会抛出异常
8584
*
8685
* @param code 单张卡券的唯一标准
87-
* @return 调用返回的JSON字符串。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
86+
* @return 调用返回的JSON字符串 。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
8887
* @throws WxErrorException 异常
8988
*/
9089
String consumeCardCode(String code) throws WxErrorException;
@@ -94,7 +93,7 @@ public interface WxMpCardService {
9493
*
9594
* @param code 单张卡券的唯一标准
9695
* @param cardId 当自定义Code卡券时需要传入card_id
97-
* @return 调用返回的JSON字符串。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
96+
* @return 调用返回的JSON字符串 。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
9897
* @throws WxErrorException 异常
9998
*/
10099
String consumeCardCode(String code, String cardId) throws WxErrorException;
@@ -117,9 +116,7 @@ public interface WxMpCardService {
117116
* 详见 https://mp.weixin.qq.com/wiki/14/8dd77aeaee85f922db5f8aa6386d385e.html#.E6.9F.A5.E7.9C.8B.E5.8D.A1.E5.88.B8.E8.AF.A6.E6.83.85
118117
*
119118
* @param cardId 卡券的ID
120-
* @return 返回的卡券详情JSON字符串
121-
* <br> [注] 由于返回的JSON格式过于复杂，难以定义其对应格式的Bean并且难以维护，因此只返回String格式的JSON串。
122-
* <br> 可由 com.google.gson.JsonParser#parse 等方法直接取JSON串中的某个字段。
119+
* @return 返回的卡券详情JSON字符串 <br> [注] 由于返回的JSON格式过于复杂，难以定义其对应格式的Bean并且难以维护，因此只返回String格式的JSON串。 <br> 可由 com.google.gson.JsonParser#parse 等方法直接取JSON串中的某个字段。
123120
* @throws WxErrorException 异常
124121
*/
125122
String getCardDetail(String cardId) throws WxErrorException;
@@ -128,7 +125,7 @@ public interface WxMpCardService {
128125
* 添加测试白名单.
129126
*
130127
* @param openid 用户的openid
131-
* @return string
128+
* @return string string
132129
* @throws WxErrorException 异常
133130
*/
134131
String addTestWhiteList(String openid) throws WxErrorException;
@@ -137,7 +134,7 @@ public interface WxMpCardService {
137134
* 创建卡券.
138135
*
139136
* @param cardCreateMessage 请求
140-
* @return result
137+
* @return result wx mp card create result
141138
* @throws WxErrorException 异常
142139
*/
143140
WxMpCardCreateResult createCard(WxMpCardCreateRequest cardCreateMessage) throws WxErrorException;
@@ -147,7 +144,7 @@ public interface WxMpCardService {
147144
*
148145
* @param cardId 卡券编号
149146
* @param outerStr 二维码标识
150-
* @return WxMpCardQrcodeCreateResult
147+
* @return WxMpCardQrcodeCreateResult wx mp card qrcode create result
151148
* @throws WxErrorException 异常
152149
*/
153150
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr) throws WxErrorException;
@@ -158,7 +155,7 @@ public interface WxMpCardService {
158155
* @param cardId 卡券编号
159156
* @param outerStr 二维码标识
160157
* @param expiresIn 指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效
161-
* @return WxMpCardQrcodeCreateResult
158+
* @return WxMpCardQrcodeCreateResult wx mp card qrcode create result
162159
* @throws WxErrorException 异常
163160
*/
164161
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int expiresIn) throws WxErrorException;
@@ -169,10 +166,10 @@ public interface WxMpCardService {
169166
* @param cardId 卡券编号
170167
* @param outerStr 用户首次领卡时，会通过 领取事件推送 给商户； 对于会员卡的二维码，用户每次扫码打开会员卡后点击任何url，会将该值拼入url中，方便开发者定位扫码来源
171168
* @param expiresIn 指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效
172-
* @param isUniqueCode 指定下发二维码，生成的二维码随机分配一个code，领取后不可再次扫描。填写true或false。默认false，注意填写该字段时，卡券须通过审核且库存不为0。
173-
* @param code 卡券Code码,use_custom_code字段为true的卡券必须填写，非自定义code和导入code模式的卡券不必填写。
174169
* @param openid 指定领取者的openid，只有该用户能领取。bind_openid字段为true的卡券必须填写，非指定openid不必填写。
175-
* @return WxMpCardQrcodeCreateResult
170+
* @param code 卡券Code码,use_custom_code字段为true的卡券必须填写，非自定义code和导入code模式的卡券不必填写。
171+
* @param isUniqueCode 指定下发二维码，生成的二维码随机分配一个code，领取后不可再次扫描。填写true或false。默认false，注意填写该字段时，卡券须通过审核且库存不为0。
172+
* @return WxMpCardQrcodeCreateResult wx mp card qrcode create result
176173
* @throws WxErrorException 异常
177174
*/
178175
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int expiresIn, String openid,
@@ -182,7 +179,7 @@ WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int
182179
* 创建卡券货架.
183180
*
184181
* @param createRequest 货架创建参数
185-
* @return WxMpCardLandingPageCreateResult
182+
* @return WxMpCardLandingPageCreateResult wx mp card landing page create result
186183
* @throws WxErrorException 异常
187184
*/
188185
WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateRequest createRequest)
@@ -195,7 +192,7 @@ WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateReque
195192
* @param cardId 卡券编号
196193
* @param code 用户会员卡号
197194
* @param reason 设置为失效的原因
198-
* @return result
195+
* @return result string
199196
* @throws WxErrorException 异常
200197
*/
201198
String unavailableCardCode(String cardId, String code, String reason) throws WxErrorException;
@@ -204,40 +201,46 @@ WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateReque
204201
* 删除卡券接口.
205202
*
206203
* @param cardId 卡券id
207-
* @return 删除结果
204+
* @return 删除结果 wx mp card delete result
208205
* @throws WxErrorException 异常
209206
*/
210207
WxMpCardDeleteResult deleteCard(String cardId) throws WxErrorException;
211208

212-
213209
/**
214210
* 导入自定义code(仅对自定义code商户)
215211
*
216212
* @param cardId 卡券id
217213
* @param codeList 需导入微信卡券后台的自定义code，上限为100个。
214+
* @return the wx mp card code deposit result
215+
* @throws WxErrorException the wx error exception
218216
*/
219217
WxMpCardCodeDepositResult cardCodeDeposit(String cardId, List<String> codeList) throws WxErrorException;
220218

221219
/**
222220
* 查询导入code数目接口
223221
*
224222
* @param cardId 卡券id
223+
* @return the wx mp card code deposit count result
224+
* @throws WxErrorException the wx error exception
225225
*/
226226
WxMpCardCodeDepositCountResult cardCodeDepositCount(String cardId) throws WxErrorException;
227227

228-
229228
/**
230229
* 核查code接口
231230
*
232231
* @param cardId 卡券id
233232
* @param codeList 已经微信卡券后台的自定义code，上限为100个
233+
* @return the wx mp card code checkcode result
234+
* @throws WxErrorException the wx error exception
234235
*/
235236
WxMpCardCodeCheckcodeResult cardCodeCheckcode(String cardId, List<String> codeList) throws WxErrorException;
236237

237238
/**
238239
* 图文消息群发卡券获取内嵌html
239240
*
240241
* @param cardId 卡券id
242+
* @return the wx mp card mpnews gethtml result
243+
* @throws WxErrorException the wx error exception
241244
*/
242245
WxMpCardMpnewsGethtmlResult cardMpnewsGethtml(String cardId) throws WxErrorException;
243246

@@ -248,6 +251,7 @@ WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateReque
248251
*
249252
* @param cardId 卡券ID
250253
* @param changeValue 库存变更值，负值为减少库存
254+
* @throws WxErrorException the wx error exception
251255
*/
252256
void cardModifyStock(String cardId, Integer changeValue) throws WxErrorException;
253257

@@ -259,6 +263,7 @@ WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateReque
259263
* @param cardId 卡券ID
260264
* @param oldCode 需变更的Code码
261265
* @param newCode 变更后的有效Code码
266+
* @throws WxErrorException the wx error exception
262267
*/
263268
void cardCodeUpdate(String cardId, String oldCode, String newCode) throws WxErrorException;
264269

@@ -268,6 +273,7 @@ WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateReque
268273
*
269274
* @param cardId 卡券ID
270275
* @param isOpen 是否开启买单功能，填true/false
276+
* @throws WxErrorException the wx error exception
271277
*/
272278
void cardPaycellSet(String cardId, Boolean isOpen) throws WxErrorException;
273279

@@ -279,6 +285,7 @@ WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateReque
279285
* @param isOpen 是否开启自助核销功能
280286
* @param needVerifyCod 用户核销时是否需要输入验证码， 填true/false， 默认为false
281287
* @param needRemarkAmount 用户核销时是否需要备注核销金额， 填true/false， 默认为false
288+
* @throws WxErrorException the wx error exception
282289
*/
283290
void cardSelfConsumeCellSet(String cardId, Boolean isOpen,
284291
Boolean needVerifyCod, Boolean needRemarkAmount) throws WxErrorException;
@@ -289,8 +296,8 @@ void cardSelfConsumeCellSet(String cardId, Boolean isOpen,
289296
*
290297
* @param openId 需要查询的用户openid
291298
* @param cardId 卡券ID。不填写时默认查询当前appid下的卡券
292-
* @return
293-
* @throws WxErrorException
299+
* @return user card list
300+
* @throws WxErrorException the wx error exception
294301
*/
295302
WxUserCardListResult getUserCardList(String openId, String cardId) throws WxErrorException;
296303

‎weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/WxMpCardCodeDepositResult.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@ public class WxMpCardCodeDepositResult implements Serializable {
1919
* 成功的code
2020
*/
2121
@SerializedName("succ_code")
22-
private List<String> succCode;
22+
private List<String> successCodes;
2323

2424
/**
2525
* 重复导入的code
2626
*/
2727
@SerializedName("duplicate_code")
28-
private List<String> duplicateCode;
28+
private List<String> duplicateCodes;
2929

3030
/**
3131
* 失败的code
3232
*/
3333
@SerializedName("fail_code")
34-
private List<String> failCode;
34+
private List<String> failCodes;
3535

3636

3737
public static WxMpCardCodeDepositResult fromJson(String json) {

0 commit comments

Comments
 (0)