wxutil

wxutil工具使用promise语法封装了微信小程序官方的高频API，以及常用的开发方法。
项目地址: https://github.com/YYJeffrey/wxutil/

快速上手

方法一：在需要使用的位置引入wxutil（下方示例调用代码均以该方法引入）

const wxutil = require("../../utils/wxutil.js")

方法二：通过导入自己所需模块来引入wxutil

import { request } from "../../utils/wxutil.js"

工具模块

• 网络请求
• 文件请求
• socket
• 图片操作
• 交互
  • showToast
  • showModal
  • showLoading
  • showActionSheet
• 缓存
  • setStorage
  • getStorage
• 授权
  • getLocation
  • getUserInfo
  • requestPayment
• 其他工具

网络请求

封装微信小程序wx.request()方法实现四大http请求方法

get

通过直接调用url获取请求

wxutil.request.get(url).then((data) => {
    console.log(data)
})

使用promise异步获取请求数据并捕获请求异常

wxutil.request.get(url, data = {}, header = {}).then((data) => {
    console.log(data)     // 业务处理
}).catch((error) => {
    console.log(error)    // 异常处理
})

post

wxutil.request.post(url, data = {}, header = {}).then((data) => {
    console.log(data)
})

put

wxutil.request.put(url, data = {}, header = {}).then((data) => {
    console.log(data)
})

delete

wxutil.request.delete(url, data = {}, header = {}).then((data) => {
    console.log(data)
})

全局header

注：在app.js中写一个全局的getHeader方法并返回header可以为全局所有请求带上该头部

// app.js
getHeader() {
    const userDetail = wxutil.getStorage("userDetail")
    let header = {}
    if (userDetail) {
        header["Authorization"] = "Token " + userDetail.token
    }
    return header
}

文件请求

封装微信小程序wx.downloadFile()和wx.uploadFile()方法

download

wxutil.file.download({url}).then((data) => {
    console.log(data)
})

upload

wxutil.file.upload({
    url: url,
    fileKey: fileKey,
    filePath: filePath,
    data: {},
    header: {}
}).then((data) => {
    console.log(data)
})

socket

封装微信小程序的websocket部分方法，实现整个socket流程如下

let socketOpen = false  // socket连接标识
wxutil.socket.connect(url)

// 监听socket通信
wx.onSocketMessage((res) => {
    console.log(res)  
})

wx.onSocketOpen((res) => {
    socketOpen = true
    if (socketOpen) {
        // 发送socket消息
        wxutil.socket.send("hello wxutil").then((data) => {
            console.log(data)
        })
    }

    // 关闭socket连接
    wxutil.socket.close(url)
})

图片操作

封装微信小程序的wx.saveImageToPhotosAlbum()、wx.previewImage()、wx.chooseImage()方法，用于保存图片到本机相册、预览图片以及从相机或相册选择图片

save

wxutil.image.save(path).then((data) => {
    console.log(data)
})

preview

wxutil.image.preview(["img/1.png"])

choose

参数：count, sourceType

wxutil.image.choose(1).then((data) => {
    console.log(data)
})

交互

封装微信小程序的wx.showToast()、wx.showModal()、wx.showLoading()和wx.showActionSheet()方法，用于给用户友好提示

showToast

wxutil.showToast("hello")

showModal

wxutil.showModal("提示", "这是一个模态弹窗")

亦可传入参数并在回调函数中处理自己的业务

wxutil.showModal(title: title, content: content, handler = {
    showCancel: showCancel,
    cancelText: cancelText,
    confirmText: confirmText,
    cancelColor: cancelColor,
    confirmColor: confirmColor
}).then((data) => {
    console.log(data)
})

showLoading

wxutil.showLoading("加载中")

showActionSheet

wxutil.showActionSheet(['A', 'B', 'C']).then((data) => {
    console.log(data)
})

缓存

封装微信小程序的wx.setStorageSync()和wx.getStorageSync()方法，同步设置缓存和获取缓存内容，并允许为缓存设置过期时间

setStorage

wxutil.setStorage("userInfo", userInfo)

亦可为缓存设置过期时间，单位：秒

wxutil.setStorage("userInfo", userInfo, 86400)

getStorage

wxutil.getStorage("userInfo")

授权

封装了需要用户授权微信小程序的方法

getLocation

获取用户的地理位置

wxutil.getLocation().then((data) => {
    console.log(data)
})

亦可通过传入可选参数打开微信小程序的地图

wxutil.getLocation("gcj02", true).then((data) => {
    console.log(data)
})

getUserInfo

获取用户信息，可传递两个参数：login和lang，login为true可返回wx.login获取到的code，lang默认为中文，该方法需要使用button触发

wxutil.getUserInfo().then((data) => {
    console.log(data)
})

requestPayment

封装了微信小程序的requestPayment方法，需要传递后端的timeStamp、nonceStr、packageValue、paySign这几个参数，加密方式默认为“MD5”

wxutil.requestPayment({
    timeStamp: timeStamp,
    nonceStr: nonceStr,
    packageValue: packageValue,
    paySign: paySign
}).then((data) => {
    console.log(data)
})

其他工具

封装了常用的微信小程序方法，便于高效开发，也可以增加自己的工具方法在下方

autoUpdate

在app.js中引用该方法，可以在微信小程序发布新版本后自动更新

wxutil.autoUpdate()

isNotNull

判断字符串是否为空、空格回车等，不为空返回true

wxutil.isNotNull("text")

getDateTime

获取当前日期时间，格式：yy-mm-dd hh:MM:ss

const datetime = wxutil.getDateTime()
console.log(datetime)

getTimestamp

获取当前时间戳

const timestamp = wxutil.getTimestamp()
console.log(timestamp)