Merge pull request #263 from mgcnrx11/feat_card_coupon

Feature card coupon

Author: chanjarster

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

@@ -47,7 +47,7 @@ public class WxConsts {
   ///////////////////////
   public static final String MASS_ST_SUCCESS = "send success";
   public static final String MASS_ST_FAIL = "send fail";
-  public static final String MASS_ST_涉嫌广告 = "err(10001)"; 
+  public static final String MASS_ST_涉嫌广告 = "err(10001)";
   public static final String MASS_ST_涉嫌政治 = "err(20001)";
   public static final String MASS_ST_涉嫌社会 = "err(20004)";
   public static final String MASS_ST_涉嫌色情 = "err(20002)";
@@ -93,6 +93,15 @@ public class WxConsts {
   public static final String EVT_LOCATION_SELECT = "location_select";
   public static final String EVT_TEMPLATESENDJOBFINISH = "TEMPLATESENDJOBFINISH";
   public static final String EVT_ENTER_AGENT = "enter_agent";
+  public static final String EVT_CARD_PASS_CHECK = "card_pass_check";
+  public static final String EVT_CARD_NOT_PASS_CHECK = "card_not_pass_check";
+  public static final String EVT_USER_GET_CARD = "user_get_card";
+  public static final String EVT_USER_DEL_CARD = "user_del_card";
+  public static final String EVT_USER_CONSUME_CARD = "user_consume_card";
+  public static final String EVT_USER_PAY_FROM_PAY_CELL = "user_pay_from_pay_cell";
+  public static final String EVT_USER_VIEW_CARD = "user_view_card";
+  public static final String EVT_USER_ENTER_SESSION_FROM_CARD = "user_enter_session_from_card";
+  public static final String EVT_CARD_SKU_REMIND = "card_sku_remind"; // 库存报警
 
   ///////////////////////
   // 上传多媒体文件的类型

weixin-java-common/src/main/java/me/chanjar/weixin/common/bean/WxCardApiSignature.java

@@ -0,0 +1,102 @@
+package me.chanjar.weixin.common.bean;
+
+import java.io.Serializable;
+
+/**
+ * 卡券Api签名
+ *
+ * @author YuJian
+ * @version 15/11/8
+ */
+public class WxCardApiSignature implements Serializable {
+
+    private String appId;
+
+    private String cardId;
+
+    private String cardType;
+
+    private String locationId;
+
+    private String code;
+
+    private String openId;
+
+    private Long timestamp;
+
+    private String nonceStr;
+
+    private String signature;
+
+    public String getAppId() {
+      return appId;
+    }
+
+    public void setAppId(String appId) {
+      this.appId = appId;
+    }
+
+    public String getCardId() {
+      return cardId;
+    }
+
+    public void setCardId(String cardId) {
+      this.cardId = cardId;
+    }
+
+    public String getCardType() {
+      return cardType;
+    }
+
+    public void setCardType(String cardType) {
+      this.cardType = cardType;
+    }
+
+    public String getLocationId() {
+      return locationId;
+    }
+
+  public void setLocationId(String locationId) {
+    this.locationId = locationId;
+  }
+
+  public String getCode() {
+      return code;
+    }
+
+    public void setCode(String code) {
+      this.code = code;
+    }
+
+    public String getOpenId() {
+      return openId;
+    }
+
+    public void setOpenId(String openId) {
+      this.openId = openId;
+    }
+
+    public Long getTimestamp() {
+      return timestamp;
+    }
+
+    public void setTimestamp(Long timestamp) {
+      this.timestamp = timestamp;
+    }
+
+    public String getNonceStr() {
+      return nonceStr;
+    }
+
+    public void setNonceStr(String nonceStr) {
+      this.nonceStr = nonceStr;
+    }
+
+    public String getSignature() {
+      return signature;
+    }
+
+    public void setSignature(String signature) {
+      this.signature = signature;
+    }
+}

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

@@ -50,6 +50,21 @@ public interface WxMpConfigStorage {
    */
   public void updateJsapiTicket(String jsapiTicket, int expiresInSeconds);
 
+  public String getCardApiTicket();
+
+  public boolean isCardApiTicketExpired();
+
+  /**
+   * 强制将卡券api ticket过期掉
+   */
+  public void expireCardApiTicket();
+
+  /**
+   * 应该是线程安全的
+   * @param cardApiTicket
+   */
+  public void updateCardApiTicket(String cardApiTicket, int expiresInSeconds);
+
   public String getAppId();
 
   public String getSecret();

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

@@ -32,6 +32,9 @@ public class WxMpInMemoryConfigStorage implements WxMpConfigStorage {
   protected volatile String jsapiTicket;
   protected volatile long jsapiTicketExpiresTime;
 
+  protected volatile String cardApiTicket;
+  protected volatile long cardApiTicketExpiresTime;
+
   /**
    * 临时文件目录
    */
@@ -90,6 +93,27 @@ public void expireJsapiTicket() {
     this.jsapiTicketExpiresTime = 0;
   }
 
+  /**
+   * 卡券api_ticket
+   */
+  public String getCardApiTicket() {
+    return cardApiTicket;
+  }
+
+  public boolean isCardApiTicketExpired() {
+    return System.currentTimeMillis() > this.cardApiTicketExpiresTime;
+  }
+
+  public synchronized void updateCardApiTicket(String cardApiTicket, int expiresInSeconds) {
+    this.cardApiTicket = cardApiTicket;
+    // 预留200秒的时间
+    this.cardApiTicketExpiresTime = System.currentTimeMillis() + (expiresInSeconds - 200) * 1000l;
+  }
+
+  public void expireCardApiTicket() {
+    this.cardApiTicketExpiresTime = 0;
+  }
+
   public String getAppId() {
     return this.appId;
   }
@@ -192,6 +216,8 @@ public String toString() {
         ", http_proxy_password='" + http_proxy_password + '\'' +
         ", jsapiTicket='" + jsapiTicket + '\'' +
         ", jsapiTicketExpiresTime='" + jsapiTicketExpiresTime + '\'' +
+        ", cardApiTicket='" + cardApiTicket + '\'' +
+        ", cardApiTicketExpiresTime='" + cardApiTicketExpiresTime + '\'' +
         ", tmpDirFile='" + tmpDirFile + '\'' +
         '}';
   }

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

@@ -1,5 +1,6 @@
 package me.chanjar.weixin.mp.api;
 
+import me.chanjar.weixin.common.bean.WxCardApiSignature;
 import me.chanjar.weixin.common.bean.WxMenu;
 import me.chanjar.weixin.common.bean.WxJsapiSignature;
 import me.chanjar.weixin.common.bean.result.WxMediaUploadResult;
@@ -770,12 +771,89 @@ public interface WxMpService {
      * @return
      */
     public boolean checkJSSDKCallbackDataSignature(Map<String, String> kvm, String signature);
-    
+
    /**
     * 发送微信红包给个人用户
     * @param parameters
     * @return
     * @throws WxErrorException
     */
     public WxRedpackResult sendRedpack(Map<String, String> parameters) throws WxErrorException;
+
+  /**
+   * 获得卡券api_ticket，不强制刷新卡券api_ticket
+   * @see #getCardApiTicket(boolean)
+   * @return 卡券api_ticket
+   * @throws WxErrorException
+   */
+  public String getCardApiTicket() throws WxErrorException;
+
+  /**
+   * <pre>
+   * 获得卡券api_ticket
+   * 获得时会检查卡券apiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干
+   *
+   * 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.954-.E5.8D.A1.E5.88.B8.E6.89.A9.E5.B1.95.E5.AD.97.E6.AE.B5.E5.8F.8A.E7.AD.BE.E5.90.8D.E7.94.9F.E6.88.90.E7.AE.97.E6.B3.95
+   * </pre>
+   * @param forceRefresh 强制刷新
+   * @return 卡券api_ticket
+   * @throws WxErrorException
+   */
+  public String getCardApiTicket(boolean forceRefresh) throws WxErrorException;
+
+  /**
+   * <pre>
+   * 创建调用卡券api时所需要的签名
+   *
+   * 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD
+   * .954-.E5.8D.A1.E5.88.B8.E6.89.A9.E5.B1.95.E5.AD.97.E6.AE.B5.E5.8F.8A.E7.AD.BE.E5.90.8D.E7.94
+   * .9F.E6.88.90.E7.AE.97.E6.B3.95
+   * </pre>
+   *
+   * @param optionalSignParam 参与签名的参数数组。
+   *                  可以为下列字段：app_id, card_id, card_type, code, openid, location_id
+   * @return 卡券Api签名对象
+   */
+  public WxCardApiSignature createCardApiSignature(String... optionalSignParam) throws
+      WxErrorException;
+
+  /**
+   * 卡券Code解码
+   * @param encryptCode 加密Code，通过JSSDK的chooseCard接口获得
+   * @return 解密后的Code
+   * @throws WxErrorException
+   */
+  public String decryptCardCode(String encryptCode) throws WxErrorException;
+
+  /**
+   * 卡券Code查询
+   * @param cardId 卡券ID代表一类卡券
+   * @param code 单张卡券的唯一标准
+   * @param checkConsume 是否校验code核销状态，填入true和false时的code异常状态返回数据不同
+   * @return WxMpCardResult对象
+   * @throws WxErrorException
+   */
+  public WxMpCardResult queryCardCode(String cardId, String code, boolean checkConsume)
+    throws WxErrorException;
+    
+   /**
+   * 卡券Code核销。核销失败会抛出异常
+   * @param code 单张卡券的唯一标准
+    * @return
+    * @throws WxErrorException
+    */
+  public void consumeCardCode(String code) throws WxErrorException;
+
+    /**
+     * 卡券Mark接口。
+     * 开发者在帮助消费者核销卡券之前，必须帮助先将此code（卡券串码）与一个openid绑定（即mark住），
+     * 才能进一步调用核销接口，否则报错。
+     * @param code 卡券的code码
+     * @param cardId 卡券的ID
+     * @param openId 用券用户的openid
+     * @param isMark 是否要mark（占用）这个code，填写true或者false，表示占用或解除占用
+     * @throws WxErrorException
+     */
+  public void markCardCode(String code, String cardId, String openId, boolean isMark) throws
+      WxErrorException;
 }