1. 绑定域名
登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。
2. 引入JS文件
在需要调用JS接口的页面引入如下JS文件:http://res.wx.qq.com/open/js/jweixin-1.6.0.js (支持https)
如需进一步提升服务稳定性,当上述资源不可访问时,可改访问:http://res2.wx.qq.com/open/js/jweixin-1.6.0.js (支持https)
备注:支持使用 AMD/CMD 标准模块加载方法加载。
3. 通过config接口注入权限验证配置并申请所需开放标签
与使用JS-SDK配置方式相同,所有需要使用开放标签的页面必须先注入配置信息,并通过openTagList字段申请所需要的开放标签,否则将无法使用(同一个url仅需调用一次)。开放标签的申请和JS接口的申请相互独立,因此是可以同时申请的。
wx.config({
debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印
appId: '', // 必填,公众号的唯一标识
timestamp: , // 必填,生成签名的时间戳
nonceStr: '', // 必填,生成签名的随机串
signature: '',// 必填,签名
jsApiList: [], // 必填,需要使用的JS接口列表
openTagList: [] // 可选,需要使用的开放标签列表,例如['wx-open-launch-weapp']
});
签名算法见JS-SDK说明文档的附录,所有开放标签列表见文末的附录1。
4. 通过ready接口处理成功验证
wx.ready(function () {
// config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中
});
5. 通过error接口处理失败验证
wx.error(function (res) {
// config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名
});
使用说明
所有开放标签都能像普通的HTML标签一样在页面中直接使用,不需要再进行额外的处理。
如果所使用的标签允许提供插槽,由于插槽中模版的样式是和页面隔离的,因此需要注意在插槽中定义模版的样式。插槽模版及样式均需要通过<template></template>进行包裹。对于Vue等视图框架,为了避免template标签冲突的问题,可使用<script type="text/wxtag-template"></script>进行代替,来包裹插槽模版和样式。另外,对于具名插槽还需要通过slot属性声明插槽名称,下文标签插槽中的default插槽为默认插槽,可不声明插槽名称。
对于标签事件,均可通过event.detail获得详细信息。如果无特殊说明,下文标签事件说明中的返回值均指代event.detail中的内容。
另外,需要注意以下几点:
页面中与布局和定位相关的样式,如position: fixed; top -100;等,尽量不要写在插槽模版的节点中,请声明在标签或其父节点上;
对于有CSP要求的页面,需要添加白名单frame-src https://*.qq.com webcompt:,才能在页面中正常使用开放标签。
以上是官方文档内容。
在vue项目使用如下:
1、main.js注入
Vue.config.ignoredElements = [
'wx-open-launch-weapp',
]
2、使用v-html方法
<div v-html="wxHtml"></div>
3、js方法
export default {
data() {
return {
wxHtml:''
}
},
methods: {
config() {
let myUrl = window.location.href;
this.$axios.get("/api/wx/open/jsdk/config", {
params: {
url: myUrl
}
}).then(data => {
if (data.data) {
wx.config({
debug: false,
appId: data.data.appId,
timestamp: data.data.timeSpan,
nonceStr: data.data.nonceStr,
signature: data.data.sinature,
jsApiList: ['openLocation'],
openTagList: ['wx-open-launch-weapp']
});
this.getHtml()
}
})
},
getHtml() {
let script = document.createElement('script')
script.type = 'text/wxtag-template'
script.text = `<button class="btn blue mt1" style="height: 50px;width: 100px;">跳转小程序</button>`
this.wxHtml =
`<wx-open-launch-weapp style="height: 50px;width: 100px;"
id="launch-btn"
appid="xxxxx"
username="gh_xxxxxxxx"
path="pages/index/index.html"
>${script.outerHTML}
</wx-open-launch-weapp>`
this.$nextTick(() => {
let launchButton = document.getElementById('launch-btn')
launchButton.addEventListener('launch', function(e) {
console.log('success', e)
})
launchButton.addEventListener('error', function(e) {
console.log('fail', e)
})
})
}
},
mounted() {
this.config()
},
}
注意事项 ( 按钮不显示、点击按钮没反应,请对照以下事项逐一排查 )
1、username为小程序原始ID。
2、path为跳转至小程序的路径,一定要加后缀.html。还能携带参数,在微信小程序中通过 onLoad的 options接收。(代码如下)
3、<wx-open-launch-weapp>中必须用<template>标签包裹。
4、config配置中一定要加入openTagList: ['wx-open-launch-weapp']。
5、微信版本要求为:7.0.12及以上。 系统版本要求为:iOS 10.3及以上、Android 5.0及以上。
6、引入js至少是1.6以上版本。
按钮不显示,多半是wx.config配置不正确。