第六章：API应用

Violet薇。

已于 2024-04-17 10:51:01 修改

阅读量1.8k

点赞数 43

文章标签：微信小程序微信小程序

于 2024-04-11 09:41:06 首次发布

本文链接：https://blog.csdn.net/2301_77998269/article/details/137557813

版权

1.网络API

微信小程序处理的数据通常从后台服务器获取, 再将处理过的结果保存到后台服务器,这就要求微信小程序要有与后台进行交互的能力。微信原生ＡＰＩ接口或第三方ＡＰＩ提供了各类接口实现前后端交互。

网络ＡＰＩ可以帮助开发者实现网络ＵＲＬ访问调用、文件的上传和下载、网络套接字的使用等功能处理。微信开发团队提供了１０个网络ＡＰＩ接口。

1. wx.request（Object）接口用于发起HTTPS请求。
2.wx.uploadFile（Object）接口用于将本地资源上传到后台服务器。

3.wx.downloadFile（Object）接口用于下载文件资源到本地。
4.wx.connectSocket（Object）接口用于创建一个WebSocket连接。
5.wx.sendSocketMessage（Object）接口用于实现通过WebSocket连接发送数据。
6.wx.closeSocket（Object）接口用于关闭WebSocket连接。
7.wx.onSocketOpen（CallBack）接口用于监听WebSocket连接打开事件。
8.wx.onSocketError（CallBack）接口用于监听WebSocket错误。
9.wx.onSocketMessage（CallBack）接口用于实现监听WebSocket接收到服务器的消息事件。
10.wx.onSocketClose（CallBack）接口用于实现监听WebSocket关闭。

在本节, 我们将介绍常用的３个网络ＡＰＩ。

1.1 发起网络请求

ｗｘ.ｒｅｑｕｅｓｔ(Ｏｂｊｅｃｔ) 实现向服务器发送请求、获取数据等各种网络交互操作, 其相关参数如表所示。

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

示例代码如下：

//<!--index.wxml-->
<button type="primary"bindtap ="getbaidutap">获取 HTML 数据</button>
<textarea value ='{{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
})
}
  })
}
})

例如，通过wx.request(0bject)的CET方法获取邮政编码的对应的地址信息。

示例代码：

<!--index.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 >

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

1.2上传文件

ｗｘ.ｕｐｌｏａｄＦｉｌｅ(Ｏｂｊｅｃｔ)接口用于将本地资源上传到开发者服务器, 并在客户端发起一个ＨＴＴＰＳＰＯＳＴ请求, 其相关参数如表所示。

通过ｗｘ.ｕｐｌｏａｄＦｉｌｅ(Ｏｂｊｅｃｔ), 可以将图片上传到服务器并显示。示例代码：

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

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

1.3下载文件

ｗｘ.ｄｏｗｎｌｏａｄＦｉｌｅ(Ｏｂｊｅｃｔ)接口用于实现从开发者服务器下载文件资源到本地, 在客户端直接发起一个ＨＴＴＰＧＥＴ请求, 返回文件的本地临时路径。其相关参数如表所示。

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

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

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

2.多媒体API

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

2.1图片API

图片API实现对相机拍照图片或本地相册图片进行处理，主要包括以下4个API接口：
■ wx.chooseImage（Object）接口用于从本地相册选择图片或使用相机拍照。
■ wx.previewImage（Object）接口用于预览图片。

■ wx.getImageInfo（Object）接口用于获取图片信息。
■ wx.saveImageToPhotosAlbum（Object）接口用于保存图片到系统相册。
1．选择图片或拍照
wx. chooseImage（Object）接口用于从本地相册选择图片或使用相机拍照。拍照时产生的临时路径在小程序本次启动期间可以正常使用，若要持久保存，则需要调用wx. saveFile保存图片到本地。其相关参数如表所示。

若调用成功，则返回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)
}
})

1.预览图片

wx. previewImage（Object）接口主要用于预览图片。参数如图所示。

2.获取图片信息

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

3.保存图片到系统相册

