第6章 API 应用总结

cunzaiiii

已于 2024-04-15 19:53:17 修改

阅读量919

点赞数 25

文章标签：微信小程序小程序微信 notepad++ c语言

于 2024-04-12 11:56:54 首次发布

本文链接：https://blog.csdn.net/2301_79474431/article/details/137520711

版权

学习目标

1. 掌握网络 API
2. 掌握多媒体 API
3. 掌握文件 API
4. 掌握本地数据及缓存 API
5. 掌握位置信息 API
6. 掌握设备相关 API

6.1 网络 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 关闭。

6.1.1 发起网络请求

wx. request（Object）实现向服务器发送请求，获取数据等各种网络交互操作。

一个微信小程序同时只能有5个网络请求连接，并且是 HTTPS 请求。

表 6-1 wx. request（Object）相关参数

通过 wx. request（Object）获取百度（https://www.baidu.com）首页的数据。

需要在微信公众平台小程序服务器配置中的 request 合法域名中添加 “https://www.baidu.com”

示例代码如下：

<!--liuzhang.wxml-->
<text></text>
<button type="primary" bindtap="getbaidutap"> 获取 HTML 数据 </button>
<textarea value='{{html}}'auto-heightmaxlength='0'></textarea>

<!--liuzhang.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
})
}
  })
}
})

运行结果：

通过 wx. request（Object）的 GET 方法获取邮政编码对应的地址信息。

示例代码如下：

<!--pages/liuzhang/liuzhang.wxml-->
<text></text>
<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 >

<!--liuzhang.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.reasonllres.data.reason,//错误原因分析
  error_code:res.data.error_code
  })
  }
  }
  })
  }
  }
  })

运行结果：

6.1.2 上传文件

wx. uploadFile（Object）接口用于将本地资源上传到开发者服务器，并在客户端发起一个 HTTPS POST 请求。

表 6-2 wx. uploadFile（Object）相关参数

通过 wx. uploadFile（Object），可以将图片上传到服务器并显示。

示例代码如下：

<!--pages/liuzhang/liuzhang.wxml-->
<text></text>
<button type="primary" bindtap="uploadimage"> 上传图片 </button ><image src="../image/q.jpg" mode="widthFix"/>

<!--liuzhang.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.statusCodel=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();
  }
  })
  }
  }
  }
  })

运行结果：

6.1.3 下载文件

wx. downloadFile（Object）接口用于实现从开发者服务器下载文件资源到本地，在客户端直接发起一个 HTTPGET 请求，返回文件的本地临时路径。

表 6-3 wx. downloadFile（Object）相关参数

通过 wx. downloadFile（Object）实现从服务器中下载图片，后台服务采用WAMP软件在本机搭建。

示例代码如下：

<!--liuzhang.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
        })
      }
    })
  }
 })

<!--liuzhang.wxml-->
<button type="primary" bind:tap="downloadimge"> 下载图像 </button>
<image src="{{img}}" mode='widthFix'style = "width:90%;height:500px"></image>

运行结果：

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 保存图片到本地。

表 6-4 wx. chooseImage（Object）相关参数

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

示例代码如下：

<!--liuzhang.js-->
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）接口主要用于预览图片。

表 6-5 wx. previewImage（Object）相关参数

3. 获取图片信息

wx. getImageInfo（Object）接口用于获取图片信息。

表 6-6 wx. getImageInfo（Object）相关

示例代码如下：

<!--liuzhang.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. saveImageToPhotosAlbum（Object）接口用于保存图片到系统相册，需要得到用户授权scope.writePhotosAlbum。

表 6-7 wx. saveImageToPhotosAlbum

6.2.2 录音 API

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

wx.startRecord（Object）接口用于实现开始录音。

wx.stopRecord（Object）接口。

用于实现主动调用停止录音。

1. 开始录音

wx. startRecord（Object）接口用于实现开始录音。当主动调用 wx.stopRecord（Object）接口或者录音超过1分钟时，系统自动结束录音，并返回录音文件的临时文件路径。若要持久保存，则需要调用 wx. saveFile（）接口。

表 6-8 wx. startRecord（Object）相关参数

2. 停止录音

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

示例代码如下：

<!--liuzhang.js-->
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）接口用于开始播放语音，同时只允许一个语音文件播放，如果前一个语音文件还未播放完，则中断前一个语音文件的播放。

表 6-9 wx. playVoice（Object）相关参数

示例代码如下：

<!--liuzhang.js-->
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）。

示例代码如下：

