近期公司项目需要使用到微信卡券模块,主要做的是在小程序打通微信卡券,实现小程序领取卡券的功能效果。
简单说下涉及的东西:
Springboot—使用springboot做后端接口,非常便捷 并且根本是基于SSM
微信公众号—需要认证,并且开通卡券功能。
微信小程序--- 作为项目前端,接受后台接口返回的参数,并调用wx.addcard接口领取卡券。
开发准备:在公众号平台上开通卡券模块,并创建一张卡券,而且要让卡券进入投放的状态,记录下其card_id。
后台函数代码编写参考了网上其它人的程序:
创建一个OpenApi类,这里我把它加一个注解变成控制器
private static String grantType = "client_credential"; public static String appId = "wxc9e5635bb78789db"; //微信公众号appid public static String secret = "1ee5c4ba6aca792196dbcfc73eabeed8"; //微信公众号密钥 public static AccessToken token = null; //微信公众号的accessToken对象,由于请求次数有限制,这里使用全局静态变量保存起来 public static ApiTicket ticket = null;//使用全局静态变量存储ApiTicket对象,当然如果使用缓存框架保存当然更好,这边只是做一个简单示例 //用于下面返回随机字符串的函数 private final static String string = "0123456789"; final private static char[] chars = string.toCharArray();
这里注意 appid跟secret必须是公众号的,不然会有错误。
/** * @param api_ticket: * @param cardId:需要领取的卡券的cardId * @return * @Description: 生成卡券需要的签名并返回参数 */ public static Map<String, String> sign(String api_ticket, String cardId) { Map<String, String> ret = new HashMap<String, String>(); String nonce_str = create_nonce_str(); String timestamp = create_timestamp(); String signature = ""; String param[] = new String[4]; param[0] = nonce_str; param[1] = timestamp; param[2] = api_ticket; param[3] = cardId; Arrays.sort(param);//对参数的value值进行字符串的字典序排序 StringBuilder sb = new StringBuilder(); for (String b : param) { sb.append(b); } System.out.println(sb); //对上面拼接的字符串进行sha1加密,得到signature try { MessageDigest crypt = MessageDigest.getInstance("SHA-1"); crypt.reset(); crypt.update(sb.toString().getBytes("UTF-8")); signature = bytesToHexString(crypt.digest()); } catch (NoSuchAlgorithmException e) { e.printStackTrace(); } catch (UnsupportedEncodingException e) { e.printStackTrace(); } //返回领取卡券需要的参数,其中nonceStr和timestamp必须和签名中的保持一致 ret.put("card_id", cardId); ret.put("api_ticket", api_ticket); ret.put("nonceStr", nonce_str); ret.put("timestamp", timestamp); ret.put("signature", signature); return ret; }
该函数是签名用的函数,注意这里有随机字符串参与签名。
/** * 返回时间戳(秒) * @return */ private static String create_timestamp() { return String.valueOf(new Date().getTime() / 1000); } /** * 返回随机字符串 * @return */ private static String create_nonce_str() { String nonce = new String(); for (int i = 0; i < 10; i++) { int rannum = (int) (Math.random() * 1000) % (chars.length); nonce += chars[rannum]; } return nonce; }
获取token的方式跟微信小程序获取token的方式一样
/** * 获取token * @return * @throws WeixinException * @throws JsonParseException * @throws JsonMappingException * @throws IOException * @throws org.weixin4j.WeixinException */ public static AccessToken getToken() throws WeixinException, JsonParseException, JsonMappingException, IOException, org.weixin4j.WeixinException { if (token == null || token.getExpires_in() < System.currentTimeMillis()) { //拼接参数 String param = "?grant_type=" + grantType + "&appid=" + appId + "&secret=" + secret; //创建请求对象 HttpsClient http = new HttpsClient(); //调用获取access_token接口 Response res = http.get("https://api.weixin.qq.com/cgi-bin/token" + param); System.out.println(res.asString()); ObjectMapper mapper = new ObjectMapper(); token = mapper.readValue(res.asString(), AccessToken.class); } return token; }
/** * Convert byte[] to hex string * @param src byte[] data * @return hex string */ public static String bytesToHexString(byte[] src) { StringBuilder stringBuilder = new StringBuilder(""); if (src == null || src.length <= 0) { return null; } for (int i = 0; i < src.length; i++) { int v = src[i] & 0xFF; String hv = Integer.toHexString(v); if (hv.length() < 2) { stringBuilder.append(0); } stringBuilder.append(hv); } return stringBuilder.toString(); } }
/** * @param cardId:需要领取的卡券的cardId * @return * @throws WeixinException * @throws JsonParseException * @throws JsonMappingException * @throws IOException * @Description: 获取领取卡券获取签名等参数 */ @RequestMapping("getCardSign") @ResponseBody public Map<String, String> getCardSign(String cardId) throws WeixinException, JsonParseException, JsonMappingException, IOException, org.weixin4j.WeixinException { Map<String, String> ret = new HashMap<String, String>(); //先要获取api_ticket,由于请求api_ticket的接口访问有次数限制,所以最好将获得到的api_ticket保存到缓存中,这边做法比较简单,直接使用的静态变量 if (ticket == null || ticket.getExpires_in() < System.currentTimeMillis()) { //创建请求对象 HttpsClient http = new HttpsClient(); ObjectMapper mapper = new ObjectMapper(); AccessToken token = OpenApi.getToken();//这里获取的token就是最上方代码保存的微信公众号全局静态变量token //通过access_token调用获取api_ticket接口 Response res = http.get("https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=" + token.getAccess_token() + "&type=wx_card"); System.out.println(res.asString()); ticket = mapper.readValue(res.asString(), ApiTicket.class); } ret = sign(ticket.getTicket(), cardId);//生成领取卡券需要的签名,并返回相关的参数 for (Map.Entry entry : ret.entrySet()) { System.out.println(entry.getKey() + ", " + entry.getValue()); } return ret; }
@ResponseBody 注解的用处是让这个接口返回的是json数据。也可以在控制器定义的时候 将@Controller 直接写为@RestController。那这里就可以不用加
@ResponseBody注解。
接下来,小程序前端发起网络请求访问这个接口。返回签名所需要的数据
小程序调用wx.addCard函数
wx.addCard({ cardList: [{ cardId: cardId, cardExt: '{"nonce_str":"' + res.data.nonceStr + '","timestamp":"' + res.data.timestamp + '","signature":"' + res.data.signature + '"}' }], success: function (res) { console.log("卡券添加结果",res.cardList) // 卡券添加结果 } }) |
很多人在这里会出现签名错误。我也是纠结了一天 才挑出问题,这里列一下有可能出现签名错误的原因。
- 后端签名的时候,appid跟secret没有用公众号的,而是用小程序的。一般后端出现问题的几率不高,这里可以用微信提供的接口自行验证签名是否
有问题。 签名校验地址: https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=cardsign
- 我的问题主要是出现在前端。cardExtc参数传值有误,或者拼接出错,都会出现签名错误的提示。这里需要注意的是,首先 官方文档中,cardExt有
openid跟code参数,但是实际上没有这两个值的话是不用填在cardExt里面的,比如我是通过公众平台直接创建的卡券,所以没有code和openid这两个参数,那么我上面的传值就干脆不写。
- 其实,我看了网上其它人的参数,有些人有这个nonce_str参数,一开始我是没传这个进入,结果一直显示签名错误,弄了我半天也不知道找不出原因。
后来我才知道,你在后台参与签名用的参数,在前端同样的得再cardExt中传过去,否则就会签名错误!这点希望注意下,确实坑。。但是也只能怪我自己
不够细心。
另外就是cardExt这个参数是要拼接成字符串json形式传值的,请不要直接传一个cardExt对象过去,或者直接构建一个cardExt对象,然后使用
JSON.stringify()函数转化一下,
排除掉签名错误的问题就大功告成了。。