wx. saveImageToPhotosAlbum（Object）接口用于保存图片到系统相册，需要得到用户授权scope.writePhotosAlbum。

2.2录音API

录音API提供了语音录制的功能，主要包括以下两个API接口：
■ wx.startRecord（Object）接口用于实现开始录音。
■ wx.stopRecord（Object）接口用于实现主动调用停止录音。

1.开始录音

ｗｘ.ｓｔａｒｔＲｅｃｏｒｄ(Ｏｂｊｅｃｔ) 接口用于实现开始录音。当主动调用ｗｘ.ｓｔｏｐＲｅｃｏｒｄ(Ｏｂｊｅｃｔ)接口或者录音超过１分钟时, 系统自动结束录音, 并返回录音文件的临时文件路径。若要持久保存, 则需要调用ｗｘ.ｓａｖｅＦｉｌｅ()接口。其相关参数如表所示。

2.停止录音

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

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

2.3音乐播放控制API

音频播放控制ＡＰＩ主要用于对语音媒体文件的控制, 包括播放、暂停、停止及ａｕｄｉｏ组件的控制, 主要包括以下３个ＡＰＩ:

■ ｗｘ.ｐｌａｙＶｏｉｃｅ(Ｏｂｊｅｃｔ) 接口用于实现开始播放语音。

■ ｗｘ.ｐａｕｓｅＶｏｉｃｅ(Ｏｂｊｅｃｔ) 接口用于实现暂停正在播放的语音。

■ ｗｘ.ｓｔｏｐＶｏｉｃｅ(Ｏｂｊｅｃｔ) 接口用于结束播放语音。

1.播放语音

ｗｘ.ｐｌａｙＶｏｉｃｅ(Ｏｂｊｅｃｔ)接口用于开始播放语音, 同时只允许一个语音文件播放, 如果前一个语音文件还未播放完, 则中断前一个语音文件的播放。

示例代码：

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

2.暂停播放

ｗｘ.ｐａｕｓｅＶｏｉｃｅ(Ｏｂｊｅｃｔ) 用于暂停正在播放的语音。再次调用ｗｘ.ｐｌａｙＶｏｉｃｅ(Ｏｂｊｅｃｔ)播放同一个文件时, 会从暂停处开始播放。如果想从头开始播放, 则需要先调用ｗｘ.ｓｔｏｐＶｏｉｃｅ(Ｏｂｊｅｃｔ)。

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

2.4音乐控制API

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

■ ｗｘ.ｐｌａｙＢａｃｋｇｒｏｕｎｄＡｕｄｉｏ(Ｏｂｊｅｃｔ) 接口用于播放音乐。

■ ｗｘ.ｇｅｔＢａｃｋｇｒｏｕｎｄＡｕｄｉｏＰｌａｙｅｒＳｔａｔｅ(Ｏｂｊｅｃｔ) 接口用于获取音乐播放状态。

■ ｗｘ.ｓｅｅｋＢａｃｋｇｒｏｕｎｄＡｕｄｉｏ(Ｏｂｊｅｃｔ) 接口用于定位音乐播放进度。 ■ ｗｘ.ｐａｕｓｅＢａｃｋｇｒｏｕｎｄＡｕｄｉｏ() 接口用于实现暂停播放音乐。

■ ｗｘ.ｓｔｏｐＢａｃｋｇｒｏｕｎｄＡｕｄｉｏ()

■ ｗｘ.ｏｎＢａｃｋｇｒｏｕｎｄＡｕｄｉｏＰｌａｙ(ＣａｌｌＢａｃｋ) 接口用于实现监听音乐播放。

■ ｗｘ.ｏｎＢａｃｋｇｒｏｕｎｄＡｕｄｉｏＰａｕｓｅ(ＣａｌｌＢａｃｋ) 接口用于实现监听音乐暂停。

■ ｗｘ.ｏｎＢａｃｋｇｒｏｕｎｄＡｕｄｉｏＳｔｏｐ(ＣａｌｌＢａｃｋ) 接口用于实现监听音乐停止。

1.播放音乐