<!--liuzhang.js-->
wx.startRecord({
success: function(res){
var tempFilePath = res.tempFilePath
wx.playVoice({ filePath:tempFilePath
})
 
setTimeout(function(){
//暂停播放
wx.pauseVoice()},5000)
}
})

3. 结束播放

wx. stopVoice（Object）用于结束播放语音。

示例代码如下：

<!--liuzhang.js-->
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）用于播放音乐，同一时间只能有一首音乐处于播放状态。

表 6-10 wx. playBackgroundAudio（Object）相关参数

示例代码如下：

<!--liuzhang.js-->
wx.playBackgroundAudio({
dataUrl:'http://bmob - cdn -16488.b0.upaiyun.com/2018/02.
09 /117e4a1b405195b18061299e2de89597.mp3'，
title:'有一天'，
coverImgUrl:'http://bmob -cdn - 16488.b0.upaiyun.com/2018/
02 /09/f604297140c9681880cc3d3e581f7724.jpg',
success:function(res){
console.log(res)/成功返回playBackgroundAudio:ok
})

2. 获取音乐播放状态

wx.getBackgroundAudioPlayerState（Object）接口用于获取音乐播放状态。

表 6-11 wx. getBackgroundAudioPlayerState（Object）相关参数

表 6-12 wx. getBackgroundAudioPlayerState 相关参数

示例代码如下：

<!--liuzhang.js-->
wx.getBackgroundAudioPlayerState({
success:function(res){
var status = res.status
var dataUrl= res.dataUrl
var currentPosition= res.currentPosition
var duration = res.duration
var downloadPercent= res.downloadPercent
console.log("播放状态:"+status)
console.log("音乐文件地址:"+ dataUrl)
console.log("音乐文件当前播放位置:"+currentPosition) console.log("音乐文件的长度:"+duration) console.log("音乐文件的下载进度:"+status)
})

3. 控制音乐播放进度

wx. seekBackgroundAudio（Object）接口用于控制音乐播放进度。

表 6-13 wx. seekBackgroundAudio（Object）相关参数

示例代码如下：

<!--liuzhang.js-->
wx.seekBackgroundAudio(
position:30
1)

4. 暂停播放音乐

wx. pauseBackgroundAudio（）接口用于暂停播放音乐。

示例代码如下：

<!--liuzhang.js-->
wx.playBackgrondAudio{
dataUrl:'/music/a.mp3',
title:'我的音乐',
coverImgUrl:'/images/poster.jpg',
success:function(){
console.log('开始播放音乐了');
}
});
setTimeout(function(){
console.log('暂停播放');
wx.pauseBackgroundAudio();
},5000);

5. 停止播放音乐

wx. stopBackgroundAudio（）接口用于停止播放音乐。

示例代码如下：

<!--liuzhang.js-->
wx.playBackgrondAudio{
dataUrl:'/music/a.mp3',
title:'我的音乐',
coverImgUrl:'/images/poster.jpg',
success:function(){
console.log('开始播放音乐了');
}
});
setTimeout(function(){
console.log('暂停播放');
wx.stopBackgroundAudio();
},5000);

6. 监听音乐播放

wx. onBackgroundAudioPlay（CallBack）接口用于实现监听音乐播放，通常被 wx. playBack-groundAudio（Object）方法触发，在 CallBack 中可改变播放图标。

示例代码如下：

<!--liuzhang.js-->
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（Object）方法导致播放位置等于音乐总时长时触发。在 CallBack 中可以改变播放图标。

9. 案例展示

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

示例代码如下：

// <!--liuzhang.js-->
Page({
  data:{
  isPlaying:false,
  coverImgchangedImg:false,	
  music:{
  "url":"../image/hjk.jpg",
  "title":"队长-哪里都是你",
  "coverImg":
  "../image/hjk.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");	
});	
}
})

<!--pages/liuzhang/liuzhang.wxml-->
<view class="container">
<image class="bgaudio"src = "{{changedImg? music.coverImg:'../image/q.jpg'}}"/>
<view class ="control-view">
<image src ="../image/hjk.jpg" bindtap="onPositionTap" data-how= "0 "/>
<image src = "../image/{{isPlaying?'pause':'q'}}.jpg" bindtap = "onAudioTap"/>
<image src ="../image/lyt.jpg"bindtap = "onStopTap"/>
<image src ="../image/dc.png" bindtap ="onPositionTap" data-how = "1"/>
</view >
</view >

/* pages/liuzhang/liuzhang.wxss */
.bgaudio{
  height:480rpx;
  width:540rpx;
  margin-bottom:100rpx;
}
  .control-view image{ 
  height:100rpx;
     width:100rpx; 
     margin:40rpx;
}

