第六章（网络API）总结

微信小程序处理的数据通常从后台服务器获取，再将处理过的结果保存到后台服务器，这就要求微信小程序要有与后台进行交互的能力。微信原生API接口或第三方API提供了各类接口实现前后端交互。
        网络API可以帮助开发者实现网络URL访问调用、文件的上传和下载、网络套接字的使用等功能处理。微信开发团队提供了10个网络API接口。

6.1.1发起网络请求

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

示例代码

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

<button type="primary" bindtap="getbaidtap">获取HTML数据</button>
<text areavalue='{{html}}'auto-heightmaxlength='0'></text>

6.1.2上传文件

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

示例代码

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

Page({
    data:{
    img:null,
    },
    uploadimage:function(){
    var that = this;
    //选择图片
    wx.chooseImage({
    success:function(res){
    var tempFilePaths = res.tempFilePaths
    upload(that,tempFilePaths);
}
})
function upload(page,path){
//显示toast提示消息
wx.showToast({
icon:"loading",
title:"正在上传"
}),
wx.uploadFile({
url:"http://localhost/",
filePath:path[0],
name:'file',
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();
}
})
}
}
})

6.1.3 下载文件

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

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

示例代码 

<button type = "primary"bindtap ='downloadimage'>下载图像</button> <image src ="{{img}}"mode ='widthFix'style ="width: 90%; height 500px"></image>

Page({
    data:{
    img:null},
    downloadimage: function(){
    var that =this;
    wx.downloadFile({
    url:"http://localhost /l.jpg",//通过WAMP软件实现
    success:function(res){
    console. log(res)
    that.setData({
    img:res.tempFilePath
    })}})}
})

6.2 多媒体API

