小程序第六章API应用总结-战狼源码网

一.网络API

wx.request(Object) 接口用于将本地资源上传到后台服务器

wx.uploadFile(Object) 接口用于将本地资源上传到后台服务器

wx.downloadFile(Object) 接口用于下载文件资源到本地

wx.connectSocket(Object) 接口用于创建一个WebSocket连接

wx.sendSocketMessage(Object) 接口用于实现通过WebSocket连接发送数据

wx.closeSocket(Object) 接口用于关闭WebSocket连接

wx.onSocketOpen(CallBack) 接口用于监听WebSocket连接打开事件

wx.onSocketError(CallBack) 接口用于监听WebSocket错误

wx.onSocketMessage(CallBack) 接口用于实现监听WebSocket接收到服务器的消息事件

wx.onSocketClose(CallBack) 接口用于实现监听WebSocket关闭

1.发起网络请求

wx.request(Object)实现向服务器发送请求、获取数据等各种网络交互操作，其相关参数如下表所示。一个微信小程序同时只能有5个网络请求连接，并且是HTTPS请求。

例如，通过wx.request(Object)获取百度首页的数据。示例代码如下：

//baidu.wxml<buttontype="primary"bindtap="getbaidutap">获取HTML数据</buttontype><textareavalue='{{html}}'auto-heightmaxlength='0'> </textareavalue>//baidu.jsPage({  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.jsPage({  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       })     }   } })  }}})

2.上传文件

wx.uploadFile(Object)接口用于将本地资源上传到开发者服务器，并在客户端发起一个HTTPS POST请求，其相关的参数如下表：

通过wx.uploadfile(Object),可以将图片上传到服务器并显示。示例代码如下：

.js

Page({    data: {     img:null,    },    uploadimage:function(){      var that=this;      wx.chooseImage({        success:function(res){          var tempFilePaths=res.tempFilePaths          upload(this.tempFilePaths);        }      })      function upload(page,path){        wx.showToast({          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();        }        })      }    }  })

.wxml

<button type="primary" bindtap="uploadimage">上传图片</button><image src="{{img}}" mode="widthFix"/>

3.下载文件

wx.downloadFile(Object)接口用于实现从开发者服务器下载文件资源到本地，在客户端直接发起一个HTTP GET请求，返回文件的本地临时路径。其相关参数如下表：

例如。通过wx.downloadFile(Object)实现从服务器中下载图片，后台服务器采用WAMP软件在本机搭建。示例代码如下：

二.多媒体API

多媒体API主要包括图片API、录音API、音频API、音乐播放控制API等，其目的是丰富小程序的页面功能。

1.图片API

(1).选择图片或拍照

wx.chooseImage(Object)接口用于从本地相册选择图片或使用相机拍照。拍照时产生的临时路径在小程序本次启动期间可以正常使用，若要持久保存，则需要调用wx.saveFile保存图片到本地。其相关参数如下表：

若调用成功，则返回tempFilePaths和temp File，tempFilePaths表示图片在本地临时文件路径列表。tempFiles表示图片的本地文件列表，包括path和size。

示例代码如下：

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).预览图片

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).获取图片信息

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).保存图片到系统相册

wx.saveImageToPhotosAlbum(Object)接口用于保存图片到系统相册，需要获得用户授权scope.writePhotosAlbum。其相关参数如下表：

示例代码如下：

wx.chooseImage({  success:function(res){    wx.saveImageToPhotosAlbum({      filePath: res.tempFilePaths[0],      success:function(e){        console.log(e)      }    })  },})

2.录音API

（1).开始录音

wx.sartRecord(Object)接口用于实现开始录音。当主动调用wx.stopRecord(Object)接口或者录音超过一分钟时，系统自动结束录音，并返回录音文件的临时文件路径。若要持久保存，则需要调用wx.saveFile() 接口。其相关参数如下表：

（2).停止录音

wx.stopRecord(Object)接口用于实现主动调用停止录音。

示例代码如下：

