微信jssdk踩坑记录

背景

微信jssdk是微信团队提供的开发工具,利用它可以调用分享接口,自定义转发朋友圈、微信群时的标题、内容、图标、摘要;调用图像接口,在网页中点击按钮上传手机相册的图片;调用语音接口,点击按钮开始录音之类的。可以说是功能非常强大。

准备工作

step1 配置js安全域名

image.png

step2 配置ip白名单

设置——安全中心——ip白名单
因为jssdk的接口调用之前要验证,验证的其中一个步骤就是获取accesstoken,如果没配置ip白名单的话获取accesstoken的接口就会调用失败

step3 准备2个json文件来缓存jsapi_ticket和access_token

调用接口获取jsapi_ticket和access_token次数有限,所以你需要自行新建两个文件,access_token.json和jsapi_ticket.json来缓存jsapi_ticket和access_token。

完成了准备工作,就可以开始撸代码了。

step4 改一改官网的jssdk.php这个示例代码文件

demo下载链接:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115
拉到最底下
下载下来的jssdk.php文件要改一下,改成下面这个样子。

<?php
class JSSDK {
    private $appId;
    private $appSecret;

    public function __construct($appId, $appSecret) {
        $this->appId = $appId;
        $this->appSecret = $appSecret;
    }
    //因为url不能写死,所以我果断地把这里改成函数参数传值了
    public function getSignPackage($url) {
        $jsapiTicket = $this->getJsApiTicket();
        $timestamp = time();
        $nonceStr = $this->createNonceStr();

        // 这里参数的顺序要按照 key 值 ASCII 码升序排序
        $string = "jsapi_ticket=$jsapiTicket&noncestr=$nonceStr&timestamp=$timestamp&url=$url";

        $signature = sha1($string);

        $signPackage = array(
            "appId" => $this->appId,
            "nonceStr" => $nonceStr,
            "timestamp" => $timestamp,
            "url" => $url,
            "signature" => $signature,
            "rawString" => $string
        );
        return $signPackage;
    }

    private function createNonceStr($length = 16) {
        $chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
        $str = "";
        for ($i = 0; $i < $length; $i++) {
            $str .= substr($chars, mt_rand(0, strlen($chars) - 1), 1);
        }
        return $str;
    }

    private function getJsApiTicket() {
        // jsapi_ticket 应该全局存储与更新,以下代码以写入到文件中做示例
        $data = json_decode(file_get_contents("jsapi_ticket.json"));
        if ($data->expire_time < time()) {
            $accessToken = $this->getAccessToken();
            $url = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?type=jsapi&access_token=$accessToken";
            $res = json_decode($this->httpGet($url));
            $ticket = $res->ticket;
            if ($ticket) {
                $data->expire_time = time() + 7000;
                $data->jsapi_ticket = $ticket;
                $fp = fopen("jsapi_ticket.json", "w");
                fwrite($fp, json_encode($data));
                fclose($fp);
            }
        } else {
            $ticket = $data->jsapi_ticket;
        }

        return $ticket;
    }

    private function getAccessToken() {
        // access_token 应该全局存储与更新,以下代码以写入到文件中做示例
        $data = json_decode(file_get_contents("access_token.json"));
        if ($data->expire_time < time()) {
            $url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=$this->appId&secret=$this->appSecret";
            $res = json_decode($this->httpGet($url));
            $access_token = $res->access_token;
            if ($access_token) {
                $data->expire_time = time() + 7000;
                $data->access_token = $access_token;
                $fp = fopen("access_token.json", "w");
                fwrite($fp, json_encode($data));
                fclose($fp);
            }
        } else {
            $access_token = $data->access_token;
        }
        return $access_token;
    }

    private function httpGet($url) {
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_TIMEOUT, 500);
        curl_setopt($curl, CURLOPT_URL, $url);
        $res = curl_exec($curl);
        curl_close($curl);
        return $res;
    }
}

这个php class文件就是用来获取jssdk调用之前完成认证所需的信息的,一共调用了2个接口,然后用得到的accesstoken和jsapiticket来生成signature

1、获取accesstoken的接口

先从缓存文件里面取,过期了从重新调用接口来获取并更新缓存的文件。
判断有没过期:有效时间是7200秒,可以用time()函数获取当前时间戳和当时存下来时的时间戳相减得到差值,与7200比较。

https请求方式: GET
https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
返回示例

{"access_token":"ACCESS_TOKEN","expires_in":7200}

2、用accesstoken来换jsapiticket

先判断有没有过期,没过期从缓存文件里面取,过期了从重新调用接口来获取并更新缓存的文件。
判断有没过期:有效时间是7200秒,可以用time()函数获取当前时间戳和当时存下来时的时间戳相减得到差值,与7200比较。

https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi
https请求方式: GET
返回示例

{
"errcode":0,
"errmsg":"ok",
"ticket":"bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
"expires_in":7200
}

3、生成sianature