ｗｘ.ｐｌａｙＢａｃｋｇｒｏｕｎｄＡｕｄｉｏ(Ｏｂｊｅｃｔ) 用于播放音乐, 同一时间只能有一首音乐处于播放状态，属性如下：

示例代码：

wx.playBackgroundAudio({
dataUrl:'http://bmob-cdn-16488.b0.upaiyun.com/2018/02/01/ti.mp3',
title:'有一天',
coverImgUrl:'http://bmob-cdn-16488.b0.upaiyun.com/2018/02/01/si.jpg',
success:function(res){
console.log(res)
}
})

2.获取音乐播放状态

ｗｘ.ｇｅｔＢａｃｋｇｒｏｕｎｄＡｕｄｉｏＰｌａｙｅｒＳｔａｔｅ(Ｏｂｊｅｃｔ) 接口用于获取音乐播放状态, 参数如下：

接口调用成功后返回的参数如下：

示例代码：

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({
posiyion:30
})

4.暂停音乐播放

ｗｘ.ｐａｕｓｅＢａｃｋｇｒｏｕｎｄＡｕｄｉｏ() 接口用于暂停播放音乐。示例代码：

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（）接口用于停止播放音乐，示例代码：

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中可改变播放图标。示例代码：

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。

示例代码：

//index.js
   Page({
    data:{
     //记录播放状态
    isPlaying:false,
    //记录coverImg,仅当音乐初始时和播放停止时,使用默认的图片。播放中和暂停时，都使用当前音乐的图片
    coverImgchangedImg:false,	
    //音乐内容 
    music:{
    "url":"../images/e e.mp4",
    "title":"盛晓玫-有一天",
    "coverImg":
    "../images/e e.mp4"
      },
    },	
    onLoad:function(){	
      //页面加载时,注册监听事件	
      this.onAudioState();	
      },	
  //点击播放或者暂停按钮时触发
    onAudioTap:function(event){	
    if(this.data.isPlaying){
    //如果在正常播放状态,就暂停,并修改播放的状态
      wx.pauseBackgroundAudio();	
      }else{	
   //如果在暂停状态,就开始播放,并修改播放的状态28 
   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表示播放中54 
  let status = res.status;
   if(status === 1){//音乐的总时长
  let duration = res.duration;//音乐播放的当前位置
  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()执行时触发//仅改变播放状态
  that.setData({isPlaying:false});
  console.log("on pause");	
  });	
  wx.onBackgroundAudioStop(function(){	//当音乐自行播放结束时触发//改变coverImg和播放状态
  that.setData({isPlaying:false,changedImg:false});	
  console.log("on stop");	
  });	
  }
  })


{
  "navigationBarBackgroundColor": "#000000",
  "navigationBarTitleText": "音乐播放器",
  "navigationBarTextStyle": "white",
  "backgroundTextStyle": "dark"
}

<!--index.wxml-->
<view class="container">
<image class="bgaudio"src = "{{changedImg? music.coverImg:'/pages/index/images/ahh.jpg'}}"/>
<view class ="control-view">
<!--使用data-how定义一个0表示快退10秒-->
<image src ="../index/images/cat.jpg"bindtap="onPositionTap"data-how= "0 "/>
<image src = "../index/images/hh.jpg" bindtap = "onAudioTap"/>
<image src ="../index/images/ddd.jpg"bindtap = "onStopTap"/><!--使用data-how定义一个1表示快进10秒-->
<image src ="../index/images/ahh.jpg"bindtap ="onPositionTap"data-how = "1"/>
</view >
</view >

/**index.wxss**/
.bgaudio{
  height:350rpx; width:350rpx;
  margin-bottom:100rpx;
}
  .control-view image{ 
  height:64rpx;
     width:64rpx; 
     margin:30rpx;
}

3.文件API

从网络上下载或录音的文件都是临时保存的, 若要持久保存, 需要用到文件ＡＰＩ。文件ＡＰＩ提供了打开、保存、删除等操作本地文件的能力, 主要包括以下５个ＡＰＩ接口:

