🎨 规范变量名

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

@@ -16,16 +16,16 @@ public interface WxMpCardService {
   /**
    * 得到WxMpService.
    *
-   * @return WxMpService
+   * @return WxMpService wx mp service
    */
   WxMpService getWxMpService();
 
   /**
    * 获得卡券api_ticket，不强制刷新卡券api_ticket.
    *
-   * @return 卡券api_ticket
+   * @return 卡券api_ticket card api ticket
    * @throws WxErrorException 异常
-   * @see #getCardApiTicket(boolean)
+   * @see #getCardApiTicket(boolean) #getCardApiTicket(boolean)
    */
   String getCardApiTicket() throws WxErrorException;
 
@@ -38,7 +38,7 @@ public interface WxMpCardService {
    * </pre>
    *
    * @param forceRefresh 强制刷新
-   * @return 卡券api_ticket
+   * @return 卡券api_ticket card api ticket
    * @throws WxErrorException 异常
    */
   String getCardApiTicket(boolean forceRefresh) throws WxErrorException;
@@ -52,9 +52,8 @@ public interface WxMpCardService {
    * .9F.E6.88.90.E7.AE.97.E6.B3.95
    * </pre>
    *
-   * @param optionalSignParam 参与签名的参数数组。可以为下列字段：app_id, card_id, card_type, code, openid, location_id
+   * @param optionalSignParam 参与签名的参数数组。可以为下列字段：app_id, card_id, card_type, code, openid, location_id                          </br>注意：当做wx.chooseCard调用时，必须传入app_id参与签名，否则会造成签名失败导致拉取卡券列表为空
-   *                          </br>注意：当做wx.chooseCard调用时，必须传入app_id参与签名，否则会造成签名失败导致拉取卡券列表为空
+   * @return 卡券Api签名对象 wx card api signature
-   * @return 卡券Api签名对象
    * @throws WxErrorException 异常
    */
   WxCardApiSignature createCardApiSignature(String... optionalSignParam) throws WxErrorException;
@@ -63,7 +62,7 @@ public interface WxMpCardService {
    * 卡券Code解码.
    *
    * @param encryptCode 加密Code，通过JSSDK的chooseCard接口获得
-   * @return 解密后的Code
+   * @return 解密后的Code string
    * @throws WxErrorException 异常
    */
   String decryptCardCode(String encryptCode) throws WxErrorException;
@@ -75,7 +74,7 @@ public interface WxMpCardService {
    * @param cardId       卡券ID代表一类卡券
    * @param code         单张卡券的唯一标准
    * @param checkConsume 是否校验code核销状态，填入true和false时的code异常状态返回数据不同
-   * @return WxMpCardResult对象
+   * @return WxMpCardResult对象 wx mp card result
    * @throws WxErrorException 异常
    */
   WxMpCardResult queryCardCode(String cardId, String code, boolean checkConsume) throws WxErrorException;
@@ -84,7 +83,7 @@ public interface WxMpCardService {
    * 卡券Code核销。核销失败会抛出异常
    *
    * @param code 单张卡券的唯一标准
-   * @return 调用返回的JSON字符串。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
+   * @return 调用返回的JSON字符串 。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
    * @throws WxErrorException 异常
    */
   String consumeCardCode(String code) throws WxErrorException;
@@ -94,7 +93,7 @@ public interface WxMpCardService {
    *
    * @param code   单张卡券的唯一标准
    * @param cardId 当自定义Code卡券时需要传入card_id
-   * @return 调用返回的JSON字符串。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
+   * @return 调用返回的JSON字符串 。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
    * @throws WxErrorException 异常
    */
   String consumeCardCode(String code, String cardId) throws WxErrorException;
@@ -117,9 +116,7 @@ public interface WxMpCardService {
    * 详见 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
    *
    * @param cardId 卡券的ID
-   * @return 返回的卡券详情JSON字符串
+   * @return 返回的卡券详情JSON字符串  <br> [注] 由于返回的JSON格式过于复杂，难以定义其对应格式的Bean并且难以维护，因此只返回String格式的JSON串。 <br> 可由 com.google.gson.JsonParser#parse 等方法直接取JSON串中的某个字段。
-   * <br> [注] 由于返回的JSON格式过于复杂，难以定义其对应格式的Bean并且难以维护，因此只返回String格式的JSON串。
-   * <br> 可由 com.google.gson.JsonParser#parse 等方法直接取JSON串中的某个字段。
    * @throws WxErrorException 异常
    */
   String getCardDetail(String cardId) throws WxErrorException;
@@ -128,7 +125,7 @@ public interface WxMpCardService {
    * 添加测试白名单.
    *
    * @param openid 用户的openid
-   * @return string
+   * @return string string
    * @throws WxErrorException 异常
    */
   String addTestWhiteList(String openid) throws WxErrorException;
@@ -137,7 +134,7 @@ public interface WxMpCardService {
    * 创建卡券.
    *
    * @param cardCreateMessage 请求
-   * @return result
+   * @return result wx mp card create result
    * @throws WxErrorException 异常
    */
   WxMpCardCreateResult createCard(WxMpCardCreateRequest cardCreateMessage) throws WxErrorException;
@@ -147,7 +144,7 @@ public interface WxMpCardService {
    *
    * @param cardId   卡券编号
    * @param outerStr 二维码标识
-   * @return WxMpCardQrcodeCreateResult
+   * @return WxMpCardQrcodeCreateResult wx mp card qrcode create result
    * @throws WxErrorException 异常
    */
   WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr) throws WxErrorException;
@@ -158,7 +155,7 @@ public interface WxMpCardService {
    * @param cardId    卡券编号
    * @param outerStr  二维码标识
    * @param expiresIn 指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效
-   * @return WxMpCardQrcodeCreateResult
+   * @return WxMpCardQrcodeCreateResult wx mp card qrcode create result
    * @throws WxErrorException 异常
    */
   WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int expiresIn) throws WxErrorException;
@@ -169,10 +166,10 @@ public interface WxMpCardService {
    * @param cardId       卡券编号
    * @param outerStr     用户首次领卡时，会通过 领取事件推送 给商户； 对于会员卡的二维码，用户每次扫码打开会员卡后点击任何url，会将该值拼入url中，方便开发者定位扫码来源
    * @param expiresIn    指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效
-   * @param isUniqueCode 指定下发二维码，生成的二维码随机分配一个code，领取后不可再次扫描。填写true或false。默认false，注意填写该字段时，卡券须通过审核且库存不为0。
-   * @param code         卡券Code码,use_custom_code字段为true的卡券必须填写，非自定义code和导入code模式的卡券不必填写。
    * @param openid       指定领取者的openid，只有该用户能领取。bind_openid字段为true的卡券必须填写，非指定openid不必填写。
-   * @return WxMpCardQrcodeCreateResult
+   * @param code         卡券Code码,use_custom_code字段为true的卡券必须填写，非自定义code和导入code模式的卡券不必填写。
+   * @param isUniqueCode 指定下发二维码，生成的二维码随机分配一个code，领取后不可再次扫描。填写true或false。默认false，注意填写该字段时，卡券须通过审核且库存不为0。
+   * @return WxMpCardQrcodeCreateResult wx mp card qrcode create result
    * @throws WxErrorException 异常
    */
   WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int expiresIn, String openid,
@@ -182,7 +179,7 @@ public interface WxMpCardService {
    * 创建卡券货架.
    *
    * @param createRequest 货架创建参数
-   * @return WxMpCardLandingPageCreateResult
+   * @return WxMpCardLandingPageCreateResult wx mp card landing page create result
    * @throws WxErrorException 异常
    */
   WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateRequest createRequest)
@@ -195,7 +192,7 @@ public interface WxMpCardService {
    * @param cardId 卡券编号
    * @param code   用户会员卡号
    * @param reason 设置为失效的原因
-   * @return result
+   * @return result string
    * @throws WxErrorException 异常
    */
   String unavailableCardCode(String cardId, String code, String reason) throws WxErrorException;
@@ -204,17 +201,18 @@ public interface WxMpCardService {
    * 删除卡券接口.
    *
    * @param cardId 卡券id
-   * @return 删除结果
+   * @return 删除结果 wx mp card delete result
    * @throws WxErrorException 异常
    */
   WxMpCardDeleteResult deleteCard(String cardId) throws WxErrorException;
 
-
   /**
    * 导入自定义code(仅对自定义code商户)
    *
    * @param cardId   卡券id
    * @param codeList 需导入微信卡券后台的自定义code，上限为100个。
+   * @return the wx mp card code deposit result
+   * @throws WxErrorException the wx error exception
    */
   WxMpCardCodeDepositResult cardCodeDeposit(String cardId, List<String> codeList) throws WxErrorException;
 
@@ -222,15 +220,18 @@ public interface WxMpCardService {
    * 查询导入code数目接口
    *
    * @param cardId 卡券id
+   * @return the wx mp card code deposit count result
+   * @throws WxErrorException the wx error exception
    */
   WxMpCardCodeDepositCountResult cardCodeDepositCount(String cardId) throws WxErrorException;
 
-
   /**
    * 核查code接口
    *
    * @param cardId   卡券id
    * @param codeList 已经微信卡券后台的自定义code，上限为100个
+   * @return the wx mp card code checkcode result
+   * @throws WxErrorException the wx error exception
    */
   WxMpCardCodeCheckcodeResult cardCodeCheckcode(String cardId, List<String> codeList) throws WxErrorException;
 
@@ -238,6 +239,8 @@ public interface WxMpCardService {
    * 图文消息群发卡券获取内嵌html
    *
    * @param cardId 卡券id
+   * @return the wx mp card mpnews gethtml result
+   * @throws WxErrorException the wx error exception
    */
   WxMpCardMpnewsGethtmlResult cardMpnewsGethtml(String cardId) throws WxErrorException;
 
@@ -248,6 +251,7 @@ public interface WxMpCardService {
    *
    * @param cardId      卡券ID
    * @param changeValue 库存变更值，负值为减少库存
+   * @throws WxErrorException the wx error exception
    */
   void cardModifyStock(String cardId, Integer changeValue) throws WxErrorException;
 
@@ -259,6 +263,7 @@ public interface WxMpCardService {
    * @param cardId  卡券ID
    * @param oldCode 需变更的Code码
    * @param newCode 变更后的有效Code码
+   * @throws WxErrorException the wx error exception
    */
   void cardCodeUpdate(String cardId, String oldCode, String newCode) throws WxErrorException;
 
@@ -268,6 +273,7 @@ public interface WxMpCardService {
    *
    * @param cardId 卡券ID
    * @param isOpen 是否开启买单功能，填true/false
+   * @throws WxErrorException the wx error exception
    */
   void cardPaycellSet(String cardId, Boolean isOpen) throws WxErrorException;
 
@@ -279,6 +285,7 @@ public interface WxMpCardService {
    * @param isOpen           是否开启自助核销功能
    * @param needVerifyCod    用户核销时是否需要输入验证码， 填true/false， 默认为false
    * @param needRemarkAmount 用户核销时是否需要备注核销金额， 填true/false， 默认为false
+   * @throws WxErrorException the wx error exception
    */
   void cardSelfConsumeCellSet(String cardId, Boolean isOpen,
                               Boolean needVerifyCod, Boolean needRemarkAmount) throws WxErrorException;
@@ -289,8 +296,8 @@ public interface WxMpCardService {
    *
    * @param openId 需要查询的用户openid
    * @param cardId 卡券ID。不填写时默认查询当前appid下的卡券
-   * @return
+   * @return user card list
-   * @throws WxErrorException
+   * @throws WxErrorException the wx error exception
    */
   WxUserCardListResult getUserCardList(String openId, String cardId) throws WxErrorException;
 

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

@@ -19,19 +19,19 @@ public class WxMpCardCodeDepositResult  implements Serializable {
    * 成功的code
    */
   @SerializedName("succ_code")
-  private List<String> succCode;
+  private List<String> successCodes;
 
   /**
    * 重复导入的code
    */
   @SerializedName("duplicate_code")
-  private List<String> duplicateCode;
+  private List<String> duplicateCodes;
 
   /**
    * 失败的code
    */
   @SerializedName("fail_code")
-  private List<String> failCode;
+  private List<String> failCodes;
 
 
   public static WxMpCardCodeDepositResult fromJson(String json) {