微信JS-SDK分享接口实例开发及本地测试(nodeJS)

目录
| - 1.Node环境搭建
| - 2.JS-SDK使用说明
| - 3.实例开发
  | - 1)获取access_token
  | - 2)获取jsapi_ticket
  | - 3)计算signature
  | - 4)前端调用
  | - 5)配置测试
| - 6)优化请求
| - 4.常见问题
  | - 1)config错误
  | - 2)signature错误
  | - 3)url domain错误
  | - 4)其他错误
| - 5.本地测试,使用内网穿透

1.Node环境搭建

1.1创建项目

mkdir  项目名称

1.2初始化项目

npm init

在项目目录下会生成package.json文件

1.3安装express

npm install express

1.4创建入口文件,在根目录下新建index.js

var express = require("express");
var app = express()
app.get('/',function(req,res){
   res.send('hello world')
})
app.listen(3030, function(){
  console.log("服务启动")
})

1.5 配置启动命令==>在package.json中scripts添加


  "scripts": {
    "dev": "node index.js"
  },

在终端中进入目录执行npm run dev即可启动
在地址栏中输入http://localhost:3030/
在这里插入图片描述
为了避免每次修改需要重启,可以使用自动重启工具nodemon,具体使用方法查看文章nodemon --NODE自动重启工具

执行到这一步,node环境就搭建好了

接下来第二,三,四部分转载自:https://www.jianshu.com/p/1a35e1dbe1ad

2.JS-SDK使用说明

微信JS-SDK说明文档传送门:https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html
阅读前3点即可实现我们想要的分享功能。如下:

  • 绑定域名,配置“JS接口安全域名” (在本地测试没有域名如何测试会在第五部分讲解)
  • 引入js文件
<script src="http://res.wx.qq.com/open/js/jweixin-1.6.0.js"></script>
或
<script src="http://res2.wx.qq.com/open/js/jweixin-1.6.0.js"></script>
  • 通过config接口注入权限验证配置
wx.config({
  debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
  appId: '', // 必填,公众号的唯一标识
  timestamp: , // 必填,生成签名的时间戳
  nonceStr: '', // 必填,生成签名的随机串
  signature: '',// 必填,签名
  jsApiList: [] // 必填,需要使用的JS接口列表
});
其中,最重要的就是signature签名的生成。

 1. 生成"signature"需要"jsapi_ticket"
 2. 生成"jsapi_ticket"需要"access_token"
 3. 还有7200秒过期等规则,组装规则

  • 通过ready接口处理成功验证
wx.ready(function(){
  // config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。
});
  • 通过error接口处理失败验证
wx.error(function(res){
  // config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名。
});

整个流程解释:

  1. 申请公众号,这样就有appID和appSecret(在开发/基本配置分类下)
  2. 引入js文件http://res.wx.qq.com/open/js/jweixin-1.6.0.js,去使用微信JS-SDK
  3. 获取access_token,配置IP白名单才能调此接口根据appID和appSecret进行请求(有效期7200秒,每次使用前检查,过期重新获取)
  4. 获取jsapi_ticket,根据上一步的access_token进行请求(有效期72000秒,每次使用之前检查,过期重新获取
  5. 计算signature,根据上一步的jsapi_ticket
    1)排序,参与签名的字段:noncestr(随机字符串),有效的jsapi_ticket,timestamp(时间戳),URL(不带#后面部分的要分享的url),字典序从小到大排序
    2)拼接,使用URL键值对的格式冰洁字符串string1,参数名必须为小写字符
    3)加密,对string2作sha1加密,字段名和字段值都采用原始值,不进行URL转义
    注:计算签名必须在服务端完成签名,返回前端
  6. 添加JS安全接口域名(在公众号后台的设置/公众号设置/功能设置中添加),这里需要MP_verify_AwmmQFM5B0vHg035.txt文件检查功能
  7. 部署测试,注意事项:80端口,域名已备案。(本地测试
    ,无备案域名,该如何,后续会讲解 )

3.实例开发

官方 DEMO页面和例子传送门:附录6
如果你有可以使用的公众号,那么直接用就好了。如果没有,就需要使用测试公众号。在“公众号后台的开发/开发者工具/公众平台测试帐号”,登陆进入就可以使用测试公众号了
1)获取access_token

// 这里应该判断是否存在签名,是否已过期
//(稍后添加)
// ...
// 公众号字段
var appID = "你的appID";
var appSecret = "你的appSecret";
// 获取access_token
var tokenUrl = 'https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid='+appID+'&secret='+appSecret;
request(tokenUrl, function (error, response, body) {
  if (response.statusCode === 200) {
    body = JSON.parse(body); 
    // 这里我缓存到了global
    global.wxshare.access_token = body.access_token;
    // 获取jsapi_ticket
    // ...
}

2)获取jsapi_ticket

var ticketUrl = 'https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=' + body.access_token + '&type=jsapi';
request(ticket, function (err, response, content) {
  content = JSON.parse(content);
  if (content.errcode == 0) {
    // 这里我缓存到了global
    global.wxshare.jsapi_ticket = content.ticket;
    // 计算signature
    // ...
  }
})

3)计算signature

