相信技术的力量

Android微信支付流程及返回码-1之坑

之前做微信支付的时候,直接是以库形式引入项目的,虽然一直觉得微信支付的开发文档不太理想,但是印象中也没有遇到什么大坑。

今天项目组的一个小伙伴突然告诉我微信支付一直失败,根本调不起来支付页面,onResp() 中的返回码一直是-1,而且他好像已经搞了好几个小时了。于是我pull了一下项目代码开始排查问题。最终发现问题有两个:

  • 微信开放平台上传的签名问题
  • Manifest文件中WXPayEntryActivity 的配置问题。

由于在处理这两个问题的过程中,顺便又回顾了一遍微信支付的流程,以前也没有真正记录下来过,所以这里记录一下。

这里先把微信支付的返回码贴一下,看看他们是有多么敷衍:

  • 0 成功,展示成功页面
  • -1 错误,可能的原因:签名错误、未注册APPID、项目设置APPID不正确、注册的APPID与设置的不匹配、其他异常等。
  • -2 用户取消,无需处理。发生场景:用户不支付了,点击取消,返回APP。

相信绝大部分同学在处理微信支付这块的时候,遇到的都是返回-1,然而看看关于-1的解释,完全不给力。尤其是一个其他异常,真省事。。。 其实除了appId和签名以外,还有很多其他原因会导致返回-1,这些都被微信划为了其他异常而一笔带过。

整体集成流程可以查看 微信支付App端开发步骤 ,反正他们不会告诉你有坑的,还是要自己踩-_-!

获取AppID

微信开放平台 申请开发应用,获取APP的唯一标识APPID,比较简单。之后通过 管理中心-应用详情 即可查看自己的AppID。

向开放平台提交包名和签名

自己应用的包名就不用说了,比如com.weixin.test

签名的话,要用到 签名工具 ,是微信自己做的一个app,只有17KB,安装在手机上,输入已经安装在手机上的自己应用的包名,即可获取该包名对应的签名数据。

吐槽一下:签名工具做的也太丑陋 + 不友好了,谁用谁知道。

注意

这里获取签名的时候,务必使用release版安装在手机上,然后去获取签名,因为真正最终上线运营的时候是release版。debug和release两个jks不一致,会导致最终签名不一致,这种不一致会导致微信支付调用失败。

如果嫌release签名调试不方便,有两种方法:

  1. 先向开放平台提交debug版签名,等待开发调试完毕,再换成release签名
  2. 向开放平台提交release版签名,在gradle中配置一下,debug版本build时候也使用release的jks即可。

今天项目中遇到的其中一个坑就是在这里,签名错误,完全跟技术无关。这种问题,再debug 3天也发现不了。

调用微信支付

微信支付的逻辑,大部分是有服务器端完成的,客户端只需要在3个节点上进行处理:

1.通知服务器向微信下单

这个服务器就是自己的后台,我们给后台传递必要的参数,比如商品id,价格等,由后台向微信服务器下订单,下单成功后,后台会将订单信息如prepayId等回调给我们。这里就是一个Android客户端-后台服务器 Request和Response的过程。

2.在服务器回调中调用微信支付

在后台向微信服务器下单成功后,会将微信支付中需要使用到的一些字段数据回传给我们,我们拿着该字段去调起微信支付即可。

//首先在调用之前,需要先在代码中进行微信API注册
IWXAPI wxApi= WXAPIFactory.createWXAPI(context, null);
// 将该app注册到微信
wxApi.registerApp("your AppID");

//创建一个支付请求对象
PayReq request = new PayReq();

//开始数据封装,这里一共有7个字段,都是必传的
request.appId = "wxd930ea5d5a258f4f";
request.partnerId = "1900000109";
request.prepayId= "1101000000140415649af9fc314aa427",;
request.packageValue = "Sign=WXPay";
request.nonceStr= "1101000000140429eb40476f8896f4c9";
request.timeStamp= "1398746574";
request.sign= "7FFECB600D7157C5AA49810D2D8F28BC2811827B";
//发起请求
api.sendReq(req);