参与签名的字段包括noncestr(随机字符串), 有效的jsapi_ticket, timestamp(时间戳), url(当前网页的URL,不包含#及其后面部分),把这些参数按照字段名的ASCII 码从小到大排序(字典序)后,使用URL键值对的格式(即key1=value1&key2=value2…)拼接成字符串string1

$string = "jsapi_ticket=$jsapiTicket&noncestr=$nonceStr&timestamp=$timestamp&url=$url";

然后对拼接得到的字符串进行sha1加密,就可以得到signature了。

$signature = sha1($string);
时间戳用time()函数获取
$timestamp = time();
随机字符串生成

先将大小写字母、数字拼接成一个字符串str,然后在区间【0,我们要的随机字符串长度length-1】生成length个随机数,用substr或者charAt提取str对应索引的字母最后由这些随机生成的字母拼成一个字符串。

    private function createNonceStr($length = 16) {
        $chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
        $str = "";
        for ($i = 0; $i < $length; $i++) {
            $str .= substr($chars, mt_rand(0, strlen($chars) - 1), 1);
        }
        return $str;
    }

step5 引入jssdk文件

<script type="text/javascript" src="http://res.wx.qq.com/open/js/jweixin-1.2.0.js"></script>

step6 准备一个获取认证所需信息的接口

<?php
require_once "./weixin.class.php";
require_once "./config.php";
$jssdk = new JSSDK(APPKEY,APPSECRET);
$signPackage = $jssdk->GetSignPackage($_GET['url']);
echo json_encode($signPackage);
?>

这里的weixin.class.php是那个改过之后的官网jssdk类的那个php文件
confid.php我用来存appid和appsecret了。

step7 在页面的js代码里面加上调用获取配置信息的接口的代码

var url="resource/petestApi.php";
var data={
    url:location.href
}
$.getJSON(url,data,function (res) {
    wx.config({
        debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
        appId: res.appId, // 必填,公众号的唯一标识
        timestamp: res.timestamp, // 必填,生成签名的时间戳
        nonceStr: res.nonceStr, // 必填,生成签名的随机串
        signature: res.signature,// 必填,签名
        jsApiList: ["onMenuShareTimeline","onMenuShareAppMessage"] // 必填,需要使用的JS接口列表
    });
});

这里用location.href把当前页面的url作为get参数传给接口,这样就能实现url动态获取了。

step8 通过ready接口处理成功验证

config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,如果需要在页面一加载完成就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。
也就是说比如如果页面一加载进来,用户就要转发朋友圈,那么你可以这么写

wx.ready(function(){
    wx.onMenuShareTimeline({
        title: '你的转发标题',
        link: '转发链接',
        imgUrl: '转发封面图标url',
        //转发成功后调用的函数
        success: function () {
        //你要执行的操作
        },
        //用户取消转发后调用的函数
        cancel: function () {
        //你要执行的操作
        }
    });
})

而如果不用立即触发,你想让用户点击某个按钮之后再注册转发事件
那么你可以这么写
假设这里有一个id为btn5的按钮,我们想点击这个按钮触发jssdk调用。

 $('#btn5').click(function(){
        wx.onMenuShareTimeline({
        title: '你的转发标题',
        link: '转发链接',
        imgUrl: '转发封面图标url',
        //转发成功后调用的函数
        success: function () {
        //你要执行的操作
        },
        //用户取消转发后调用的函数
        cancel: function () {
        //你要执行的操作
        }
    });
})

常见错误

一、config invalid url domain

这个是你的js安全域名写错了
如果不太懂域名,可以看看这个
https://jingyan.baidu.com/article/2c8c281df0afd00008252aa7.html

二、config invalid signature

你的appsecret错了;
如果你把前后端分开了,$signPackage关联数组里面有一项是url,这一项不是接口文件的url,而是你引入http://res.wx.qq.com/open/js/jweixin-1.2.0.js这个的js文件的html页面的url,那么获取到的signature是错的,就认证失败了。

三、自行写死获取signPackage里的url

看到官网给的jssdk.php的14~16行

    // 注意 URL 一定要动态获取,不能 hardcode.
    $protocol = (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off' || $_SERVER['SERVER_PORT'] == 443) ? "https://" : "http://";
    $url = "$protocol$_SERVER[HTTP_HOST]$_SERVER[REQUEST_URI]";

url要动态获取,不能写死。

总结

1、不要用官网的示例demo的把html、css、js全部写在一个页面上面的做法,那样做出来的页面维护困难,代码臃肿而且加载速度感人。
2、class JSSDK的那个php文件里面

    private function httpGet($url) {
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_TIMEOUT, 500);
        curl_setopt($curl, CURLOPT_URL, $url);

        $res = curl_exec($curl);
        curl_close($curl);

        return $res;
    }

这段代码是可以供我们复用的,以后用来get方法调用接口的时候。
不知道有没有大佬是全部直接用前端做好的呢?有的话分享下源码?

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容