@yyjeffrey/wxutil
v1.2.0
Published
WeChat Mini-Program High-frequency API toolkit - 一款使用 promise 封装的小程序高频 API 工具库，已兼容 uni-app
Downloads
8
Readme
wxutil
一款使用 promise 封装的小程序高频 API 工具库，已兼容 uni-app
快速上手
步骤一：使用命令 npm i @yyjeffrey/wxutil 安装 wxutil，或直接下载引入 wxutil.js 文件
步骤二：在使用处引入 wxutil。
// 引入wxutil模块
import wxutil from './miniprogram_npm/@yyjeffrey/wxutil/index'工具模块
网络请求
封装了微信小程序 wx.request() 实现 http 请求
get
直接调用 url 请求数据
wxutil.request.get(url).then(res => {
console.log(res)
})调用 url 并填写参数请求数据
wxutil.request
.get(url, (data = {}), (header = {}))
.then(res => {
// 业务处理
console.log(res)
})
.catch(error => {
// 异常处理
console.log(error)
})post
wxutil.request.post(url, (data = {}), (header = {})).then(res => {
console.log(res)
})put
wxutil.request.put(url, (data = {}), (header = {})).then(res => {
console.log(res)
})delete
wxutil.request.delete(url, (data = {}), (header = {})).then(res => {
console.log(res)
})全局 header
注：可以在 app.js 编写 getHeader() 函数并返回 header 对象，可以实现全局请求头功能
// app.js
// 全局请求带上Token令牌的示例代码
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(res => {
console.log(res)
})upload
wxutil.file
.upload({
url: url,
fileKey: fileKey,
filePath: filePath,
data: {},
header: {}
})
.then(res => {
console.log(res)
})socket
封装微信小程序的 websocket 部分方法，实现 socket 流程如下
// socket连接标识
let socketOpen = false
wxutil.socket.connect(url)
// 监听socket通信
wx.onSocketMessage(res => {
console.log(res)
})
wx.onSocketOpen(() => {
socketOpen = true
if (socketOpen) {
// 发送socket消息
wxutil.socket.send('hello wxutil').then(res => {
console.log(res)
})
}
// 关闭socket连接
wxutil.socket.close(url)
})图片操作
封装微信小程序的 wx.saveImageToPhotosAlbum()、wx.previewImage()、wx.chooseImage()，用于保存图片到本机相册、预览图片以及从相机或相册选择图片
save
wxutil.image.save(path).then(res => {
console.log(res)
})preview
wxutil.image.preview(['imageUrl'])choose
参数：count, sourceType
wxutil.image.choose(1).then(res => {
console.log(res)
})交互
封装微信小程序的 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(res => {
console.log(res)
})showLoading
wxutil.showLoading('加载中')showActionSheet
wxutil.showActionSheet(['A', 'B', 'C']).then(res => {
console.log(res)
})缓存
封装微信小程序的 wx.setStorageSync() 和 wx.getStorageSync()，同步设置缓存和获取缓存内容，并实现设置过期时间功能
setStorage
wxutil.setStorage('userInfo', userInfo)为缓存设置过期时间，单位：秒
wxutil.setStorage('userInfo', userInfo, 86400)getStorage
wxutil.getStorage('userInfo')授权
封装了需要用户授权微信小程序的方法
getLocation
封装了微信小程序的 getLocation()，获取用户的地理坐标
wxutil.getLocation().then(res => {
console.log(res)
})getUserProfile
封装了微信小程序的 getUserProfile()，获取用户公开信息，包括头像、昵称等
wxutil.getUserProfile().then(res => {
console.log(res)
})requestPayment
封装了微信小程序的 requestPayment()，需要传递后端的 timeStamp、nonceStr、packageValue、paySign 参数，加密方式默认为 MD5
wxutil
.requestPayment({
timeStamp: timeStamp,
nonceStr: nonceStr,
packageValue: packageValue,
paySign: paySign
})
.then(res => {
console.log(res)
})其他工具
封装了常用的微信小程序方法，便于高效开发
autoUpdate
在 app.js 中引用该方法，可在微信小程序发布新版本后提醒用户自动更新
wxutil.autoUpdate()isNotNull
判断是否为非空字符串
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)calculate
精度计算
wxutil.calculate.add(0.1, 0.2)
wxutil.calculate.sub(1, 0.8)
wxutil.calculate.mul(6, 0.7)
wxutil.calculate.div(1.2, 0.2)getUUID
获取 UUID
const uuid = wxutil.getUUID()
console.log(uuid)