nov-wechat v0.2.7
nov-wechat
Lenovo service wechat jssdk.
Build Setup
项目基于rollup 进行打包，具体请参考：
# install dependencies
npm install
# serve with hot reload at localhost:80
npm run dev
# build for production with minification
npm run buildpackage entry
为了方便IDE对包的解析，也为了减少打包工具（如webpack）在引入、打包过程中产生的冗余代码，我们在package.json 里定义了多个入口。
这里是参考文档：https://github.com/rollup/rollup/wiki/pkg.module
{
"main": "lib/index.cjs.js",
"module": "lib/index.es.js"
}How to use
Install
方式1：npm install
npm install nov-wechat 0.2.6 注意：由于微信JSSDK 更新和废弃了部分接口，组件内部将抹平这部分差异。
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115
import {initWechatShare, getUserInfo, getOpenid} from 'nov-wechat'
initWechatShare({
title: '嘿，这里是标题',
desc: '狗年吉祥！',
link: 'vs.lenovo.com.cn',
success: function() {
console.log('用户确认分享后执行的回调函数')
},
cancel: function() {
console.log('用户取消分享后执行的回调函数')
}
})
// ....
let openid = getOpenid()
if (openid) {
// do something ...
}
let userInfoStr = getUserInfo()
if(userInfoStr) {
let userInfo = JSON.parse(userInfoStr)
console.log('nickname is:' + userInfo.nickname)
// do something ...
}
// 针对SPA 项目
let hash = sessionStorage.getItem('nov-url-hash')
if (hash) {
// 以Vue router 举栗子 push `/user/222`
this.$router.push(hash.substr(1))
sessionStorage.removeItem('nov-url-hash')
}方式2：script 引入
<script src="https://unpkg.com/nov-wechat@latest/lib/nov.min.js"></script>
<script>
nov.initWechatShare({
title: '分享的题目'
})
var openid = nov.getOpenid()
if (openid) {
// do something ...
}
var userInfoStr = nov.getUserInfo()
if(userInfoStr) {
var userInfo = JSON.parse(userInfoStr)
console.log('nickname is:' + userInfo.nickname)
// do something ...
}
</script>API
initWechatShare initWechatJSSDK 均做了Promise 处理，除了必要的请求，无需担心重复加载微信SDK脚本问题。
initWechatShare
Promise<Object wx> initWechatShare function (options)- options 参数内容
- title 标题
- imgUrl 分享图片（旧版参数：image）
- desc 分享描述（旧版参数：description）
- link 分享链接
- type 分享类型,music、video或link，不填默认为link
- dataUrl 如果type是music或video，则要提供数据链接，默认为空
- success 分享成功回调
- cancel 取消分享回调
- jsApiList 额外的权限（可选）
设置微信分享，为方便使用做的封装，仅注册了微信JSSDK的updateTimelineShareData updateAppMessageShareData （微信JSSDK 1.4.0 更新内容）两个权限。
如果需要更多能力，请使用initWechatJSSDK 得到wx 对象后自行处理。
同一个url仅需调用一次，对于变化url的SPA的web app可在每次url变化时进行调用。
initWechatShare({
title: '嘿，这里是标题',
desc: '狗年吉祥！',
link: 'vs.lenovo.com.cn',
success: function() {
console.log('用户确认分享后执行的回调函数')
},
cancel: function() {
console.log('用户取消分享后执行的回调函数')
}
})initWechatJSSDK
Promise<Object wx> initWechatJSSDK function({jsApiList = config.jsApiList, debugFlag = false})设置指定的微信 JSSDK 权限，将在updateTimelineShareData updateAppMessageShareData 之上追加，Promise resolve 时，相当于wx.ready。
同一个url仅需调用一次，对于变化url的SPA的web app可在每次url变化时进行调用。 更多信息请参考微信JSSDK文档：https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115
initWechatJSSDK({
jsApiList: ['chooseImage']
}).then(wx => {
wx.chooseImage({
// do something ...
});
}).catch(function(error) {
// handle error ...
})getOpenid
String getOpenid function()如果是在微信环境下，静默授权，分别从URL里or cookie 里尝试获取openid。
需要注意的是，用户首次Auth 会发生页面跳转，此刻返回值可能为null，需要在代码里判断返回值的可用性。
在跳离页面前，会将location.hash 存入 SessionStorage，key 等于 nov-url-hash
getUserInfo
String getUserInfo function()非静默授权，用于获取用户基本信息（即便是未关注的用户）。
需要注意的是，用户首次Auth 会发生页面跳转，此刻返回值可能为null，需要在代码里判断返回值的可用性。
在跳离页面前，会将location.hash 存入 SessionStorage，key 等于 nov-url-hash
响应数据如下：
{
"city": "朝阳",
"province": "北京",
"sex": 1,
"openid": "oLHCTjvtz056e3h8Qj-xxxxxx",
"privilege": [],
"country": "中国",
"unionid": "oo6-IuNNZNK148L3TL9xxxxxxx",
"headimgurl": "http://wx.qlogo.cn/mmopen/vi_32/xxxx/132",
"nickname": "xxxx",
"language": "zh_CN"
}setDmp
Void setDmp function(Boolean dmpStatus)让网关在Auth 认证过程中增加dmp 需要的cookie，在调用getOpenid getUserInfo 之前使用。
其他需要注意的地方
- 如果项目页面被iframe 引用，获取openid 时会导致页面白屏
- 网关不支持带hash 的跳转，SPA下需要做处理，避免前端路由失效
- 目前网关只支持*.lenovo.com.cn 需要检测并给提示
- 已经添加针对iOS 下页面未加载完全时的跳转，会造成iconfont 失效的处理
在线测试
由于需要工作在lenovo.com.cn 域名下，请配置host
# example
115.28.154.221 ayouvi.lenovo.com.cn配置后访问进行测试：
http://ayouvi.lenovo.com.cn/dev-pages/nov-wechat-example.html