第六章总结

第六章 API应用

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)接口用于实现监听WebSocket关闭。

在本节,我们将介绍常用的3个网络API。

6.1.1 发起网络请求

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

08431b43bfdf4111b232dc852c51beb7.jpeg

        例如,通过wx. request(Object)获取百度(https://www.baidu.com)首页的数据。(需要在微信公众平台小程序服务器配置中的request合法域名中添加“https://www.baidu.com”。)

示例代码如下:

//baidu.wxml
<buttontype="primary"bindtap="getbaidutap">获取HTML数据</button >
<textareavalue='{{html}}'auto-heightmaxlength='0'> </textarea>

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

 5cf5071eba0245c0a38afa49f6e02dfd.png

例如,通过wx. request(Object)的GET方法获取邮政编码对应的地址信息。
示例代码如下:

//postcode.wxml
<view>邮政编码:</view>
<inputtype="text"bindinput="input"placeholder='6位邮政编码'/>
<buttontype="primary"bindtap="find">查询</button>
<blockwx:for="{{address}}">
<blockwx:for="{{item}}">
<text> {{item}} </text>
</block>
</block >

//.js
//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':'0ff9bfccdf147476e067de994eb5496e'//第三方提供
    },
      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})
      }}})}}})

 8b26d253c5e24f389e44efb322e8903e.png

例如,通过wx. request(Object)的POST方法获取邮政编码对应的地址信息。

//postcode.wxml
<view>邮政编码:</view>
< inputtype = "text "bindinput = "input "placeholder ='6位邮政编码'/>< buttontype = "primary "bindtap ="find">查询</button ><blockwx:for="{{address}}" >
<blockwx: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':'0ff9bfccdf147476e067de994eb5496e'//第三方提供},
header: {
content -type':'application/x-www-form -urlencoded'},
method:'posT',//方法为 POST 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 llres.data.reason,//错误原
因分析
error_code:res.data.error_code})

})

6.1.2 上传文件

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

b24b23b97d7947e9be5a8e550c6b32bd.jpeg

通过wx. uploadFile(Object),可以将图片上传到服务器并显示。

示例代码如下:

//upload.wxml
<buttontype="primary"bindtap="uploadimage">上传图片</button>
<imagesrc="{{img}}"mode="widthFix"/>

//upload.js 
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(){
  //隐藏Toast
  wx.hideToast();
  }})}}})

 cfa7399558b84f10a4857f6239838c73.png

6.1.3 下载文件

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

299d108bfd3a407a9ab95f62ff3cc0f9.jpeg

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

//downloadFile.wxml
<buttontype = "primary "bindtap ='downloadimage'>下载图像</button ><imagesrc ="{{img}}"mode = 'widthFix'style =" width:90%;height:500px"> </image>
//downloadFile.js Page({ data: { img:null},
downloadimage:function(){ var that = this;
wx.downloadFile({
url:"http://localhost/1.jpg",//通过WAMP软件实现 success:function(res){
console.log(res) that.setData({
img:res.tempFilePath
})
})
})

 2bb657d2ac2142c0a69b41bc1d2c022a.png

6.2 多媒体API

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

6.2.1 图片API

     图片API实现对相机拍照图片或本地相册图片进行处理,主要包括以下4个API接口:

  wx.chooseImage(Object)接口用于从本地相册选择图片或使用相机拍照。
  wx.previewImage(Object)接口 用于预览图片。
  wx.getImageInfo(Object)接口 用于获取图片信息。
  wx.saveImageToPhotosAlbum(Object)接口 用于保存图片到系统相册。


 1.选择图片或拍照


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

5b40d3983c884095afabd1bfae91f966.jpeg

      若调用成功,则返回tempFilePaths和tempFiles, 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.tempFiles; console.log(tempFilePaths) console.log(tempFiles)

2.预览图片


wx. previewImage(Object)接口主要用于预览图片,其相关参数

5703474dda1e40d8ab3483d8a06b4a91.jpeg

示例代码如下

wx.previewImage({//定义显示第二张
current:" http://bmob - cdn - 16488.b0.upaiyun.com/2018/02 /057
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)接口用于获取图片信息,其相关参数如表所示。

ba56c51d078d411996d9bc35bbd489c0.jpeg

示例代码如下

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。其相关参数如表所示。

ffff1a6c01404bd196276aaa02511aa3.jpeg

示例代码如下

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

})