■ ｗｘ.ｓａｖｅＦｉｌｅ(Ｏｂｊｅｃｔ) 接口用于保存文件到本地。

■ ｗｘ.ｇｅｔＳａｖｅｄＦｉｌｅＬｉｓｔ(Ｏｂｊｅｃｔ) 接口用于获取本地已保存的文件列表。

■ ｗｘ.ｇｅｔＳａｖｅＦｉｌｅＩｎｆｏ(Ｏｂｊｅｃｔ) 接口用于获取本地文件的文件信息。

■ ｗｘ.ｒｅｍｏｖｅＳａｖｅＦｉｌｅ(Ｏｂｊｅｃｔ) 接口用于删除本地存储的文件。

■ ｗｘ.ｏｐｅｎＤｏｃｕｍｅｎｔ(Ｏｂｊｅｃｔ) 接口用于新开页面打开文档, 支持格式: ｄｏｃ、ｘｌｓ、ｐｐｔ、ｐｄｆ、ｄｏｃｘ、ｘｌｓｘ、ｐｐｔｓ。

1.保存文件

ｗｘ.ｓａｖｅＦｉｌｅ(Ｏｂｊｅｃｔ)用于保存文件到本地, 其相关参数如表所示。

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

示例代码：

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

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

wx. getSaveFileInfo（Object）接口用于获取本地文件的文件信息，此接口只能用于获取已保存到本地的文件，若需要获取临时文件信息，则使用wx. getFileInfo（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;
            wx.getSavedFileInfo({
             filepath:saveFilePath,
              success:function(res){
               console.log(res.size)
            }
          })
        }
       })
     }
   })

4.删除本地文件

wx. removeSaveFile（Object）接口用于删除本地存储的文件，其相关参数如表所示。

从文件列表删除第一个文件，示例代码:

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

5.打开文档

ｗｘ.ｏｐｅｎＤｏｃｕｍｅｎｔ(Ｏｂｊｅｃｔ)接口用于新开页面打开文档, 支持格式有ｄｏｃ、ｘｌｓ、ｐｐｔ、ｐｄｆ、ｄｏｃｘ、ｘｌｓｘ、ｐｐｔｘ, 其相关参数如表所示。

示例代码：

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

4.本地数据及缓存API

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

■ ｗｘ.ｓｅｔＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ) 或ｗｘ.ｓｅｔＳｔｏｒａｇｅＳｙｎｃ(ｋｅｙ,ｄａｔａ) 接口用于设置缓存数据。

■ ｗｘ.ｇｅｔＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ) 或ｗｘ.ｇｅｔＳｔｏｒａｇｅＳｙｎｃ(ｋｅｙ) 接口用于获取缓存数据。

■ ｗｘ.ｒｅｍｏｖｅＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ) 或ｗｘ.ｒｅｍｏｖｅＳｔｏｒａｇｅＳｙｎｃ(ｋｅｙ) 接口用于删除指定缓存数据。

■ ｗｘ.ｃｌｅａｒＳｔｏｒａｇｅ() 或ｗｘ.ｃｌｅａｒＳｔｏｒａｇｅＳｙｎｃ() 接口用于清除缓存数据。其中, 带Ｓｙｎｃ后缀的为同步接口, 不带Ｓｙｎｃ后缀的为异步接口。

4.1保存数据

１.ｗｘ.ｓｅｔＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ) ｗｘ.ｓｅｔＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ)接口将数据存储到本地缓存接口指定的ｋｅｙ中, 接口执行后会覆盖原来ｋｅｙ对应的内容。其参数如表所示。

2.ｗｘ.ｓｅｔＳｔｏｒａｇｅＳｙｎｃ(ｋｅｙ,ｄａｔａ) ｗｘ.ｓｅｔＳｔｏｒａｇｅＳｙｎｃ(ｋｅｙ,ｄａｔａ)是同步接口, 其参数只有ｋｅｙ和ｄａｔａ。

示例代码：

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

4.2获取数据

１.ｗｘ.ｇｅｔＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ) ｗｘ.ｇｅｔＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ) 接口是从本地缓存中异步获取指定ｋｅｙ对应的内容。其相关参数如表所示。

