6.1 网络API
微信小程序处理的数据通常从后台服务器获取,再将处理过的结果保存到后台服务器,这就要求微信小程序要有与后台进行交互的能力。微信原生API接口或第三方API提供了各类接口实现前后端交互。
网络API可以帮助开发者实现网络URL访问调用、文件的上传和下载、网络套接字的使用等功能处理。微信开发团队提供了10个网络API接口。
wx.request(Object)接口用于发起HTTPS请求。
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)接口 用于实现监听 WebSoeket 关闭。
6.1.1 发起网络请求
wx. request(Object)实现向服务器发送请求、获取数据等各种网络交互操作,其相关参
数如表6-1所示。一个微信小程序同时只能有5个网络请求连接,并且是HTTPS请求。
例如,通过wx.request(Object)获取百度(https:// www.baidu.com)首页的数据。(需要在微信公众平台小程序服务器配置中的request合法域名中添加“https:// www. baidu.com”。)
代码示例展示:
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
})
}
})
}
})
wxml代码展示:
<button type="primary" bindtap="getbaidtap">获取HTML数据</button>
<text areavalue='{{html}}'auto-heightmaxlength='0'></text>
代码运行结果展示:
6.1.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"/>
代码运行结果展示:
6.1.3下载文件
wx.downloadFile(Object)接口用于实现从开发者服务器下载文件资源到本地,在客户端
接发起一个 HTTP GET 请求,返回文件的本地临时路径。其相关参数如表所示。
6.2 多媒体API
媒体AP1主要包括图片API、录音API、音频播放控制API、音乐播放控制API等,其
目的是丰富小程序的页面功能。
6.2.1 图片 API
图片API实现对相机拍照图片或本地相册图片进行处理,主要包括以下4个API接口:
wx. chooselmage(Object)接口 用于从本地相册选择图片或使用相机拍照。
wx. previewlmage(Object)接口用于预览图片。
wx. getlmagelnfo(Object)接口用于获取图片信息。
wx. savelmageToPhotosAlbum(Object)接口用于保存图片到系统相册。
1.选择图片或拍照
wx.chooselmage(Object)接口用于从本地相册选择图片或使用相机拍照。拍照时产生的临时路径在小程序本次启动期间可以正常使用,若要持久保存,则需要调用wx. saveFile保存图片到本地。其相关参数如表所示。
若调用成功,则返回 tempFilePaths 和 tempFiles,tempFilePaths 表示图片在本地临时文件路径列表。tempFiles 表示图片的本地文件列表,包括 path和size。
2.预览图片
wx. previewlmage( Object)接口主要用于预览图片,其相关参数如下表所示:
3.获取图片信息
wx.getlmagelnfo( Object)接口用于获取图片信息,其相关参数如表所示:
4.保存图片到系统相册
wx. savelmageToPhotosAlbum(Object)接口用于保存图片到系统相册,需要得到用户授权scope. writePhotosAlbum。其相关参数如表所示。
6.2.2录音API
录音API提供了语音录制的功能,主要包括以下两个API接口:wx. starRecord(Object)接口用于实现开始录音。wX. stopRecord(Object)接口 用于实现主动调用停止录音。
1.开始录音
wx. startRecord(Object)接口用于实现开始录音。当主动调用 wx. stopRecord(Object)接口或者录音超过1分钟时,系统自动结束录音,并返回录音文件的临时文件路径。若要持久保存,则需要调用 wx. saveFile()接口。其相关参数如表所示。
2.停止录音
wx.stopRecord(Object)接口用于实现主动调用停止录音。
6.2.3音频播放控制API
音频播放控制API主要用于对语音媒体文件的控制,包括播放、暂停、停止及audio组
件的控制,主要包括以下3个API:
wx.playVoice(Object)接口,用于实现开始播放语音。
wx. pauseVoice(Object)接口用于实现暂停正在播放的语音。
wx.stopVoice(Object)接口用于结束播放语音。
1.播放语音
wx.playVoice(Object)接口用于开始播放语音,同时只允许一个语音文件播放,如果前
个语音文件还未播放完,则中断前一个语音文件的播放。其相关参数如表所示。
2.暂停播放
wx. pauseVoice( Object)用于暂停正在播放的语音。再次调用wx.playVoice(Object)播放同一个文件时,会从暂停处开始播放。如果想从头开始播放,则需要先调用wx.stopVoice(Object)。
3.结束播放
WstopVoice(Object)用于结束播放语音。
6.2.4音乐播放控制API
音乐播放控制API主要用于实现对背景音乐的控制,音乐文件只能是网络流媒体,不能
是本地音乐文件。音乐播放控制API主要包括以下8个API:
wx. playBackgroundAudio(Object)接口 用于播放音乐。
wx. getBackgroundAudioPlayerState(Object)接口 用于获取音乐播放状态。
wx. seekBackgroundAudio(Object)接口用于定位音乐播放进度。
wx.pauseBackgroundAudio()接口用于实现暂停播放音乐。
wx.stopBackgroundAudio()接口用于实现停止播放音乐。
wx. onBackgroundAudioPlay(CallBack)接口 用于实现监听音乐播放。
wx. onBackgroundAudioPause( CallBack)接口 用于实现监听音乐暂停。
wx. onBackgroundAudioStop(CallBack)接口 用于实现监听音乐停止。
1.播放音乐
wx. playBackgroundAudio(Object)用于播放音乐,同一时间只能有一首音乐处于播放状态。相关参数如下表所示:
2.获取音乐播放状态
wx. getBackgroundAudioPlayerState(Object)接口用于获取音乐播放状态,其相关参数如所示。
接口调用成功返回的参数如表所示。
3.控制音乐播放进度
wx. seekBackgroundAudio(Object)接口用于控制音乐播放进度,其相关参数如表所示。
4、暂停播放音乐
wx. pauseBackgroundAudio()接口用于暂停播放音乐。
5.停止播放音乐
wx. stopBackgroundAudio()接口用于停止播放音乐。
6.监听音乐播放
wx. onBackgroundAudioPlay(CallBack)接口用于实现监听音乐播放,通常被 wx.playBack-
groundAudio(Object)方法触发,在CallBack中可改变播放图标。
7.监听音乐暂停
wX. onBackgroundAudioPause( CallBack)接口用于实现监听音乐暂停,通常被 wx.pause-
BackgroundAudio()方法触发。在CallBack中可以改变播放图标。
8.监听音乐停止
wx. onBackgroundAudioStop(CallBack)接口用于实现监听音乐停止,通常被音乐自然播放停止或wx. seekBackgroundAudio(Objeet)方法导致播放位置等于音乐总时长时触发。在CallBack中可以改变播放图标。
9.案例展示
在此,以小程序 music为案例来展示音乐API的使用。该小程序的4个页面文件分别为 music. wxml、music. wxss、music. json和music.cojs。实际效果如图所示。
代码示例展示:
wxml代码展示:
<view class="container">
<image class="bgaudio"src = "{{changedImg? music.coverImg:'../image/head.png'}}"/>
<view class ="control-view">
<image src ="../image/head.png"bindtap="onPositionTap"data-how= "0 "/>
<image src = "../image/{{isPlaying?'aa':'bb'}}.png " bindtap = "onAudioTap"/>
<image src ="../image/bb.png"bindtap = "onStopTap"/>
<image src ="../image/head.png"bindtap ="onPositionTap"data-how = "1"/>
</view >
</view >
wxss代码展示:
.bgaudio{
height:350rpx; width:350rpx;
margin-bottom:100rpx;
}
.control-view image{
height:64rpx;
width:64rpx;
margin:30rpx;
}
js代码展示:
Page({
data:{
isPlaying:false,
coverImgchangedImg:false,
music:{
"url":"../image/e e.mp4",
"title":"盛晓玫-有一天",
"coverImg":
"../image/e e.mp4"
},
},
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");
});
}
})
代码运行结果展示:
6.3 文件API
从网络上下载或录音的文件都是临时保存的,若要持久保存,需要用到文件API。文件API提供了打开、保存、删除等操作本地文件的能力,主要包括以下5个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)用于保存文件到本地,其相关参数如表所示。
2.获取本地文件列表
wx. getSavedFileList(Object)接口用于获取本地已保存的文件列表,如果调用成功,则返回文件的本地路径、文件大小和文件保存时的时间戳(从1970/01/01 08: 00: 00到当前时间的秒数)文件列表。其相关参数如表所示。
3.获取本地文件的文件信息
wx. getSaveFileInfo(Object)接口用于获取本地文件的文件信息,此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,则使用wx. getFileInfo(Object)接口。其相关参数如表所示。
4.删除本地文件
wx. removeSaveFile(Object)接口用于删除本地存储的文件,其相关参数如表所示。