6.2.2 录音API

录音API提供了语音录制的功能,主要包括以下两个API接口 


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


1.开始录音

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

f159d9c95c104f3f8c6eddb3d80d04f2.jpeg

2.停止录音

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

示例代码如下

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

 

6.2.3 音频播放控制 API

      音频播放控制API主要用于对语音媒体文件的控制,包括播放、暂停、停止及audio组件的控制,主要包括以下3个API:
■ wx.playVoice(Object)接口用于实现开始播放语音。
■ wx.pauseVoice(Object)接口用于实现暂停正在播放的语音。
■ wx.stopVoice(Object)接口用于结束播放语音。


1.播放语音

wx. playVoice(Object)接口用于开始播放语音,同时只允许一个语音文件播放,如果前一个语音文件还未播放完,则中断前一个语音文件的播放。其相关参数如表所示。

ebe375e84aca4f0881027477de801878.jpeg

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

2.暂停播放

wx. pauseVoice(Object)用于暂停正在播放的语音。再次调用wx.playVoice(Object)播放同一个文件时,会从暂停处开始播放。如果想从头开始播放,则需要先调用wx. stopVoice(Object)。

wx.startRecord({
success: function(res){
var tempFilePath = res.tempFilePath
wx.playVoice({ filePath:tempFilePath
})

setTimeout(function(){
//暂停播放
wx.pauseVoice()},5000)

)

3.结束播放

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

wx.startRecord({
success: function(res){
var tempFilePath =res.tempFilePath wx.playVoice({
filePath:tempFilePath})

setTimeout(function(){ wx.stopVoice()},5000)
})

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)用于播放音乐,同一时间只能有一首音乐处于播放状态,其相关参数如表所示。

15329d1b5ce74f3b98c8c37abecdf01c.jpg

 2.获取音乐播放状态

wx. getBackgroundAudioPlayerState(Object)接口用于获取音乐播放状态,其相关参数如表所示

e7008a54fb8d4ead8960e7f7eda5abf7.jpg

 接口调用成功后返回的参数如表所示。

6969919bc68d4314be52efe456b48ee5.jpg

 3.控制音乐播放进度

wx. seekBackgroundAudio(Object)接口用于控制音乐播放进度,其相关参数如表所示。

40052f5dc24d44c3ad53b42befc880c9.jpg

 4.暂停播放音乐

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

示例代码如下

0c37a8d43eeb4da39b0874c7fd2fdefa.jpg

 5.停止播放音乐

wx. stopBackgroundAudio()接口用于停止播放音乐。
示例代码如下:

f114f69a97fb43b1bbc4d82c5e21f244.jpg

 6.监听音乐播放
wx. onBackgroundAudioPlay(CallBack)接口用于实现监听音乐播放,通常被wx. playBack-groundAudio(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。实际效果如图所示。

5161be9eff8b418a8e10318a4043296a.jpg

music. wxml的代码如下:
<viewclass="container">
< imageclass = " bgaudio"src = "{{changedImg? music.coverImg:'/im- age/background.png'}}"/>
<viewclass ="control -view">
<!--使用data-how定义一个0表示快退10秒-->
<imagesrc ="/image/pre.png "bindtap="onPositionTap"data -how= "0 "/>< imagesrc = "/image/{{isPlaying?'pause':'play'}} .png " bindtap = " onAudioTap"/>
<imagesrc ="/image/stop.png"bindtap = "onStopTap"/><!--使用data-how定义一个1表示快进10秒-->
<imagesrc ="/image/next.png "bindtap ="onPositionTap"data -how = "1"/>< /view >< /view >
music. wxss代码如下:
.bgaudio{
height:350rpx; width:350rpx;
margin -bottom:100rpx;

.control -viewimage{ height:64rpx; width:64rpx; margin:30rpx;

 

music.json
{}
Page({
data:{
 //记录播放状态
 isPlaying:false,
 /记录coverImg,仅当音乐初始时和播放停止时,使用默认的图片。播放中和暂停时,都使用当前音乐的图片
 coverImg
	changedImg:false,	
 /音乐内容
 music: {
"url":
 "http://bmob-cdn-16488.b0 .upaiyun.com/2018/02 /09/117e4a1b405195b18061299e2de89597.mp3",
 "title":"盛晓玫-有一天",
"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.title,	
	coverImgUrl:music.coverImg	
	})	

	//点击即可停止播放音乐	
	onStopTap:function(){	
 let that = this;
	wx.stopBackgroundAudio({	
	success:function(){	
	//改变coverImg和播放状态	
	that.setData({ isPlaying:false,changedImg:false});

	})		},	
 //点击“快进10秒”或者“快退10秒”时,触发
	onPositionTap:function(event){	
 let how = event.target.dataset.how;
 /获取音乐的播放状态
	wx.getBackgroundAudioPlayerState({	
	success:function(res){	
	//仅在音乐播放中,快进和快退才生效	
//音乐的播放状态,1表示播放中
 let status = res.status;
 if(status === 1){
//音乐的总时长
 let duration = res.duration;58/音乐播放的当前位置
 let currentPosition = res.currentPosition;
 if(how ==="0"){
//注意:快退时,当前播放位置快退10秒小于0时,直接设置position为1;否则,直接减去10秒
 //快退到达的位置
. let position = currentPosition - 10;
 if(position <0){
	position =1;	

	//执行快退	
	wx.seekBackgroundAudio({	
	position: position	
	});	
 /给出一个友情提示,在实际应用中,请删除!!!
	wx. showToast({title:"快退10s",duration:500});	

if(how === "1"){
 /注意:快进时,当前播放位置快进10秒后大于总时长时,直接设置position 为总时长减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(){	
//当wx.playBackgroundAudio()执行时触发101 //改变coverImg和播放状态
	that.setData({ isPlaying:true,changedImg:true});	
console.log("on play");	
	});	
	wx.onBackgroundAudioPause(function(){	
//当wx.pauseBackgroundAudio()执行时触发107 //仅改变播放状态
	that.setData({isPlaying:false});
	console.log("on pause");	
	});	
	wx.onBackgroundAudioStop(function(){	
//当音乐自行播放结束时触发113/改变coverImg和播放状态
	that.setData({isPlaying:false,changedImg:false});	
	console.log("on stop");	
	});	

}
	})

 效果如图

5161be9eff8b418a8e10318a4043296a.jpg

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)用于保存文件到本地,其相关参数如表所示。

d7e86ccc5709435abdc5054c7fd10615.jpg

 

代码如下

saveImg:function(){
  wx.chooseImage({
    count:1,
    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)接口用于获取本地已保存的文件列表,如果调用成功,则返回文件的本地路径、文件大小和文件保存时的时间戳(从1970/01/01 08: 00: 00到当前时间的秒数)文件列表。其相关参数如表所示。

16f2e6d94ef64406994ab7f2ceb84eb7.jpg

 

代码如下

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

 3.获取本地文件的文件信息
      wx. getSaveFileInfo(Object)接口用于获取本地文件的文件信息,此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,则使用wx. getFileInfo(Object)接口。

其相关参数如表

d56751ad6c8f432fa161aaba6a5603c1.jpg

 

示例代码如下

wx.chooseImage({
    count:1,//默认值为9
    sizeType:['original','compressed'],
    sourceType:['album','camera'],
    success:function(res){
      var tempFilePaths=res.tempFilePaths[0]
    wx.saveFile({
     tempFilePath:tempFilePaths,
          filePath:saveFilePath,
          success:function(res){
            var saveFilePath=res.saveFilePath;
            wx.getSavedFileInfo({
              filePath:saveFilePath,
              success:function(res){
            console.log(res.size)
          }
        })
      }
    })
  }
  })

 4.删除本地文件
wx. removeSaveFile(Object)接口用于删除本地存储的文件,

其相关参数如表所示。

be6e51a57a75413e90b096c852fc41c3.jpg

 

 

wx.getSavedFileList({
      success:function(res){
        if(res.fileList.length>0){
          wx.removeSavedFile({
            filePath:res.fileList[0].filePath,
            complete:function(res){
              console.log(res)
            }
          })
        }
      }
    })

 d0e6fb5d926e43118af381c89b4ce85b.png

5.打开文档
wx. openDocument(Object)接口用于新开页面打开文档,支持格式有doc、xls、ppt、pdf、docx、xlsx、pptx,其相关参数如表所示。

4ccd15de6fa64d5a88216523bdc1a56d.jpg

 

 
wx.downloadFile({
  url:"../images/tu2.png",
  success:function(res){
    var tempFilePath=res.tempFilePath;
    wx.openDocument({
      filePath: tempFilePath,
      success:function(res){
        console.log("打开成功")
      }
    })
  }
  })

 

6.4 本地数据缓存API


小程序提供了以键值对的形式进行本地数据缓存功能,并且是永久存储的,但最大不超过10 MB,其目的是提高加载速度。数据缓存的接口主要有4个:


■ wx.setStorage(Object)或wx.setStorageSync(key, data)接口 用于设置缓存数据。              ■ wx.clearStorage()或wx.clearStorageSync()接口 用于清除缓存数据。
■ wx.getStorage(Object)或wx.getStorageSync(key)接口 用于获取缓存数据。
■ wx.removeStorage(Object)或wx.removeStorageSync(key)接口 用于删除指定缓存数据。


其中,带Sync后缀的为同步接口,不带Sync后缀的为异步接口。

6.4.1 保存数据

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

4519676a2ebe480ab846d74eee9af324.jpg

 

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

2. wx. setStorageSync(key, data)
wx. setStorageSync(key, data)是同步接口,其参数只有key和data。
示例代码如下

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

 

6.4.2 获取数据 

1. wx. getStorage(Object)
       wx. getStorage(Object)接口是从本地缓存中异步获取指定key对应的内容。

其相关参数如表所示。

c71d672047e24b728f506aeb5baefa51.jpg

 

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。

其相关参数如表所示。

76108a836628469ba99c58002293ee7a.jpg

 

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和GCj02标准,WGS84标准为地球坐标系,是国际上通用的坐标系;GCj02标准是中国国家测绘局制定的地理信息系统的坐标系统,是由WGS84坐标系经加密后的坐标系,又称为火星坐标系。默认为WGS84标准,若要查看位置需要使用GCj02标准。主要包括以下3个API接口:
■ wx.getLocation(Object)接口用于获取位置信息。
■ wx.chooseLocation(Object)接口 用于选择位置信息。
■ wx.openLocation(Object)接口用于通过地图显示位置。

6.5.1 获取位置信息

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

850aa7ac0e0842c2900936bb19fbaf05.png

  wx. getLocation(Object)调试成功后,返回的参数如表所示。

6f5e26d607f14424af15ae8d01922493.png

示例代码如下

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

6.5.2 获取位置信息 

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

3c559928859741af8b4887913ed86a35.png

wx. chooseLocation(Object)调用成功后,返回的参数如表所示。

608b8756034f4be7a5dee339729500d2.png

6.5.3 显示位置信息

wx.openLocation(Object)接口用于在微信内置地图中显示位置信息。

2bc97e70b73d4ca8a9b63ba1c620cfa9.png

a3c43120eaf14e8ab391843a30232fe0.png

示例代码如下

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(Object)接口 用于获取网络类型。
■ wx.onNetworkStatusChange(CallBack)接口 用于监测网络状态改变。
■ wx.makePhoneCall(Object)接口 用于拨打电话。                                                                     ■ wx.scanCode(Object)接口 用于扫描二维码。

6.6.1 获取系统信息

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

8011b72d763a420491f2a66feeb33461.png

       wx. getSystemInfo()接口或wx.getSystemInfoSync()接口调用成功后,返回系统相关信息,如表所示。

70a0d2a70c644dc9ba1fb0944614ad2e.png 示例代码如下

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

a1bc4ef0b96041f287f15274e39c3a11.png

6.6.2 网络状态 

1.获取网络状态
wx. getNetworkType(Object)用于获取网络类型,其相关参数如表所示。

1380ae8416e94bc6b6fae568f9d5ee9c.png

如果wx. getNetworkType()接口被成功调用,则返回网络类型包,有wifi、2G、3G、4G、unknown(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(Object)接口用于实现调用手机拨打电话,其相关参数如表所示。

e23839410eab4f498a7d0fc37c35dcd7.jpeg
 示例代码如下

wx.makePhoneCall({
phoneNumber:'18092585093'//需要拨打的电话号码
})

6.6.4 扫描二维码

       wx. scanCode(Object)接口用于调起客户端扫码界面,扫码成功后返回相应的内容,其相关参数如表所示。

8a1273c9d6c54116a2fa9975bddaa46a.jpeg

扫码成功后,返回的数据如表所示。

8e833059c1904d2d8b8ad4c39a9b0c62.jpeg

示例代码如下

//允许从相机和相册扫码
 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)
   }
  })

6.7 本章小结

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

 

  • 54
    点赞
  • 38
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值