// 计算signature
// 先拿一个当前时间戳,这里我缓存到了global
global.wxshare.deadline = new Date().getTime();
// 通过调用计算签名方法
var signatureStr = sign(content.ticket, req.body.url);
// 当前时间戳
signatureStr.deadline = new Date().getTime();
// 缓存签名
if (signindex && signindex !== 0) {
  global.wxshare.signs(signindex, 1, signatureStr);
} else {
  global.wxshare.signs.push(signatureStr);
}
// 返回给页面
res.status(200).json(signatureStr);

生成签名

// 随机字符串
var createNonceStr = function () {
  return Math.random().toString(36).substr(2, 15);
};

// 时间戳
var createTimestamp = function () {
  return parseInt(new Date().getTime() / 1000) + '';
};

// 排序拼接
var raw = function (args) {
  var keys = Object.keys(args);
  keys = keys.sort()
  var newArgs = {};
  keys.forEach(function (key) {
    newArgs[key.toLowerCase()] = args[key];
  });
  var string = '';
  for (var k in newArgs) {
    string += '&' + k + '=' + newArgs[k];
  }
  string = string.substr(1);
  return string;
};

/**
* @synopsis 签名算法 
*
* @param jsapi_ticket 用于签名的 jsapi_ticket
* @param url 用于签名的 url ,注意必须动态获取,不能 hardcode
*
* @returns
*/
var sign = function (jsapi_ticket, url) {
  var ret = {
    jsapi_ticket: jsapi_ticket,
    nonceStr: createNonceStr(),
    timestamp: createTimestamp(),
    url: url
  };
  var string = raw(ret);
      jsSHA = require('jssha');
      shaObj = new jsSHA(string, 'TEXT');
  ret.signature = shaObj.getHash('SHA-1', 'HEX');

  return ret;
};
module.exports = sign;

检查页面链接对应的签名是否可用

//检查页面链接对应的签名是否可用
var signtag = false;
var signindex;
// 检查签名
global.wxshare.signs.forEach(function (item, index) {
  if (item.url === req.body.url) {
    signindex = index;
    if (item.deadline && new Date().getTime() - item.deadline < 6000000) {
      signtag = true;
    }
  }
});
//当签名不可用时,检测jsapi_ticket是否可用,来决定是直接请求签名还是先请求jsapi_ticket再请求签名
if (!signtag) {
   // 请求操作
   // 计算签名操作
   // ...
}
// 相应路由
app.post('/signture', Base.wxconfig);
// 对应方法
exports.wxconfig = function(req,res,next) {
   // ...
}

4)前端调用

<script src="http://res.wx.qq.com/open/js/jweixin-1.0.0.js"></script>
<script>
  // 请求签名
  $.ajax({
    url: "/signture",
    type: 'post',
    data: { url: location.href.split('#')[0] },
    success:function(res){
      wx.config({
        debug: false,
        appId: 'wxa2c416de84300ee5',
        timestamp: res.timestamp,
        nonceStr: res.nonceStr,
        signature: res.signature,
        jsApiList: [
          'checkJsApi',
          'onMenuShareTimeline',
          'onMenuShareAppMessage',
          'onMenuShareQQ'
        ]
      }); 
      wx.ready(function () {
        var shareData = {
          title: document.title,
          desc: getDesc(),
          link: res.url,
          imgUrl: getImage()
        };
        wx.onMenuShareAppMessage(shareData);
        wx.onMenuShareTimeline(shareData);
        wx.onMenuShareQQ(shareData);
      });
      wx.error(function (res) {
        alert(res.errMsg);  // 正式环境记得关闭啊!!!!
      });
    }
  });
  // 获取描述字段方法
  function getDesc() {
    var meta = document.getElementsByTagName("meta");
    for (var i=0;i<meta.length;i++){
      if(typeof meta[i].name!="undefined"&&meta[i].name.toLowerCase()=="description"){
        return meta[i].content;
      }
    }
  };
  // 获取图片
  function getImage() {
    return 'http://'+location.host+'/images/logo.png';
  };
</script>

5)配置测试
添加JS接口安全域名(在公众号后台的设置/公众号设置/功能设置中添加),这里需要实现MP_verify_AwmmQFM5B0vHg035.txt文件检查功能。
因为这个MP_verify_AwmmQFM5B0vHg035.txt文件里,只有一行字符串,直接返回即可

// 相应路由
app.get('/MP_verify_CwPkZ2phenWhKlmR.txt', Base.checkWx);