运行结果：

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）用于保存文件到本地。

表 6-14 wx. saveFile（Object）相关参数

示例代码如下：

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到当前时间的秒数）文件列表。

表 6-15 wx. getSavedFileList（Object）相关参数

示例代码如下：

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

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

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

表 6-16 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）接口用于删除本地存储的文件。

表 6-17 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）接口用于新开页面打开文档，支持格式有doc、xls、ppt、pdf、docx、xlsx、pptx。

表 6-18 wx. openDocument（）相关参数

示例代码如下:

 
wx.downloadFile({
  url:"../image/pp.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.getStorage（Object）或wx.getStorageSync（key）接口用于获取缓存数据。

wx.removeStorage（Object）或wx.removeStorageSync（key）接口用于删除指定缓存数据。

wx.clearStorage（）或wx.clearStorageSync（）接口用于清除缓存数据。其中，带Sync后缀的为同步接口，不带Sync后缀的为异步接口。

6.4.1 保存数据

1. wx. setStorage（Object）接口将数据存储到本地缓存接口指定的key中，接口执行后会覆盖原来key对应的内容。

表 6-19 wx. setStorage（Object）相关参数

示例代码如下:

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

运行结果：

2. wx. setStorageSync（key, data）是同步接口，其参数只有 key 和 data。

示例代码如下:

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

6.4.2 获取数据

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

表 6-20 wx. getStorage（Object）相关参数

示例代码如下:

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

2. 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）接口用于从本地缓存中异步移除指定key。

表 6-21 wx. removeStorage（Object）相关参数

示例代码如下：

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

运行结果：

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

示例代码如下：

try {
wx.removeStorageSync('name')
} catch(e){
//Do something when catch error
}

6.4.4 清空数据

wx. clearStorage（）

接口用于异步清理本地数据缓存，没有参数。

示例代码如下：

//js
wx.getStorageSync({
  key:'name',
  success:function(res){
    wx.clearStorage()
  },
})

wx.clearStorageSync()

接口用于同步清理本地数据缓存。

示例代码如下:

//js
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) 接口用于获取当前用户的地理位置、速度，需要用户开启定位功能，当用户离开小程序后，无法获取当前的地理位置及速度，当用户点击“显示在聊天顶部”时，可以获取到定位信息。

表 6-22 wx. getLocation（Object）相关参数

示例代码如下：

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

6.5.2 选择位置信息

wx.chooseLocation(Object) 接口用于在打开的地图中选择位置，用户选择位置后可返回当前位置的名称、地址、经纬度信息。

表 6-23 wx. getLocation（Object）成功返回相关信息

示例代码如下：

//js
wx.chooseLocation({
  success:function(res){
    console.log("位置的名称" + res.name);
    console.log("位置的地址" + res.address);
    console.log("位置的经度" + res.longitude);
    console.log("位置的纬度" + res.latitude);
  },
})

6.5.2 显示位置信息

wx.openLocation(Object)

接口用于在微信内置地图中显示位置信息。

示例代码如下：

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

6.6 设备相关 API

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

wx.getSystemInfo(Object) 接口、wx.getSystemInfoSync()

接口用于获取系统信息。

wx.getNetworkType(Object)

接口用于获取网络类型。

wx.onNetworkStatusChange(CallBack)

接口用于监测网络状态改变。

wx.makePhoneCall(Object)

接口用于拨打电话。

wx.scanCode(Object)

接口用于扫描二维码。

6.7 获取系统信息

wx.getSystemInfo(Object) 、wx.getSystemInfoSync()

接口分别用于异步和同步获取系统信息。

wx.getSystemInfo()，wx.getSystemInfoSync()

接口调用成功后, 返回系统相关信息。

示例代码如下：

//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.8 网络状态

1. 获取网络状态

wx.getNetWorkType(Object) 用于获取网络类型，其相关参数如表所示。

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

示例代码如下：

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

运行结果：

２.监听网络状态变化

wx.onNetworkStatusChange (CallBack) 接口用于监听网络状态变化，当网络状态变化时，返回当前网络状态类型及是否有网络连接。

示例代码如下：

//js
wx.onNetworkStatusChange(function(res){
  console.log("网络是否连接" + res.isConnected)
  console.log("变化后的网络类型" + res.networkType)
})

6.9 拨打电话

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

示例代码如下：

//js
wx.makePhoneCall({
  phoneNumber: '18279548947',
})

运行结果：

7.0 扫描二维码

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

示例代码如下：

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

运行结果：