多媒体API主要包括图片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. startRecord(Object）接口，用于实现开始录音。wx.stopRecord(Object）接口用于实现主动调用停止录音。

1.开始录音
wX. stanRecord(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.结束播放
Wx. stopVoice（Object）用于结束播放语音。

6.2.4音乐播放控制API
音乐播放控制API主要用于实现对背景音乐的控制，音乐文件只能是网络流媒体，不能是本地音乐文件。音乐播放控制 API主要包括以下8个 API:

■wx.playBackgroundAudio(Object）接口用于播放音乐。
■wx. getBackgroundAudioPlayerState(Object)接只用于获取音乐播放状态。

■wx. seekBackgroundAudio(Object）-接日一用于定位音乐播放进度。

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

■wx. stopBackgroundAudio(）接口用于实现停止播放音乐。
■w.onBackgroundAudioPlay(CallBack）接口用于实现监听音乐播放。

■w. 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-
ndAudio(Object)方法触发，在CallBack中可改变播放图标。

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

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

9.案例展示
在此，以小程序music为案例来展示音乐API的使用。该小程序的4个页面文件分别为music. wxml、music. wxss、music. json和 music. cojs。

6.3文件API

从网络上下载或录音的文件都是临时保存的，若要持久保存，需要用到文件API。文件
API提供了打开、保存、删除等操作本地文件的能力，主要包括以下5个API接口：
 wx. saveFile( Object)接口 用于保存文件到本地。
wx. getSavedFileList(Object)接口用于获取本地已保存的文件列表。

wx. getSaveFileInfo(Object)接口用于获取本地文件的文件信息。

WX.removeSaveFile(Object)接口 用于删除本地存储的文件。
wX. openDocument( Object)接口用于新开页面打开文档，支持格式：doc、xs、ppt、pdf、 docx、xlsx、 ppts。

1.保存文件
wX. saveFile(Object）用于保存文件到本地，其相关参数如表所示：

2.获取本地文件列表

wgeSavedFileList(Object）接口用于获取本地已保存的文件列表，如果调用成功，则运国文件的本地路径、文件大小和文件保存时的时间戳（从1970/01/0108：00：00到当前的秒数）文件列表。其相关参数如表所示：

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

wx. gelSaveFileInfo(Object)接口用于获取本地文件的文件信息，此接口只能用于获取已保存到本地的文件，若需要获取临时文件信息，则使用 wx. getFileInfo(Object）接口。其相关参数如表所示：

4.别除本地文件

W.removeSaveFile(Object)接口用于删除本地存储的文件，其相关参数如表所示：

5.打开文档

m.openDocument( Object)接口用于新开页面打开文档，支持格式有doc、xls、ppt、pdf、
n、xlsx、pptx。

6.4 本地数据及缓存API

6.4.1 保存数据

1.wx.setStorage(Object)

wx.setStorage(Object)接口将数据存储到本地缓存接口指定的key中，接口执行后会覆盖原来key对应的内容。其参数如下表所示：

示例代码：

wx.setStorage({
  key:'name',
  data:'sdy',
  success:function(res){
    console.log(res)
  }
})

 运行结果

2.wx.setStorageSync(key,data)

wx.setStorage(key,data)是同步接口，其参数只有key和data

示例代码

wx.setStorageSync('age','25')

6.4.2 获取数据 

1.wx.getStorage(Object)

wx.getStorage(Object)接口是从本地缓存中异步获取指定key对应的内容。其参数如下表所示：

示例代码：

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(Object)接口用于从本地缓存中异步移除指定key。其相关参数如下表所示：

示例代码:

wx.removeStorage({
  key: 'name',
  success:function(res){
    console.log("删除成功")
  },
  fail:function(){
    console.log("删除失败")
  }
})

运行结果:

2.wx.removeStorage(key)

wx.removeStorage(key)接口用于从本地缓存中同步删除指定key对应的内容。其参数只有key。

示例代码:
 

try{
  wx.removeStorageSync('name')
}catch(e){
}

运行结果：

6.4.4 清空数据

 1.wx.clearStorage()

wx.clearStorage()接口用于异步清理本地数据缓存，没有参数

示例代码：

wx.getStorage({
  key:'name',
    success:function(res){
      wx.clearStorage()
    },
})

运行结果:

2.wx.clearStorageSync() 

wx.clearStorageSync() 接口用于同步清理本地缓存数据

示例代码:

try{
  wx.clearStorageSync()
}catch(e){
  
}

运行结果：

6.5 位置信息API 

 小程序可以通过位置信息API来获取或显示本地位置信息，小程序支持WGS84和GCj02标准，WGS84标准为地球坐标系，是国际上通用的坐标系；GCj02标准是中国国家测绘局指定的地理信息系统的坐标系统，室友WGS84坐标系经加密后的坐标系，又称为火星坐标系。

默认为WGS84标准，若要查看位置需要使用GCj02标准。主要包括以下三个API接口：

        wx.getLocation(Object)接口        用于获取位置信息

        wx.chooseLocation(Object)接口        用于选择位置信息

        wx.openLocation(Object)接口        用于通过地图显示位置

6.5.1 获取位置信息

 wx.getLocation(Object)接口用于获取当前用户的地理位置、速度，需要用户开启定位功能，当用户离开小程序后，无法获取当前的地理位置及速度，当用户点击"显示在聊天顶部"时，可以获取到定位信息，其相关参数如下表所示：

wx.getLocation(Object)调用成功后，返回的参数如下表所示：

示例代码：

wx.getLocation({
  type:'wgs84',
    success:function(res){
      console.log("经度："+res.longitude);
      console.log("纬度："+res.longitude);
      console.log("速度："+res.longitude);
      console.log("位置的精确度："+res.accuracy);
      console.log("水平精确度："+res.horizontalAccuracy);
      console.log("垂直精确度："+res.verticalAccuracy);
    },
})

运行结果:

6.5.2 选择位置信息

wx.chooseLocation(Object)接口用于在打开的地图中选择位置，用户选择位置后可返回当前位置的名称、地址、经纬度信息。其相关参数如下表所示：

wx.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)接口用于在微信内置地图中显示位置信息，其相关参数如下表所示：

 

示例代码：

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

 运行结果：

 6.6 设备相关API

设备相关的接口用于获取设备相关信息，主要包括系统信息、网络状态、拨打电话及扫码等。主要包括以下5个接口API：

        wx.getSystemInfo(Object)接口、wx.getSystemInfoSync()接口        用于获取系统信息

        wx.getNetworkType(Object)接口        用于获取网络类型

        wx.onNetworkStatusChange(CallBack)接口        用于检测网络状态改变

        wx.makePhoneCall(Object)接口        用于拨打电话

        wx.scanCode(Object)接口        用于扫描二维码

6.6.1 获取系统信息

wx.getSystemInfo(Object)接口、wx.getSystemInfoSync()接口分别用于异步和同步获取系统信息。其相关参数如下表所示：

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)用于获取网络类型，其相关参数如下表所示：

如果wx.getNetworkType()接口被成功调用，则返回网络类型包，有wifi、2G、3G、4G、unknown（Android下不常见的网络类型）、none(无网络。

示例代码：

wx.getNetworkType()({
  success:function(res){
    console.log(res.networkType)
  },
})

运行结果： 

6.6.3 拨打电话

wx. .makePhoneCall(Object)接口用于实现调用手机拨打电话，其相关参数如下表所示：

示例代码：

wx.makePhoneCall()({
  PhoneNumber:'15958742451'
})

运行结果：

6.6.4 扫描代码 

 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)=>true,
  console.log(res)
}
}）
*/

运行结果：

本章小结

 本章主要介绍了小程序的各类核心API，包括网络API、多媒体API、文件API、本地数据及缓存API、位置信息API及设备相关API等。通过对本章的学习，大家应深刻地理解各类API是开发各类小程序的核心。