示例代码：

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

２.ｗｘ.ｇｅｔＳｔｏｒａｇｅＳｙｎｃ(ｋｅｙ)ｗｘ.ｇｅｔＳｔｏｒａｇｅＳｙｎｃ(ｋｅｙ)从本地缓存中同步获取指定ｋｅｙ对应的内容。其参数只有ｋｅｙ。

try{
var value = wx.getstorageSync('age')
 if(value){
console.log("获取成功"+value)
} 
catch(e){
console.log("获取失败")
}

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. removeStorageSync（key）
wx. removeStorageSync（key）接口用于从本地缓存中同步删除指定key对应的内容。其参数只有key。示例代码：

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

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

5.位置信息API

小程序可以通过位置信息ＡＰＩ来获取或显示本地位置信息, 小程序支持ＷＧＳ８４和ＧＣｊ０２标准, ＷＧＳ８４标准为地球坐标系, 是国际上通用的坐标系ꎻ ＧＣｊ０２标准是中国国家测绘局制定的地理信息系统的坐标系统, 是由ＷＧＳ８４坐标系经加密后的坐标系, 又称为火星坐标系。默认为ＷＧＳ８４标准, 若要查看位置需要使用ＧＣｊ０２标准。主要包括以下３个ＡＰＩ接口:

■ ｗｘ.ｇｅｔＬｏｃａｔｉｏｎ(Ｏｂｊｅｃｔ) 接口用于获取位置信息。

■ ｗｘ.ｃｈｏｏｓｅＬｏｃａｔｉｏｎ(Ｏｂｊｅｃｔ) 接口用于选择位置信息。

■ ｗｘ.ｏｐｅｎＬｏｃａｔｉｏｎ(Ｏｂｊｅｃｔ) 接口用于通过地图显示位置

5.1获取位置信息

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

wx. getLocation（Object）调试成功后，返回的参数如表所示。

示例代码：

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

5.2选择位置信息

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

wx. chooseLocation（Object）调用成功后，返回的参数如表所示。

示例代码：

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

5.3显示位置API

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.设备相关API

设备相关的接口用于获取设备相关信息，主要包括系统信息、网络状态、拨打电话及主
码等。主要包括以下5个接口API：
■ wx. getSystemInfo(Object)接口、wx.getSystemInfoSyne()接口用于获取系统信息
■ wx. getNetworkType(Object)接口用于获取网络类型。
■ wx.onNetworkStatusChange(CallBack)接口用于监测网络状态改变。
■ wx.makePhoneCall(Object)接口用于拨打电话。
■ wx.scanCode(Object)接口用于扫描二维码。

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

1.获取网络状态

wx. getNetworkType（Object）用于获取网络类型，参数如下

如果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.3拨打电话

wx. makePhoneCall（Object）接口用于实现调用手机拨打电话，参数如下：

示例代码：

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

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) =>{ 
     console.log(res)
   }
  })

Violet薇。

关注

43
点赞
踩
32

收藏

觉得还不错? 一键收藏
1
评论
第六章：API应用

其相关参数如表所示。其相关参数如表所示。１.ｗｘ.ｓｅｔＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ) ｗｘ.ｓｅｔＳｔｏｒａｇｅ(Ｏｂｊｅｃｔ)接口将数据存储到本地缓存接口指定的ｋｅｙ中, 接口执行后会覆盖原来ｋｅｙ对应的内容。■ ｗｘ.ｃｌｅａｒＳｔｏｒａｇｅ() 或ｗｘ.ｃｌｅａｒＳｔｏｒａｇｅＳｙｎｃ() 接口用于清除缓存数据。ｗｘ.ｏｐｅｎＤｏｃｕｍｅｎｔ(Ｏｂｊｅｃｔ)接口用于新开页面打开文档, 支持格式有ｄｏｃ、ｘｌｓ、ｐｐｔ、ｐｄｆ、ｄｏｃｘ、ｘｌｓｘ、ｐｐｔｘ, 其相关参数如表所示。
复制链接

扫一扫