// 对应方法
exports.checkWx = function(req, res) {
  res.send('MP_verify_AwmmQFM5B0vHg035.txt文件中的内容');
}

6)优化请求(检查微信环境,减少不必要的微信接口调用次数)

<script>
  // 检查微信环境
  function isWeiXin() {
    var ua = window.navigator.userAgent.toLowerCase();
    if (ua.match(/MicroMessenger/i) == 'micromessenger') {
      return true;
    } else {
      return false;
    }
  };
  // 如果为真,则请求
  if(isWeiXin()){
      // 去获取signature签名
      ....
  });
</script>

4.常见问题

官方常见错误查阅传送门:附录5
1)config 错误
如果config fail,一般说明存在配置字段遗漏,或者配置字段的值为空(null,undefined, “”)
2)signature错误
如果报invalid signature 错误,一般说明签名没有生成正确,可以使用微信JS接口签名校验工具:https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=jsapisign,对比代码生成出来的是否和校验工具生成的一样。比如时间戳长度,顺序,拼接遗漏。
3)url domain 错误
如果报invalid url domain 错误,说明配置工作已经ok啦,出现这个的原因是域名没有添加到JS安全接口域名下,或者没有使用80、443端口
注:在微信开发者工具中点击地址栏刷新会触发两次请求,可以使用菜单里面的刷新。

5.本地测试,使用内网穿透

使用Sunny-Ngrok实现内网穿透
Sunny-Ngrok使用教程传送门:http://ngrok.cc/_book/start/ngrok_linux.html
1)开通隧道
①先在Sunny-Ngrok注册一个账号以便开通渠道,注册
②注册成功后进行登录
③选择要开通的服务器,有免费的可选择
在这里插入图片描述
⑤开通渠道
在这里插入图片描述

在上图中表单信息解释

隧道名称:可以随便填写,无关紧要只是为了一个备注
前置域名:服务器免费赠送的域名,请不要带上后缀,如果要 sunny.free.idcfengye.com 只需要填写 sunny 即可
本地端口:可以为同一个局域网内任意一台机器进行映射,只需要填对ip和端口就行,例如:192.168.1.1:80
http验证用户名:非必填项,在需要的时候填写,否则可以不填
http验证密码:非必填项,在需要的时候填写,否则可以不填
⑥成功后可以在隧道管理中看到刚刚申请的记录
在这里插入图片描述
2)启动隧道
①根据自己的操作系统去下载对应的 客户端
②启动隧道(隧道id即第⑥步中的隧道id)(以mac为例,window可看官方文档)
启动单个隧道

./sunny clientid 隧道id

启动多个隧道

./sunny clientid 隧道id,隧道id

注:启动隧道,需先在终端下进入第⑦步下载的客户端目录下,比如:我刚刚下载的客户端在/Users/wj/Desktop下,在终端下执行cd /Users/wj/Desktop
启动成功后页面:
在这里插入图片描述
3)添加JS安全域名(在公众号后台的设置/公众号设置/功能设置中)
在这里插入图片描述
4)使用微信开发者工具即可查看微分享是否成功
在这里插入图片描述
以上便是微信JS-SDK分享接口实例开发及本地测试全过程

热门文章

暂无图片
编程学习 ·

C++数据结构第16课、线性表存储结构的抽象实现

课程目标 — 完成顺序存储结构线性表的抽象实现SeqList 设计要点 — 抽象类模板,存储空间的位置和大小由子类完成 — 实现顺序存储结构线性表的关键操作(增、删、查、等) — 提供数组操作符,方便快速获取元素SeqList.h #ifndef SEQLIST_H #define SEQLIST_H#include "…
暂无图片
编程学习 ·

C语言 介绍

一.C的历史 编程语言的发展过程: 第1代语言 机器语言↓ 第2代语言 汇编语言↓ 第3代语言 高级语言——结构化:C,Fortran,Basic,Pascal↓分界线:1980s面向对象(OO):Algo,Simula67,Ada,SmallTalkC++,Java,C#结构化语言的缺陷: 操作和数据是分离的C语言的起源: 1969…
暂无图片
编程学习 ·

leetcode 124. 二叉树中的最大路径和

题目 给定一个非空二叉树,返回其最大路径和。 本题中,路径被定义为一条从树中任意节点出发,达到任意节点的序列。该路径至少包含一个节点,且不一定经过根节点。 思路 简单题,dfs返回当前节点为一端的最大链。答案有两种情况,1 当前节点到子孙的一条链 2 当前节点为中端,…
暂无图片
编程学习 ·

dom基础知识笔记

dom:Document Object Model个人认为dom是一种约定,开发者按这种形式写html,浏览器按这种形式解析html
暂无图片
编程学习 ·

C语言判断大小端

