目录
API应用
网络API
网络API可以帮助开发者实现网络URL访问调用、文件的上传和下载、网络套接字的使用等功能处理。
1.1 发起网络请求
wx.request(Object)实现向服务器发送请求、获取数据等各种网络交互操作,一个微信小程序同时只能有5个网络请求连接,并且是HTTPS请求。
wx.request(Object) 相关参数
1. 通过wx.request(Object)获取百度( https:// www.baidu.com)首页的数据。
代码如下:
//index.wxml
<button type="primary" bindtap="getbaidutap">获取HTML数据</button>
<textarea value="{{html}}" auto-heightmaxlength="0"></textarea>
//index.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
})
}
})
}
})
效果如下:
2.通过wx.request(Object)的GET方法获取邮政编码对应的地址信息。
代码如下:
//index.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>
//index.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!=unll&&postcode!=""){
var self=this;
wx.showToast({
title: '正在查询,请稍后....',
icon:'loading',
duration:10000
});
wx.request({
url: 'https://v.juhe.cn/postcode/query',
data:{
'postcode':postcode,
'key':'0ff9bfccdf147476e067de994eb5496e'
},
header:{
'Content-Type':'application/json',
},
method:'GET',
success:function(res){
wx.hideToast();
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
})
}
}
})
}
}
})
效果如下:
3. 通过wx.request(Object)的POST方法获取邮政编码对应的地址信息。
代码如下:
//index.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>
//index.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!=unll&&postcode!=""){
var self=this;
wx.showToast({
title: '正在查询,请稍后....',
icon:'loading',
duration:10000
});
wx.request({
url: 'https://v.juhe.cn/postcode/query',
data:{
'postcode':postcode,
'key':'0ff9bfccdf147476e067de994eb5496e'
},
header:{
'content-Type':'application/x-www-form-urlencoded',
},
method:'POST',
success:function(res){
wx.hideToast();
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
})
}
}
})
}
}
})
效果如下:
1.2 上传文件
wx.uploadFile(Object)接口用于将本地资源上传到开发者服务器,并在客户端发起一个HTTPS POST请求。
wx. uploadFile(Object) 相关参数
通过wx.uploadFile(Object),可以将图片上传到服务器并显示。
代码如下:
//index.wxml
<button type="primary" bind:tap="uploadimage">上传图片</button>
<image src="../../images/ai.png" mode="widthFix"/>
//index.js
Page({
data:{
img:null,
},
uploadumage:function(){
var that=this;
wx.chooseImage({
success:function(res){
var tempFilePaths=res.tempFilePaths
upload(that.tempFilePaths);
}
})
function upload(page,path){
wx.showToast({
icon:'loading',
title: '正在上传'
}),
wx.uploadFile({
filePath: path[0],
name: 'file',
url: 'http://localhost/',
success:function(res){
console.log(res);
if(res.statusCode!=200){
wx.showModal({
title:"提示",
content:"上传失败",
showCancel:false
})
return;
}
var data=res.data
page.setData({
img:path[0]
})
},
fail:function(e){
console.log(e);
wx.showModal({
title:"提示",
content:"上传失败",
showCancel:false
})
},
complete:function(){
wx.hideToast();
}
})
}
}
})
效果如下:
1.3 下载文件
wx.downloadFile(0bject)接口用于实现从开发者服务器下载文件资源到本地,在客户直接发起一个 HTTP GET请求,返回文件的本地临时路径。
wx.downloadFile(0bject) 相关参数
通过wx.downloadFile(Object)实现从服务器中下载图片,后台服务采用WAMP软件在本机搭建。
代码如下:
//index.wxml
<button type="primary" bind:tap="downloadimage">下载图像</button>
<image src="../../images/ps.png" mode="widthFix" style="width: 90%;height: 500px;"/>
//index.js
Page({
datd:{
img:null
},
downloadimage:function(){
var that=this;
wx.downloadFile({
url: 'http://localhost/1.jpg',
success:function(res){
console.log(res)
that.setData({
img:res.tempFilePath
})
}
})
}
})
效果如下:
多媒体API
多媒体API主要包括图片API、录音API、音频播放控制API、音乐播放控制 API等,其目的是丰富小程序的页面功能。
2.1 图片API
图片API实现对相机拍照图片或本地相册图片进行处理。
1.选择图片或拍照
wx.chooselmage(Object)接口用于从本地相册选择图片或使用相机拍照。拍照时产生的路径在小程序本次启动期间可以正常使用,若要持久保存,则需要调用wx.saveFile 保存图片到本地。
wx.chooselmage(Object) 相关参数
代码如下:
//index.js
wx.chooseImage({
count:2,
sizeType:['original','compressed'],
sourceType:['album','camera'],
success:function(res){
var tempFilePaths=res.tempFilePaths
var tempFiles=res.tempFiles
console.log(tempFilePaths)
console.log(tempFiles)
}
})
2.预览图片
wx.previewlmage(Object)接口主要用于预览图片。
wx.previewlmage(Object) 相关参数
代码如下:
//index.js
wx.previewImage({
current:"http://bomob - cd n- 16488.b0.upaiyun.com/2018/02/05/2.png",
urls: ["http://bomob - cdn - 16488.b0.upaiyun.com/2018/02/05/1.png",
"http://bomob - cdn - 16488.b0.upaiyun.com/2018/02/05/2.png",
"http://bomob - cdn - 16488.b0.upaiyun.com/2018/02/05/3.png"
],
})
3.获取图片信息
wx.getlmageInfo(Object)接口用于获取图片信息。
wx.getlmageInfo(Object) 相关参数
代码如下:
//index.js
wx.chooseImage({
success:function(res){
wx.getImageInfo({
src: res.tempFilePaths[0],
success:function(e){
console.log(e.width)
console.log(e.height)
}
})
},
})
4.保存图片到系统相册
wx.savelmageToPhotosAlbum(0bject)接口用于保存图片到系统相册,需要得到用户授权scope.writePhotosAlbum。
wx.savelmageToPhotosAlbum(0bject) 相关参数
代码如下:
//index.js
wx.chooseImage({
success:function(res){
wx.saveImageToPhotosAlbum({
filePath: res.tempFilePaths[0],
success:function(e){
console.log(e)
}
})
},
})
2.2 录音 API
录音API提供了语音录制的功能。
1.开始录音
wx.startRecord(0bject)接口用于实现开始录音。当主动调用 wx.stopRecord(0bject)接口或者录音超过1分钟时,系统自动结束录音,并返回录音文件的临时文件路径。若要持保存,则需要调用wx. saveFile()接口。
wx.startRecord(0bject) 相关参数
2.停止录音
wx.stopRecord(Object)接日用于实现主动调用停止录音。
代码如下:
//index.js
wx.startRecord({
success:function(res){
var tempFilePath=res.tempFilePath
},
fail:function(res){
}
}),
setTimeout(function() {
wx.stopRecord()
},10000)
2.3 音频播放控制API
音频播放控制 API主要用于对语音媒体文件的控制,包括播放、暂停、停止及audio组件的控制。
1.播放语音
wx.playVoice(Object)接口用于开始播放语音,同时只允许一个语音文件播放,如果前个语者文件还未播放完,则中断前一个语音文件的播放。
wx.playVoice(Object) 相关参数
代码如下:
//index.js
wx.startRecord({
success:function(res) {
var tempFilePath=res.tempFilePath
wx.playVoice({
filePath: tempFilePath,
complete:function() {
}
})
}
})
2.暂停播放
wx.pauseVoice(Objeet)用于暂停正在播放的语音。再次调用wx.playVoice(Object)播放同一个文件时,会从暂停处开始播放。如果想从头开始播放,则需要先调用wx.stopVoie(Object)。
代码如下:
//index.js
wx.startRecord({
success:function(res) {
var tempFilePath=res.tempFilePath
wx.playVoice({
filePath: tempFilePath,
})
setTimeout(function() {
wx.pauseVoice()
},5000)
}
})
3. 结束播放
wx.stopVoice(Objeet)用于结束播放语音。
代码如下:
//index,js
wx.startRecord({
success:function(res){
var tempFilePath=res.tempFilePath
wx.playVoice({
filePath: tempFilePath,
})
setTimeout(function(){
wx.stopVoice()
},5000)
}
})
2.4 音乐播放控制API
音乐播放控制API主要用于实现对背景音乐的控制,音乐文件只能是网络流媒体,不能是本地音乐文件。
1.播放音乐
wx.playBackgroundudio(Object)用于播放音乐,同一时间只能有一首音乐处于播放状态。
wx.playBackgroundudio(Object) 相关参数
2.获取音乐播放状态
wx. getBackgroundAudioPlayerState(Object)接口用于获取音乐播放状态。
wx. getBackgroundAudioPlayerState(Object) 相关参数
接口调用成功后返回的参数。
wx. getBackgroundAudioPlayerState(Object) 成功返回相关参数
3.控制音乐播放进度
wx.seekBackgroundAudio(0bject)接口用于控制音乐播放进度。
wx.seekBackgroundAudio(0bject) 相关参数
4.暂停播放音乐
wx.pauseBackgroundAudio()接口用于暂停播放音乐。
5.停止播放音乐
wx.stopBackgroundAudio()接口用于停止播放音乐。
6.监听音乐播放
wx.onBackgroundAudioPlay(CallBack)接口用于实现监听音乐播放,通常被wx.playBack-groundAudio(Object)方法触发,在CallBack中可改变播放图标。
7.监听音乐暂停
wx.onBackgroundAudioPause(CallBack)接口用于实现监听音乐播放,通常被wdwx.pauseBackgroundAudio()方法触发,在CallBack中可改变播放图标。
8.监听音乐停止
wx.onBackgroundAudioStop(CallBack)接口用于实现监听音乐停止,通常被音乐自然播放停止或wx.seekBackgroundAudio(Object)方法导致播放位置等于音乐总时长时触发。在CallBack中可以改变播放图标。
9.案例展示
在此,以小程序music为案例来展示音乐API的使用。该小程序的4个页面文件分别为music.wxml、music.wxss、music.json和 music.cojs。
代码如下:
//index.js
<view class="container">
<image class="bgaudio" src="{{changedImg? music.coverImg:'../../images/ai.png'}}"></image>
<view class="contro-view">
<image src="../../images/ps.png" bindtap="onPositionTap" data-how="0"></image>
<image src="../../images/ai.jpg" bindtap="onAudioTap"></image>
<image src="../../images/ps.jpg" bindtap="onStopTap"></image>
<image src="../../images/ai.png" bindtap="onPositionTap" data-how="1"></image>
</view>
</view>
//index.wxss
.bgaudio{
height:350rpx;
width:350rpx;
margin-bottom:100rpx;
}
.control-viewimage{
height:64rpx;
width:64rpx;
margin:30rpx;
}
//index.json
{
}
//index.js
Page({
data:{
isPlaying:false,
coverImgchangedImg:false,
music:{
"url":
"http://bmob-cdn-16488.b0.upaiyun.com/2018/02/09/117e4alb405195b18061299e2de89597.mp3",
"titie":"盛晓玫-有一天",
"coverImg":
"http://bmob-cdn-16488.b0.upaiyun.com/2018/02/09/f604297140c9681880cc3d3e581f7724.jpg"
},
},
onLoad:function(){
this.onAudioState();
},
onAudioTap:function(event){
if(this.data.isPlaying){
wx.pauseBackgroundAudio();
}else{
let music =this.data.music;
wx.playBackgroundAudio({
dataUrl:music.url,
title:music.titie,
coverImgUrl:music.coverImg
})
}
},
onStopTap:function(){
let that=this;
wx.stopBackgroundAudio({
success:function(){
that.setData({isPlaying:false,changedImg:false});
}
})
},
onPositionTap:function(event){
let how=event.target.dataset.how;
wx.getBackgroundAudioPlayerState({
success:function(res){
let status=res.duration;
if(status===1){
let duration=res.duration;
let currentPosition=res.currentPosition;
if(how==="0"){
let position=currentPosition-10;
if(position<0){
position=1;
}
wx.seekBackgroundAudio({
position:position
});
wx.showToast({title:"快退10s",duration:500});
}
if(how==="1"){
let position=currentPosition+10;
if(position>duration){
position=duration-1;
}
wx.seekBackgroundAudio({
position:position
});
wx.showToast({title:"快进10s",duration:500});
}
}else{
wx.showToast({title:"音乐未播放",duration:800});
}
}
})
},
onAudioState:function(){
let that=this;
wx.onBackgroundAudioPlay(function(){
that.setData({isPlaying:true,changedImg:true});
console.log("on play");
});
wx.onBackgroundAudioPause(function(){
that.setData({isPlaying:false});
console.log("on pause");
});
wx.onBackgroundAudioStop(function(){
that.setData({isPlaying:false,changedImg:false});
console.log("on stop");
});
}
})
效果如下:
文件API
从网络上下载或录音的文件都是临时保存的,若要持久保存,需要用到文件API。文件API提供了打开、保存、删除等操作本地文件的能力。
3.1 保存文件
wz.saveFile(0bject)用于保存文件到本地。
wz.saveFile(0bject) 相关参数
代码如下:
//index.js
Page({
saveImg:function(){
wx.chooseImage({
count:1,
sizeType:["original","compressed"],
success:function(res){
var tempFilePath=res.tempFilePath[0]
wx.saveFile({
tempFilePath:tempFilePaths,
success:function(res){
var saveFilePath=res.saveFilePath;
console.log(saveFilePath)
}
})
}
})
}
})
3.2 获取本地文件列表
wx.getSavedFileList(Object)接口用于获取本地已保存的文件列表,如果调用成功,则返回文件的本地路径、文件大小和文件保存时的时间戳(从1970/01/0108:00:00到当时间的秒数)文件列表。
wx.getSavedFileList(Object) 相关参数
代码如下:
//index.js
wx.getSavedFileList({
success:function(res){
that.setData({
fileList:res.fileList
})
}
})
3.3 获取本地文件的文件信息
wx.getsaveFilelnto(0bjeet)接口用于获取本地文件的文件信息,此接口只能用于获取R保存到本地的文件,若需要获取临时文件信息,则使用wx.getFilelnfo(Object)接口。
wx.getsaveFilelnto(0bjeet) 相关参数
代码如下:
//index.js
wx.chooseImage({
count:1,
sizeType:["original","compressed"],
sourceType:["album","camera"],
success:function(res){
var tempFilePath=res.tempFilePath[0]
wx.saveFile({
tempFilePath:tempFilePaths,
success:function(res){
var saveFilePath=res.saveFilePath;
wx.getSavedFileInfo({
filePath:saveFilePath,
success:function(res){
console.log(res.size)
}
})
}
})
}
})
3.4 删除本地文件
wx.removeSavefile(0bjecl)接口用于删除本地存储的文件。
wx.removeSavefile(0bjecl) 相关参数
代码如下:
//index.js
wx.getSavedFileList({
success:function(res){
if(res.fileList.length>0){
wx.removeSavedFile({
filePath:res.fileList[0].filePath,
complete:function(res){
console.log(res)
}
})
}
}
})
3.5 打开文档
wx.openDocument(Object)接口用于新开页面打开文档,支持格式有doe、xls、ppt、pdf、docx、xlsx、pptx。
wx.openDocument(Object) 相关参数
代码如下:
//index.js
wx.downloadFile({
url: 'http://localhost/fm2.pdf',
success:function(res){
var tempFilePath=res.tempFilePath;
wx.openDocument({
filePath: tempFilePath,
success:function(res){
console.log("打开成功")
}
})
}
})
本地数据及缓存API
小程序提供了以键值对的形式进行本地数据缓存功能,并且是永久存储的,但最大不超过10MB,其目的是提高加载速度。
4.1 保存数据
1.wx.setStorage(Object)接口将数据存储到本地缓存接口指定的key中,接口执行后会覆盖原来key 对应的内容。
wx.setStorage(Object) 相关参数
代码如下:
//index.js
wx.setStorage({
key:'name',
data:'sdy',
success:function(res){
console.log(res)
}
})
2.wx.setStorageSync(key,data)是同步接口,其参数只有 key 和 data。
代码如下:
//index.js
wx.setStorageSync('age', '25')
4.2 获取数据
1.wx.getStorage(0bject)接口是从本地缓存中异步获取指定key对应的内容。
wx.getStorage(0bject) 相关参数
代码如下:
//index.js
wx.getStorage({
key:'name',
success:function(res){
console.log(res.data)
},
})
2.wx.gelStorageSyne(key)从本地缓存中同步获取指定key 对应的内容。其参数只有key。
代码如下:
//index.js
try{
var value=wx.getStorageSync('age')
if(value){
console.log("获取成功"+value)
}
}catch(e){
console.log("获取失败")
}
4.3 删除数据
1.wx.removeStorage(0bject)接口用于从本地缓存中异步移除指定key。
wx.removeStorage(0bject) 相关参数
代码如下:
//index.js
wx.removeStorage({
key: 'name',
success:function(res){
console.log("删除成功")
},
fail:function(){
console.log("删除失败")
}
})
2.wx.removeStorageSyne(key)接口用于从本地缓存中同步删除指定key对应的内容。
代码如下:
//index.js
try{
wx.removeStorageSync('name')
}catch(e){
//Do something when catch error
}
4.4 清空数据
1.wx.clearStorage()接口用于异步清理本地数据缓存,没有参数。
代码如下:
//index.js
wx.getStorage({
key:'name',
success:function(res){
wx.clearStorage()
}
})
2.wx.clearStroageSyne()接口用于同步清理本地数据缓存。
代码如下:
//index.js
try{
wx.clearStorageSync()
}catch(e){
}
位置信息API
小程序可以通过位置信息API来获取或显示本地位置信息,小程序支持WGS84和GCj02标准,WGS84标准为地球坐标系,是国际上通用的坐标系;CCj02标准是中国国家测绘局制定的地理信息系统的坐标系统,是由WGS84坐标系经加密后的坐标系又称为火星坐标系默认为WGS84标准,若要查看位置需要使用GCj02标准。
5.1 获取位置信息
wx.getLocation(Object)接口用于获取当前用户的地理位置、速度,需要用户开启定位功能,当用户离开小程序后,无法获取当前的地理位置及速度,当用户点击“显示在聊天顶部”时,可以获取到定位信息。
wx.getLocation(Object) 相关参数
wx.getLocation(Object)调用成功后,返回的参数。
wx.getLocation(Object) 成功返回相关信息
代码如下:
//index.js
wx.getLocation({
type:'wgs84',
success:function(res){
console.log("经度:" +res.longitude);
console.log("维纬" +res.latitude);
console.log("速度:" +res.longitude);
console.log("位置的精确度:" +res.accuracy);
console.log("水平的精确度:" +res.horizontalAccuracy);
console.log("垂直精确度:" +res.verticalAccuracy);
}
})
5.2 选择位置信息
wx.chooseLocation(Object)接口用于在打开的地图中选择位置,用户选择位置后可返回当前位置的名称、地址、经纬度信息。
wx.chooseLocation(Object) 相关参数
wx.chooseLocation(Object)调用成功后,返回的参数。
wx.chooseLocation(Object) 成功返回相关信息
代码如下:
//index.js
wx.chooseLocation({
success:function(res){
console.log("位置的名称"+res.name)
console.log("位置的地址"+res.address)
console.log("位置的经度"+res.longitude)
console.log("位置的纬度"+res.latitude)
}
})
5.3 显示位置信息
wx.openLocation(Object)接口用于在微信内置地图中显示位置信息。
wx.openLocation(Object) 相关参数
代码如下:
//index.js
wx.getLocation({
type:'gcj02',
success:function(res){
var latitude=res.latitude
var longitude=res.longitude
wx.openLocation({
latitude:latitude,
longitude:longitude,
scale:10,
name:'智慧国际酒店',
address:'西安市长安区西长安区300号'
})
}
})
设备相关 API
设备相关的接口用于获取设备相关信息,主要包括系统信息、网络状态、拨打电话及扫码等。
6.1 获取系统信息
wx.getSystemInfo(Object)接口、wx. getSystemInfoSync()接口分别用于异步和同步获取系统信息。
wx.getSystemInfo(Object)接口、wx. getSystemInfoSync() 相关参数
wx. getSystemInfo()接口或wx.getSystemInfoSync()接口调用成功后,返回系统相关信息。
wx. getSystemInfo()接口或wx.getSystemInfoSync() 成功返回相关参数
代码如下:
//index.js
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.2 网络状态
1.获取网络状态
wx.getNetworkType(Object)用于获取网络类型。
wx.getNetworkType(Object) 相关参数
如果wx.getNetworkType()接口被成功调用,则返回网络类型包,有wifi、2G、3G、4G、unknown(Android下不常见的网络类型)、none(无网络)。
代码如下:
//index,js
wx.getNetworkType({
success:function(res){
console.log(res.networkType)
},
})
2.监听网络状态变化
wx.onNetworkStatusChange(CallBack)接口用于监听网络状态变化,当网络状态变化时,返回当前网络状态类型及是否有网络连接。
代码如下:
//index.js
wx.onNetworkStatusChange(function(res){
console.log("网络是否连接:"+res.isConnected)
console.log("变化后的网络类型:"+res.networkType)
})
6.3 拨打电话
wx.makePhoneCall(Object)接口用于实现调用手机拨打电话。
wx.makePhoneCall(Object) 相关参数
代码如下:
//index.js
wx.makePhoneCall({
phoneNumber:'18092585093'
})
效果如下:
6.4 扫描二维码
wx.scanCode(Object)接口用于调起客户端扫码界面,扫码成功后返回相应的内容。
wx.scanCode(Object) 相关参数
扫码成功后,返回的数据。
wx.scanCode(Object) 成功返回相关参数
代码如下:
//index.js
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)
}
})
效果如下: