微信官方文档地址:点击进入
注意事项
- 已在微信安全域名配置
- 使用微信版本要求为:7.0.12及以上。 系统版本要求为:iOS 10.3及以上、Android 5.0及以上。
- 页面中与布局和定位相关的样式,如position: fixed; top -100;等,尽量不要写在插槽模版的节点中,请声明在标签或其父节点上。
- 对于有CSP要求的页面,需要添加白名单frame-src https://*.qq.com webcompt:,才能在页面中正常使用开放标签。
使用步骤
- 绑定微信域名
- 引入JS文件
- 在需要调用JS接口的页面引入如下JS文件:res.wx.qq.com/open/js/jwe… (支持https)
- 如需进一步提升服务稳定性,当上述资源不可访问时,可改访问:res2.wx.qq.com/open/js/jwe… (支持https) ps:支持使用 AMD/CMD 标准模块加载方法加载。
- 通过config配置权限以及开放标签
wx.config({
debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印
appId: '', // 必填,公众号的唯一标识
timestamp: , // 必填,生成签名的时间戳
nonceStr: '', // 必填,生成签名的随机串
signature: '',// 必填,签名
jsApiList: [], // 必填,需要使用的JS接口列表
openTagList: [] // 可选,需要使用的开放标签列表,例如['wx-open-launch-app']
});
附带JSAPI接口详细说明:附件
openList接口:<wx-open-launch-weapp>
打开小程序 <wx-open-launch-app>
打开APP
4. onReady处理成功回调
5. onError处理失败回调
用例
HTML
<div style="height: 50px;width: 100px;position: fixed; z-index: 999;">
<wx-open-launch-weapp style="width:100%; display:block;" id="launch-btn" username="gh_原始ID"
path="pages/打开的路径.html">
<template>
<style>
.btn {
padding: 12px
}
</style>
<button class="btn">打开小程序</button>
</template>
</wx-open-launch-weapp>
</div>
JS部分
function setWxconfig(res) {
wx.config({
debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印
appId: res.appId, // 必填,公众号的唯一标识
timestamp: res.timestamp, // 必填,生成签名的时间戳
nonceStr: res.nonceStr, // 必填,生成签名的随机串
signature: res.signature,// 必填,签名
jsApiList: ['onMenuShareTimeline'], // 必填,需要使用的JS接口列表
openTagList: ['wx-open-launch-weapp'] // 可选,需要使用的开放标签列表,例如['wx-open-launch-app']
});
wx.ready(function () {
console.log('微信配置注入成功')
var btn = document.getElementById('launch-btn');
btn.addEventListener('launch', function (e) {
console.log('success');
});
btn.addEventListener('error', function (e) {
console.log('fail', e.detail);
});
// config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中
});
wx.error(function (res) {
console.log(res, '失败')
// config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名
});
}
预览图
遇到问题
- 页面没有显示打开小程序的按钮? 配置需要jsApiList和openTagList都需要配置,尝试让他们至少都有一个参数。
- 配置一直失败? 检查域名是否都正确配置
- 微信开发者工具看不到? 使用真机调试。
- 无法跳转? 检查小程序原始ID和跳转路径是否正确,原始ID不是APPID,跳转路径后需要加上.html
可能遇到的坑
- 时间戳毫秒/秒不匹配导致的授权失败
- 域名不正确导致的配置失败
- 路径不对导致的跳转到白屏
- 微信版本过低导致无法生效