这里对几个字段进行特殊说明:

  • appId : 直接定义为常量即可
  • packageValue :直接使用"Sign=WXPay",这是一个固定的值。
  • sign:如果服务器端已经做过了签名生成,那么这里直接拿着赋值给PayReq 对象即可;如果服务器端没有做,那么还需要在本地进行签名生成之后,再赋值。

这个本地签名生成其实就是将上面的除了sign 以外的6个字段,拼接成key-value形式的字符串,在进行MD5加密,代码如下:

//开始将6个字段进行数据封装
List<WXModel> list = new LinkedList<>();
list.add(new WXModel("appid", payReq.appId));
list.add(new WXModel("noncestr", payReq.nonceStr));
list.add(new WXModel("package", payReq.packageValue));
list.add(new WXModel("partnerid", payReq.partnerId));
list.add(new WXModel("prepayid", payReq.prepayId));
list.add(new WXModel("timestamp", payReq.timeStamp));
payReq.sign = genAppSign(list);
//...发起请求即可

/**
 * 生成签名
 */
private String genAppSign(List<WXModel> list) {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < list.size(); i++) {
        sb.append(list.get(i).key);
        sb.append('=');
        sb.append(list.get(i).value);
        sb.append('&');
    }
    sb.append("key=");
    sb.append(Constant.WX_APP_KEY);
    String appSign = MD5Utils.getMessageDigest(sb.toString().getBytes()).toUpperCase();
    return appSign;
}

注意

  • 签名工作一般由后台完成,在生成签名时,务必注意key的拼写问题,比如必须拼appid而不是appId,必须拼prepayid而不是prepayId,这里跟上面PayReq 对象中字段的命名方式不一样,用错了也是照样返回-1。自己曾经作为server端忽略了这一点,坑了移动端的同事一把,耽误了好几个小时-_-!
  • 签名所使用的是 微信商户平台API密钥,而不是微信开放平台AppSecret。 API密钥在商户平台后台-->API安全-->先安装操作证书,后设置密钥。见下图:

微信支付密钥.png

3.WXPayEntryActivity中接收回调

在该类的onResp() 方法中拿到微信支付的回调,然后去跟服务器再度确认支付结果。官方解释如下:

在WXPayEntryActivity类中实现onResp函数,支付完成后,微信APP会返回到商户APP并回调onResp函数,开发者需要在该函数中接收通知,判断返回错误码,如果支付成功则去后台查询支付结果再展示用户实际支付结果。注意一定不能以客户端返回作为用户支付的结果,应以服务器端的接收的支付通知或查询API返回的结果为准。

OK,到这里其实并不是就完事了。想正常接到支付成功的回调,除了上面一系列的AppId、应用签名、微信支付请求等流程不能出错外,这个类也得好好配置下才行,否则返回码-1依然在等待着你。。。

类的位置

WXPayEntryActivity 类必须放在 包名.wxapi 下,比如com.weixin.test.wxapi.WXPayEntryActivity ,包名或类名不一致会造成无法回调。

Manifest文件中的声明

WXPayEntryActivity 不是一个普通的类,而是要继承Activity的一个View界面,所以必须在Manifest文件中声明。那么这里坑又来了,如果仅仅只是在Manifest中声明一下,在测试的时候会发现,依然是返回-1。

需要这么配置才可以:

<activity
    android:name=".wxapi.WXPayEntryActivity"
    android:exported="true"
    android:launchMode="singleTop">

    <intent-filter>
        <action android:name="android.intent.action.VIEW"/>
        <category android:name="android.intent.category.DEFAULT"/>
        <data android:scheme="your AppId"/>
    </intent-filter>

 </activity>

清空缓存

最后再说一个坑,如果经过一系列的配置,发现完全都配置好了,可是微信支付依然返回-1。而此时我们可能又会回头排查各个节点的问题,是配置问题?是自己的数据传递问题?到底哪里的bug?

其实这时候,清空下自己的应用缓存就可以了,通过 设置-应用管理-your app-清空缓存,进行缓存清理过后,立竿见影拿到成功的回调!

(完)

⬆️