大小端介绍 中央处理器(CPU:CentralProcessingUnit)和微处理器(MCU:MicrocontrollerUnit)中的存储单元都有存储单元,用来存放程序代码中申请的变量(存在栈区),CPU/MCU的最小存储单元是一1个字节(1Byte)即8bit。 C语言中有多种变量类型如:char(8bit)、short(16bit)、…
暂无图片
编程学习 ·

jvm-回收对象(二)

总所周知,Java将程序员从内存管理中解放出来,使得我们在编写代码的时候不用手动的分配和释放内存,内存管理的任务由JVM承担起来。本文就将讲解JVM在回收对象之前,如何判断一个对象是否应该被回收。 在此之前,我们先来复习一个和Java对象回收有关的知识,那便是finalize方法…
暂无图片
编程学习 ·

从零开始学Python:第七课-关于分支和循环结构的应用

通过上两节课的学习,大家对Python中的分支和循环结构已经有了感性的认识。分支和循环结构的重要性不言而喻,它是构造程序逻辑的基础,对于初学者来说也是相对困难的部分。大部分初学者在学习了分支和循环结构后都能理解它们的用途和用法,但是遇到实际问题的时候又无法下手;…
暂无图片
编程学习 ·

idea+maven配置log4j详解

实现log4j打印日志依赖的jar包共3个,在pom.xml中加入相关依赖: <!-- 添加log4j日志相关jar包:共3个jar--><!-- https://mvnrepository.com/artifact/log4j/log4j --><dependency><groupId>log4j</groupId><artifactId>log4j</artifac…
暂无图片
编程学习 ·

quartus ii 使用modelsim altera进行仿真

第一种:先随便写一个程序,有输入,有时钟,有输出再点击processing-->start-->start test bench template writer然后就会在modlsim的文件中生成一个.vt的文件 然后打开这个文件接下来就是再initial和always里面添加信号保存,再点击首先看仿真软件是不是modelsin-altera,再…
暂无图片
编程学习 ·

C语言复习笔记

C语言复习笔记 仅记录复习过程中的混淆和记忆模糊的知识点。 1、常量-八进制整数 在C语言中,如果一个整数是以 0 开头的,那么这个数是以八进制来表示的,即八进制整数。0x为十六进制整数。 2、 一个整数,例如1500,为 int 类型(21亿),如果是 1500L,则表示长整型,1500U …
暂无图片
编程学习 ·

Java ssm框架搭建实现登录

Java ssm框架搭建实现登录 准备工作 1、创建数据库 2、创建数据表 3、导入包4、创建相应的包和文件#UserDao和UserService为接口文件 编写各个文件 User public class User {private int id;private String name;private String password;public int getId() {return id;}publi…
暂无图片
编程学习 ·

登录小Demo(错题记录)

Demo描述:实现C3P0数据库池连接数据库。部署Tomcat服务器,使用servlet完成简单登录测试。错误描述:测试时,登录账号名和密码与数据库表中信息一致。但是提示登录失败,控制台无错误提示。产生原因:细节问题。忽略了setCharacterEncoding设置字符的编码方式.注意点:1.setC…
暂无图片
编程学习 ·

【源码阅读技巧一】查看类关系图,接口实现关系图(idea版本)Diagrams关系图

我们在阅读源码的时候,往往需要理清楚各个类,各个接口之间的关系,然后再去理解他的设计思路,有个大概理解,然后去阅读源码,就容易很多,那么今天就来讲一下如何使用idea来查看关系图: 一、查看类的父类,以及实现的接口 1、打开想要查看的类,通过idea的定位找到类所在位…
暂无图片
编程学习 ·

WinForm 设置透明度

1、窗体透明度 opacity属性,0%完全透明 2、控件透明度 2.1、完全透明 BackColor = Transparent 2.2、不完全透明 在“完全透明”的基础上,设置BackgroundImage为一张带有百分比透明度的图片。通过图片的透明度,来间接设置图片的透明度 2.3、控件叠加时,lable等控件范围内显…
暂无图片
编程学习 ·

Vue 一些常见的面试问题

一、Vue的生命周期beforeCreate(创建前) 在数据观测和初始化事件还未开始 created(创建后) 完成数据观测,属性和方法的运算,初始化事件,$el属性还没有显示出来 beforeMount(载入前) 在挂载开始之前被调用,相关的render函数首次被调用。实例已完成以下的配置:编译模…
暂无图片
编程学习 ·

CAN协议要点及车辆CAN协议破解

一、CAN协议要点1. 电压2. 波形3. CAN报文概述CAN一共规定了5中类型的帧,帧也称为报文。CAN总线的数据帧有标准格式(Standard Format)和扩展格式(Extended Format)的区分。4. CAN报文编码格式Intel格式编码当一个信号的数据长度不超过1 Byte,并且信号在一个字节内实现时,…