wx.startRecord)({  success:function(res){    var tempFilePath=res.tempFilePath  },  fail:function(res){    //录音失败  }})setTimeout(function){  //结束录音  wx.stopRecord()},10000)

3.音频播放控制API

音频播放控制API主要用于语音媒体文件的控制，包括播放、暂停、停止以及audio组件的控制，主要包括以下3个API：

wx.playVoice(Object)接口用于实现开始播放语音。

wx.pauseVoice(Object)接口用于实现暂停正在播放的语音。

wx.stopVoice(Object)接口用于结束播放语音。

(1).播放语音

其参数如下表

示例代码如下：

wx.startRecord({  success:function(res){    var tempFilePath=res.tempFilePath    wx.playVoice({  //录音完后立即播放      filePath: tempFilePath,      complete:function(){      }    })  }})

(2).暂停播放

如果想从头开始播放，则需要先调用wx.stopVoice(Object)。示例代码如下：

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)    }    })

4.音乐播放控制API

音乐播放控制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) 接口用于实现监听音乐停止

(1).播放音乐

wx.playBackgroundAudio(Object)用于播放音乐，其相关属性如下表：

示例代码如下：

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).获取音乐播放状态

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).控制音乐播放进度

wx.seekBackgroundAudio(Object)接口用于控制音乐播放进度，其相关参数如下表：

示例代码如下：

wx.seekBackgroundAudio({  position: 30,})

(4).暂停播放音乐

wx.pauseBackgroundAudio()接口用于暂停播放音乐。

示例代码如下：

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.stopBackgroundAudio()接口用于停止播放音乐。

示例代码如下：

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.onBackgroundAudioPlay(CallBack)接口用于实现监听音乐播放，通常wx.playBackgroundAudio(Object)方法触发，在CallBack中可改变播放图标。

示例代码如下：

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）接口用于实现监听音乐暂停，通常被 wx.pause-BackgroundAudio(）方法触发。在CallBack中可以改变播放图标。

(8).监听音乐停止

wx. onBackgroundAudiOStop(CallBack）接口用于实现监听音乐停止，通常被音乐自然播放停止或wx. seekBackgroundAudio(Objeet)方法导致播放位置等于音乐总时长时触发。在CallBack中可以改变播放图标。

(9).案例展示

//wxml<view class="container"><image class="bgaudio"src = "{{changedImg? music.coverImg:'../image/obt.jpg'}}"/><view class ="control-view"><image src="/pages/image/6.jpg" bindtap="onPositionTap"data-how= "0 "/><image src = "/pages/image/1.jpg" bindtap = "onAudioTap"/><image src ="/pages/image/2.jpg"bindtap = "onStopTap"/><image src ="/pages/image/3.jpg"bindtap ="onPositionTap"data-how = "1"/></view ></view >//jsPage({  data:{  isPlaying:false,  coverImgchangedImg:false,	  music:{   "url":"../image/xtq.mp4",  "title":"文字",  "coverImg":  "../image/obt.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.title,	  	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.status; 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");	});	}})//wxss.bgaudio{  height:520rpx; width:720rpx;  margin-bottom:100rpx;}  .control-view image{   height:64rpx;     width:64rpx;      margin:30rpx;}

三.文件API

wx.saveFile(Object)接口用于保存文件到本地
wx.getSavedFileList(Object) 接口用于获取本地已保存的文件列表
wx.getSaveFileInfo(Object) 接口用于获取本地文件的文件信息
wx.removeSaveFile(Object) 接口用于删除本地存储的文件
wx.openDocument(Object) 接口用于新开页面打开文档，支持格式：doc、xls、ppt、pdf、docx、xlsx、ppts

1.保存文件

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.获取本地文件列表

wx.getSavedFileList(Object),其参数如下表：

示例代码如下：

wx.getSavedFileList({  success:function(res){    that.setData({      fileList:res,fileList    })  }})

3.获取本地文件的文件信息

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.删除本地文件

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.打开文档

wx.openDocument(Object),其相关参数如下表:

示例代码如下：

wx.downloadFile({  url: 'http://localhost/fm2.pdf', //在本地通过wxamp搭建服务器  success:function(res){var tempFilePath=res.tempFilePath;wx.openDocument({  filePath: tempFilePath,  success:function(res){    console.log("打开成功")  }})  }})