6.1 网络API
6.1.1 发起网络请求
表6-1 wx.request(object) 相关参数
通过wx.request(Object) 获取百度(https://www.baidu.com)首页的数据
示例代码:
//baidu.wxml
<button type="primary"bindtap="getbaidutap">获取HTML数据</button>
<textarea value='{{html}}'auto-heightmaxlength='0'> </textarea>
//baidu.js
Page({
data:{
html:""
},
getbaidutap:function(){
var that=this;
wx.request({
url:'https://www.baidu.com',//百度网址
data:{},//发送数据为空
header:{'Content-Type':'application/json'},
success:function(res){
console.log(res);
that.setData({
html:res.data
})
}
})
}
})
运行效果:
通过wx.request(Object) 的GET方法获取邮政编码对应的地址信息
示例代码:
//postcode.wxml
<view>邮政编码:</view>
<input type="text"bindinput="input"placeholder='6位邮政编码'/>
<button type="primary"bindtap="find">查询</button>
<block wx:for="{{address}}">
<block wx:for="{{item}}">
<text>{{item}}</text>
</block>
</block>
//postcode.js
Page({
data:{
postcode:",//查询的邮政编码"
,address:[],//邮政编码对应的地址
errMsg:",//错误信息"
,error_code:-1//错误码
},
input:function(e){ //输入事件
this.setData({
postcode:e.detail.value,
})
console.log(e.detail.value)
},
find:function(){ //查询事件
var postcode=this.data.postcode;
if(postcode! =null&& postcode! ="") {
var self=this;
//显示toast提示消息
wx.showToast({
title:'正在查询,请稍候.....',
icon:'loading',
duration:10000
});
wx.request({
url:'https://v.juhe.cn/postcode/query',//第三方后台服务器
data:{
'postcode':postcode,
'key':'off9bfcccdf147476e067de994eb5496e'//第三方提供
},
header:{
'Content-Type':'application/json',
},
method:'GET',//方法为GET
success:function(res){
wx.hideToast();//隐藏toast
if(res.data.error_code==0){
console.log(res);
self.setData({
errMsg:","
,error_code:res.data.error_code,//错误代码
address:res.data.result.list//获取到的数据
})
}
else{
self.setData({
errMsg:res.data.reason ||res.data.reason,//错误原因分析
error_code:res.data.error_code
})
}
}
})
}
}
})
6.1.2 上传文件
wx.upladFile(Object)接口用于将本地资源上传到开发者服务器,并在客户端发起一个HTTPS POST请求
表6-2 wx.uploadFile(Object) 相关参数
通过wx.upladFile(Object),可以将图片上传到服务器并显示
6.1.3 下载文件
表6-3 wx.downloadFile(Object) 相关参数
通过wx.downloadFile(Object)实现从服务器中下载图片,后台服务采用WAMP软件在本机搭建
6.2 多媒体API
6.2.1 图片API
wx.chooseImage(Object) 接口 用于从本地相册选择图片或使用相机拍照
wx.previewImage(Object) 接口 用于预览图片
wx.getImageInfo(Object) 接口 用于获取图片信息
wx.saveImageToPhotosAIbum(Object) 接口 用于保存图片到系统相册
1.选择图片或拍照
表6-4 wx.chooseImage(Object)相关参数
若调用成功,则返回tempFilePaths 和tempFile,tempFilePaths表示图片在本地临时文件路径列表,tempFile表示图片的本地文件列表
示例代码:
wx.chooseImage({
count:2,//默认值为9
sizeType:['original','compressed'],//可以指定是原图还是压缩图,默认二者都有
sourceType:['album','camera'],//可以指定来源是相册还是相机,默认二者都有
success:function(res){
//返回选定照片的本地文件路径列表,tempFilePath 可以作为img标签的src属性来显示图片
var tempFilePaths=res.tempFilePaths
var tempFiles=res.tempFilePaths;
console.log(tempFilePaths)
console.log(tempFiles)
}
})
2.预览图片
表6-5 wx.previewImage(Object) 相关参数
示例代码:
wx.previewImage({
//定义显示第二张
current:"http://bmob-cdn-16488.b0.upaiyun.com/2018/02/05/2.png",
urls: ["http://bmob-cdn-16488.b0.upaiyun.com/2018/02/05/1.png"],
"http://bmob-cdn-16488.b0.upaiyun.com/2018/02/05/2.png",
"http://bmob-cdn-16488.b0.upaiyun.com/2018/02/05/3.jpg",
]
})
3.获取图片信息
表6-6 wx .getImageInfo(Object)相关参数
示例代码:
wx.chooseImage({
success:function(res){
wx.getImageInfo({
src: res.tempFilePaths[0],
success:function(e){
console.log(e.width)
console.log(e.height)
}
})
},
})
4.保存图片到系统相册
表6-7 wx.saveImageTophotsAIbum(Object)相关参数
示例代码:
wx.chooseImage({
success:function(res){
wx.saveImageToPhotosAlbum({
filePath: res.tempFilePaths[0],
success:function(e){
console.log(e)
}
})
},
})
6.2.2 录音API
wx.startRecord(Object) 接口 用于实现开始录音
wx.stopRecord(Object) 接口 用于实现主动调用停止录音
1.开始录音
表6-8 wx.startRecord(Object)相关参数
2.停止录音
示例代码:
wx.startRecord)
({
success:function(res){
var tempFilePath=res.tempFilePath
},
fail:function(res){
//录音失败
}
})
setTimeout(function){
//结束录音
wx.stopRecord()
},10000)
6.2.3 音频播放控制API
wx.playVoice(Objece) 接口 用于实现开始播放语音
wx.pauseVoice(Objece) 接口 用于实现暂停正在播放的语音
wx.stopVoice(Objece) 接口 用于结束播放语音
1.播放语音
表6-9 wx.playVoice(Object) 相关参数
示例代码:
wx.startRecord({
success:function(res){
var tempFilePath=res.tempFilePath
wx.playVoice({ //录音完后立即播放
filePath: tempFilePath,
complete:function(){
}
})
}
})
2.暂停播放
wx.startRecord({
success:function(res){
var tempFilePath=res.tempFilePath
wx.playVoice({
filePath: tempFilePath
})
setTimeout(function(){
//暂停播放
wx.pauseVoice()
},5000)
}
})
3.结束播放
示例代码:
wx.startRecord({
success:function(res){
var tempFilePath=res.tempFilePath
wx.playVoice({
filePath: tempFilePath
})
setTimeout(function(){
wx.stopVoice()
},5000)
}
})
6.2.4 音乐播放控制API
wx.playBackgroundAudio(Object) 接口 用于播放音乐
wx.getBackgroundAudioPlayerState(Object) 接口 用于获取音乐播放状态
wx.seekBackgroundAudio(Object) 接口 用于定位音乐播放进度
wx.pauseBackgroundAudio(Object) 接口 用于实现暂停播放音乐
wx.stopBackgroundAudio(Object) 接口 用于实现停止播放音乐
wx.onBackgroundAudioPlay(Object) 接口 用于实现监听音乐播放
wx.onBackgroundAudioPause(Object) 接口 用于实现监听音乐暂停
wx.onBackgroundAudioStop(Object) 接口 用于实现监听音乐停止
表6-10 wx.playBackgroundAudio(Object) 相关参数
1.播放音乐
示例代码:
wx.playBackgroundAudio({
dataUrl: 'http://bmob-cdn-16488.b0.upaiyun.com/2018/02/09/117e4alb405195b18061299e2de89597.mp3',
title:'有一天',
coverImgUrl:'http://bmob-cdn-16488.b0.upaiyun.com/2018/02/09/f604297140c9681990cc3d3e581f7724.jpg',
success:function(res){
console.log(res)//成功返回playBackgroundAudio:ok
}
})
2.获取音乐播放状态
表6-11 wx.getBackgroundAudioPlayerState(Object) 相关参数
表6-12 wx.getBackgroundAudioplayerState(Object) 成功返回相关参数
示例代码:
wx.getBackgroundAudioPlayerState({
success:function(res){
var status=res.status
var dataUrl=res.dataUrl
var currentPosition=res.currentPosition
var downloadPercent=res.downloadPercent
console.log("播放状态:"+status)
console.log("音乐文件地址:"+dataUrl)
console.log("音乐文件当前播放位置:"+currentPosition)
console.log("音乐文件的长度:"+duration)
console.log("音乐文件的下载进度:"+status)
}
})
3.控制音乐播放进度
表6-13 wx.seekBackgroundAudio(Object) 相关参数
示例代码:
wx.seekBackgroundAudio({
position: 30,
})
4.暂停播放音乐
示例代码:
wx.pauseBackgroundAudio{
dataUrl:'/music/a.mp3',
title:'我的音乐',
coverImgUrl:'/images/poster.jpg',
success:function(){
console.log('开始播放音乐了');
}
});
setTimeout(function(){
console.log('暂停播放');
wx.pauseBackgroundAudio();
},5000);//5秒后自动暂停
5.停止播放音乐
示例代码:
wx.playBackgroundAudio{
dataUrl:'/music/a.mp3',
title:'我的音乐',
coverImgUrl:'/images/poster.jpg',
success:function(){
console.log('开始播放音乐了');
}
});
setTimeout(function(){
console.log('暂停播放');
wx.stopBackgroundAudio();
},5000);//5秒后自动停止
6.监听音乐播放
示例代码:
wx.playBackgroundAudio({
dataUrl: this.data.musicData.dataUrl,
title:this.data.musicData.title,
coverImgUrl:this.data.musicData.coverImgUrl,
success:function(){
wx.onBackgroundAudioStop(function(){
that.setData({
isPlayingMusic:false
})
})
7.监听音乐暂停
wx.onBackgroundAudioPause(CallBack)接口用于实现监听音乐暂停
8.监听音乐停止
wx.onBackgroundAudioStop(CallBack)接口用于实现监听音乐停止
9.案例展示
wxml:
6.3 文件API
wx.saveFile(Object)接口 用于保存文件到本地
wx.getSavedFileList(Object) 接口 用于获取本地已保存的文件列表
wx.getSaveFileInfo(Object) 接口 用于获取本地文件的文件信息
wx.removeSaveFile(Object) 接口 用于删除本地存储的文件
wx.openDocument(Object) 接口 用于新开页面打开文档,支持格式:doc、xls、ppt、pdf、docx、xlsx、ppts
1.保存文件
表6-14 wx.saveFile(Object) 相关参数
示例代码:
saveImg:function(){
wx.chooseImage({
count:1,//默认值为9
sizeType:['original','compressed'],//可以指定是原图还是压缩图,默认二者都有
sourceType:['album','camera'],//可以指定来源是相册还是相机,默认二者都有
success:function(res){
var tempFilePaths=res.tempFilePaths[0]
wx.saveFile({
tempFilePath:tempFilePaths,
success:function(res){
var saveFilePath=res.savedFilePath;
console.log(saveFilePath)
}
})
}
})
}
2.获取本地文件列表
表6-15 wx.getSavedFilelist(Object) 相关参数
示例代码:
wx.getSavedFileList({
success:function(res){
that.setData({
fileList:res,fileList
})
}
})
3.获取本地文件的文件信息
表6-16 wx.getSaveFileInfo(Object)相关参数
示例代码:
wx.chooseImage({
count:1,//默认值为9
sizeType:['original','compressed'],//可以指定是原图还是压缩图,默认二者都有
sourceType:['album','camera'],//可以指定来源是相册还是相机,默认二者都有
success:function(res){
var tempFilePaths=res.tempFilePaths[0]
wx.saveFile({
tempFilePath:tempFilePaths,
success:function(res){
var saveFilePath=res.savedFilePath;
wx.getSavedFileInfo({
filePath:saveFilePath,
success:function(res){
console.log(res.size)
}
})
}
})
}
})
4.删除本地文件
表6-17 wx.removeSaveFile(Object) 相关参数
示例代码:
wx.getSavedFileList({
success:function(res){
if(res.fileList.length>0){
wx.removeSavedFile({
filePath:res.fileList[0].filePath,
complete:function(res){
console.log(res)
}
})
}
}
})
5.打开文档
表6-18 wx.openDocument() 相关参数
示例代码:
wx.downloadFile({
url: 'http://localhost/fm2.pdf', //在本地通过wxamp搭建服务器
success:function(res){
var tempFilePath=res.tempFilePath;
wx.openDocument({
filePath: tempFilePath,
success:function(res){
console.log("打开成功")
}
})
}
})
6.4 本地数据及缓存 API
小程序提供了以键值对的形式进行本地数据缓存功能,并且是永久存储的,但最大不超过10MB,其目的是提高加载速度。数据缓存的接口主要有4个:
wx. setStorage(Object)或wx.setStorageSync(key,data)接口用于设置缓存数据。
wx. getStorage(Object)或wx.getStorageSync(key)接口用于获取缓存数据。
数据。
wx. removeStorage(Object)或 wx.removeStorageSync(key)接口用于删除指定缓存数据。
wx.clearStorage()或wx.clearStorageSync()接口用于清除缓存数据。
其中,带Sync后缀的为同步接口,不带Sync后级的为异步接口。
6.4.1保存数据
1. wx. setStorage(Object)
wx. setStorage(Object)接口将数据存储到本地缓存接口指定的key 中,接口执行后会覆盖原来key对应的内容。其参数如表6-19所示。
表6-19 wx.setStorage(Object) 相关参数
示例代码如下:
wx.setStorage({
key : 'name',
data:'sdy',
success:function(res){
console.1og(res)
}
})
2. wx.setStorageSync( key ,data)
wx.setStorageSymc(key,data)是同步接口,其参数只有 key 和 data。示例代码如下:
wx.setStorageSync( 'age',' 25')
6.4.2 获取数据
1. wx. getStorage( Object)
wx.getStorage(0bject)接口是从本地缓存中异步获取指定 key 对应的内容。其相关参数如表6-20 所示。
表6-20 wx.getstorage(Object)相关参数示例代码如下:
wx.getStorage({
key : 'name',
success:function(res){
console.log(res.data)
},
})
2. wx. getStorageSync( key)
wx. getStorageSync(key)从本地缓存中同步获取指定 key 对应的内容。其参数只有 key。示例代码如下:
try {
var value = wx.getStorageSync( 'age' )
if(value){
console.log("获取成功"+value)
}
} catch(e){
console.log("获取失败")
}
6.4.3 删除数据
1. wx.removeStorage( Object )
wx.removeStorage(0bject) 接口用于从本地缓存中异步移除指定 key。其相关参数如表6-21所示。
表6-21 wx.removeStorage(Object)相关参数
示例代码如下:
wx.removeStorage( {
key : 'name',
success:function(res) {
console.log("删除成功")
},
fail:function() {
console.log('删除失败')
}
})
2. wx. removeStorageSync( key)wx.removeStorageSync(key)接口用于从本地缓存中同步删除指定 key 对应的内容。其参数只有 key。
示例代码如下:
try {
wx.removeStorageSync('name')
} catch(e) {
//Do something when catch error
}
6.4.4 清空数据
1. wx.clearStorage()
wx.clearStorage()接口用于异步清理本地数据缓存,没有参数。
示例代码如下:
wx.getStorage( {
key : 'name',
success:function(res) {
wx.clearStorage() //清理本地数据缓存
},
})
2. wx.clearStroageSync()
wx.clearStroageSync()接口用于同步清理本地数据缓存。
示例代码如下:
try {
wx.clearStorageSync()
} catch(e) {
}
6.5 位置信息 API
小程序可以通过位置信息API来获取或显示本地位置信息,小程序支持WGS84 和CCj02标准,WGS84标准为地球坐标系,是国际上通用的坐标系;GCj02标准是中国国家测绘局制定的地理信息系统的坐标系统,是由WGS84坐标系经加密后的坐标系,又称为火星坐标系默认为WGS84标准,若要查看位置需要使用GCi02标准。主要包括以下3个API接口:
wx.getLocation(0biect)接口 用于获取位置信息。
wx.chooseLocation(0bject)接口 用于选择位置信息。
wx.openLocation(0bject)接口 用于通过地图显示位置。
6.5.1 获取位置信息
wx.getLocation(0bject)接口用于获取当前用户的地理位置、速度,需要用户开启定位功能,当用户离开小程序后,无法获取当前的地理位置及速度,当用户点击“显示在聊天顶部”时,可以获取到定位信息,其相关参数如表6-22所示。
表6-22 wx.getLocation(0biect) 相关参数
wx.getLocation(0bject)调用成功后,返回的参数如表6-23 所示。
表6-23 wx.getLocation(Object) 成功返回相关信息
示例代码如下:
wx.getLocation( {
type:'wgs84',
success:function(res) {
console.log("经度:"+res.longitude);
console.log("纬度:"+ res.latitude);
console.log("速度:"+res。longitude);
console.1og("位置的精确度:"+res.accuracy);
console.log("水平精确度:"+res.horizontalAccuracy);
console.log("垂直精确度:"+res.verticalAccuracy);
},
} )
运行结果如图6-6所示。
6.5.2 选择位置信息
wx.chooseLocation(Object)接口用于在打开的地图中选择位置,用户选择位置后可返回当前位置的名称、地址、经纬度信息。其相关参数如表6-24所示。
表6-24 wx.chooseLocation(Object)相关参数
wx.chooseLocation(0bject)调用成功后,返回的参数如表6-25 所示。
表6-25wx.chooseLocation(Object)成功返回相关信息
示例代码如下:
wx.chooseLocation( {
success:function(res){
console.log("位置的名称: " +res.name)
console.log("位置的地址: " +res.address)
console.log("位置的经度: " +res.longitude)
console.log("位置的纬度: " +res.latitude)
}
} )
6.5.3 显示位置信息
wx.openlocation(Object) 接口用于在微信内置地图中显示位置信息,其相关参数如表6-26所示。
表6-26 wx.openlocation(Object) 相关参数
示例代码如下:
wx.getLocation( {
type: 'gcj02',/返回可以用于wx.openLocation 的经纬度
success:function(res) {
var latitude = res.latitude
var longitude = res.longitude
wx.openLocation( {
latitude: latitude,
longitude: longitude,
scale:10,
name:'智慧国际酒店',
address:'西安市长安区西长安区300号'
} )
}
} )
6.6 设备相关 API
设备相关的接口用于获取设备相关信息,主要包括系统信息、网络状态、拨打电话及扫
码等。主要包括以下5个接口 API:
wx.getSystemInfo(Object)接口、wx.getSystemInfoSync()接口 用于获取系统信息。
wx.getNetworkType(0bject)接口 用于获取网络类型。
wx.onNetworkStatusChange(CallBack)接口用于监测网络状态改变。
wx.makePhoneCall(Object)接口用于拨打电话。
wx.scanCode(0bject)接口用于扫描二维码。
6.6.1 获取系统信息
wx. getSystemInfo(Object)接口、wx.getSystemInfoSync()接口分别用于异步和同步获取系统信息。其相关参数如表6-27 所示。
表6-27 wx.getSystemInfo(Object)接口、wx.getSystemInfoSync()相关参数
wx.getSystemInfo()接口或wx.getSystemInfoSync()接口调用成功后,返回系统相关信息,如表6-28 所示。
表6-28 wx.getSystemInfo()接口或 wx.getSystemInfoSync()成功返回相关信息
示例代码如下:
wx.getSystemInfo({
success:function(res){
console.log("手机型号:"+res.model)
console.log("设备像素比:" + res.pixelRatio)
console.log("窗口的宽度:" + res.windowwidth)
console.log("窗口的高度:" +res.windowHeight)
console.log("微信的版本号:" + res.version)
console.log("操作系统版本:" +res.system)
console.log("客户端平台:" +res.platform)
},
})
6.6.2 网络状态
1. 获取网络状态
wx.getNetworkType(Object)用于获取网络类型,其相关参数如表6-29 所示
表6-29 wx.getNetworkType(Object)相关参数
如果wxgeNetwokType()接口被成功调用,则返回网络类型包,有 wi、2C、3C.
4G、unknow(Android下不常见的网络类型)、none(无网络)。
示例代码如下:
wx.getNetworkType({
success:function(res){
console.log(res.networkType)
},
})
2.监听网络状态变化
wx.onNetworkStatusChange(CallBack)接口用于监听网络状态变化,当网络状态变化时返回当前网络状态类型及是否有网络连接。
示例代码如下:
wx.onNetworkStatusChange(function(res) {
console.log("网络是否连接:"+res.isConnected)
console.log("变化后的网络类型"+res.networkType)
})
6.6.3 拔打电话
wx.makePhoneCall(0bject)接口用于实现调用手机拨打电话,其相关参数如表6-30所示。
表6-30 wx.makePhoneCall() 相关参数
示例代码如下:
wx.makePhoneCall(
phoneNumber:18092585093'/需要拨打的电话号码
})
6.6.4 扫描二维码
wx.scanCode(0bject)接口用于调起客户端扫码界面,扫码成功后返回相应的内容,其相关参数如表6-31 所示。
表6-31 wx.scanCode(Object)相关参数
扫码成功后,返回的数据如表6-32 所示。
表6-32 wx.scanCode(Object)成功返回相关信息
示例代码如下:
//允许从相机和相册扫码
wx.scanCode( {
success:(res) => {
console.log(res,result)
console.log(res.scanType)
console.log(res.charSet)
console.log(res.path)
}
} )
//只允许从相机扫码
wx.scanCode( {
onlyFromCamera: true,
success:(res) => {
console.log(res)
}
} )