微信JS-SDK是微信公众平台 面向网页开发者提供的基于微信内的网页开发工具包。
通过使用微信JS-SDK,网页开发者可借助微信高效地使用拍照、选图、语音、位置等手机系统的能力,同时可以直接使用微信分享、扫一扫、卡券、支付等微信特有的能力,为微信用户提供更优质的网页体验。

  • 微信js-sdk文档

https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html

JSSDK 使用步骤

1、绑定域名

先登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。

备注:登录后可在“开发者中心”查看对应的接口权限。

2、引入JS文件(npm命令方式)

2.1、使用 npm 命令安装 jweixin-module

在 uni-app 项目的根目录,执行 npm 命令:

npm install jweixin-module --save
2.2、在 vue 文件 引入 jweixin-module
import * as wx from 'jweixin-module';

3、通过config接口注入权限验证配置

所有需要使用JS-SDK的页面必须先注入配置信息,否则将无法调用(同一个url仅需调用一次,对于变化url的SPA的web app可在每次url变化时进行调用,目前Android微信客户端不支持pushState的H5新特性,所以使用pushState来实现web app的页面会导致签名失败,此问题会在Android6.2中修复)。

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

通过ready接口处理成功验证

wx.ready(function(){
  // config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。
});

通过error接口处理失败验证

wx.error(function(res){
  // config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名。
});
// 必须是在用户已经授权的情况下调用
wx.getUserInfo({
  success: function(res) {
    var userInfo = res.userInfo
    var nickName = userInfo.nickName
    var avatarUrl = userInfo.avatarUrl
    var gender = userInfo.gender //性别 0:未知、1:男、2:女
    var province = userInfo.province
    var city = userInfo.city
    var country = userInfo.country
  }
})

4、代码示例

<script>
    import * as wx from "@/js_sdk/jweixin-1.6.0.js";
    export default {
        data() {
            return {

            }
        },
        onLoad() {
            // #ifdef MP-WEIXIN
            wx.config({
              debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
              appId: '', // 必填,公众号的唯一标识
              timestamp: , // 必填,生成签名的时间戳
              nonceStr: '', // 必填,生成签名的随机串
              signature: '',// 必填,签名
              jsApiList: [] // 必填,需要使用的JS接口列表
            });
            wx.ready(function(){
              /* config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,
              config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。
              对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。*/
            });
            wx.error(function(res){
              // config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名。
            });
            // #endif
        },
        methods: {
            scan() {
                let that = this;
                wx.scanQRCode({
                    needResult: 1, // 默认为0,扫描结果由微信处理,1则直接返回扫描结果,
                    scanType: ["qrCode"], // 可以指定扫二维码还是一维码,默认二者都有
                    success: function (res) {
                        var result = res.resultStr; // 当needResult 为 1 时,扫码返回的结果
                        // 逻辑代码
                    }
                });
            }
        }
    }
</script>

参考资料:
https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html
https://blog.csdn.net/guanguan0_0/article/details/84789546
https://blog.csdn.net/qq_30240219/article/details/62420356

作者:Jeebiz  创建时间:2023-02-25 01:29
最后编辑:Jeebiz  更新时间:2023-02-25 01:45