第六章总结

superstarns

已于 2024-04-17 19:55:31 修改

阅读量702

点赞数 18

文章标签： eclipse

于 2024-04-11 11:03:40 首次发布

本文链接：https://blog.csdn.net/superstarns/article/details/137607300

版权

API应用
一.网络API
微信小程序处理的数据通常从后台服务器获取，再将处理过的结果保存到后台服务器，这就要求微信小程序要有与后台进行交互的能力。

网络API可以帮助开发者实现网络URL访问调用、文件的上传和下载、网络套接字的使用等功能处理。

1 发起网络请求
wx.request(0bject)实现向服务器发送请求、获取数据等各种网络交互操作，其相关参数如表所示。

通过 wx.requesl(0bject)获取百度(https:// www,baidu.com)首页的数据。

代码：

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

2 上传文件

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

代码：

 
Page({
data:{
  img:null,
},
uploadumage:function(){
  var that=this;
  //选择图片
  wx.chooseImage({
    success:function(res){
      var tempFilePaths=res.tempFilePaths
      upload(that.tempFilePaths);
    }
  })
  //显示toast提示消息
function upload(page,path){
  wx.showToast({
    icon:'loading',
    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
      })
    },
    //隐藏Toast
    complete:function(){
      wx.hideToast();
    }
  })
  }
}
})

3 下载文件

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

代码：

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

2 多媒体 API

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

1.选择图片或拍照

wx.chooselmage(Object)接口用于从本地相册选择图片或使用相机拍照。

代码：

 
Page({
  wx.chooseImage({
    //默认值为9
    count:2,
    //可以指定是原图还是压缩图，默认二者都有
    sizeType:['original','compressed'],
    //可以指定来源是相册还是相机，默认二者都有
    sourceType:['album','camera'],
    success:function(res){
    //返回选定照片的本地文件路径列表，tempFilePath可以作为img标签的sec属性来显示图片
    var tempFilePaths=res.tempFilePaths
    var tempFiles=res.tempFiles
    console.log(tempFilePaths)
    console.log(tempFiles)
  }
  })
})

2.预览图片

wx.previewlmage(0bject)接口主要用于预览图片

代码：

page({
wx.previewImage({
    current:"http://bomob-cdn-16488.b0.upaiyun.com/2018/02/05/2.png",
    urls: ["http://bomob-cdn-16488.b0.upaiyun.com/2018/02/05/1.png",
           "http://bomob-cdn-16488.b0.upaiyun.com/2018/02/05/2.png",
           "http://bomob-cdn-16488.b0.upaiyun.com/2018/02/05/3.png"
  ],
  })
})

.获取图片信息

wx.getlmagelnfo(Object)接口用于获取图片信息

代码：

  wx.chooseImage({
    success:function(res){
      wx.getImageInfo({
        src: res.tempFilePaths[0],
        success:function(e){
          console.log(e.width)
          console.log(e.height)
        }
      })
    },
  })

4.保存图片到系统相册

wx.savelmageToPhotosAlbum(Objee)接日用于保存图片到系统相册

代码：

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

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

（1）wx.stariRecord(Object)接口用于实现开始录音。

（2）wx.stopRecord(Objeet)接日用于实现主动调用停止录音.

1.开始录音
wx. startRecord(0bject)接口用于实现开始录音。

2.停止录音

ws.slopReeord(Objeet)接口用于实现主动调用停止录音.

代码：

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

四.音频播放控制API
音频播放控制API主要用于对语音媒体文件的控制，包括播放、暂停、停止及audio组件的控制.

1.播放语音
wx.playVoice(Object)接口用于开始播放语音，同时只允许一个语音文件播放，如果前一个语音文件还未播放完，则中断前一个语音文件的播放。

代码：

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

2.暂停播放

wx.pauseVoice(0bject)用于暂停正在播放的语音。

代码：

  //结束播放
  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)
    }
  })

4 音乐播放控制API
音乐播放控制API主要用于实现对背景音乐的控制，音乐文件只能是网络流媒体，不能是本地音乐文件。

1.播放音乐
wx.playBackgroundudio(Object)用于播放音乐，同一时间只能有一首音乐处于播放状态

2.获取音乐播放状态

wx. getBackgroundAudioPlayerState(Object)接口用于获取音乐播放状态

3.控制音乐播放进度

wx,seekBackgroundAudio(0bject)接口用于控制音乐播放进度

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

5.停止播放音乐
wx.stopBackgroundAudio()接口用于停止播放音乐

6.监听音乐播放
wx. onBackgroundAudioPlay(CallBack)接口用于实现监听音乐播放，通常被 wx. playBackgroundAudio(Object)方法触发，在CallBack中可改变播放图标

7.监听音乐暂停
wx.onBackgroundAudioPause(CallBack)接口用于实现监听音乐暂停，通常被wx.pauseBackgroundAudio()方法触发。

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

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

代码：

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

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

wx.saveFile(Object)接口：用于保存文件到本地，主要包括以下5个API接口
wx.getSavedFileList(Object)接口：用于获取本地已保存的文件列表
wx.getSaveFileInfo(Object)接口：用于获取本地文件的文件信息
wx.removeSaveFile(Object)接口：用于删除本地存储的文件
wx.openDocument(Object)接口：用于新开页面打开文档，支持格式：doc、xls、 2. 获取ppt、pdf、docx、xlsx、ppts

保存文件：

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

部分示例代码如下：

// pages/chapter06/fileAPI/saveFile/saveFIle.js
Page({
  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)
          }
        })
      }
    })
  }
})

获取本地文件列表：

wx.getSavedFileList(Object)接口用于获取本地已保存的文件列表，如果调用成功，则返回文件的本地路径、文件大小和文件保存时的时间戳文件列表，其相关参数如表所示：

示例代码如下：

// pages/chapter06/fileAPI/getSavedFilePath/getSavedFilePath.js
Page({
  getSavedFileList:function(){
    wx.getSavedFileList({
      success:function(res){
        that.setData({
          fileList:res.fileList
        })
      }
    })
  }
})

获取本地文件的文件信息：

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

实例代码如下：

// pages/chapter06/fileAPI/getSaveFileInfo/getSaveFileInfo.js
Page({
  getSaveFileInfo:function(){
    wx.chooseImage({
      count: 1,
      sizeType:['compressed','original'],
      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);
              }
            })
          }
        })
      }
    })
  }
})

删除本地文件：

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

从文件列表删除第一个文件，示例代码如下：

// pages/chapter06/fileAPI/removeFile/removeFile.js
Page({
  removeFile:function(){
    wx.getSavedFileList({
      success:function(res){
        if(res.fileList.length > 0){
          wx.removeSavedFile({
            filePath: res.fileList[0].filePath,
            complete:function(res){
              console.log(res)
            }
          })
        }
      }
    })
  }
})

打开文档：

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

示例代码如下：

// pages/chapter06/fileAPI/openDocument/openDocument.js
Page({
  openDocument:function(){
    wx.downloadFile({
      url: "http://localhost/fm2.pdf",
      success:function(res){
        var tempFilePath = res.tempFilePath;
        wx.openDocument({
          filePath: tempFilePath,
          success:function(res){
            console.log("打开成功")
          }
        })
      }
    })
  }
})

6.4本地数据及缓存API

6.4.1保存数据

1.wx.setStorage(Object)

示例代码：

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

2.wx.setStorageSync(key,data)

示例代码：

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

6.4.2获取数据

1.wx.setStorage(Object)

示例代码：

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

2.wx.setStorageSync(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({
  key: 'name',
  success:function(res){
    console.log("删除成功")
  },
  fail:function(){
    console.log("删除失败")
  }
})

2.wx.removeStorageSync(key)、

示例代码：

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

6.4.4清空数据

1.wx.clearStorage()

示例代码：

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

2.wx.clearStorageSync()

示例代码：

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

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

三个标准：

■ wx.getLocation（Object）接口用于获取位置信息。
■ wx.chooseLocation（Object）接口用于选择位置信息。
■ wx.openLocation（Object）接口用于通过地图显示位置。

获取位置信息
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);},
})

选择位置信息

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

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

五个：api

■ wx.getSystemInfo（Object）接口、wx.getSystemInfoSync（）接口用于获取系统信息。
■ wx.getNetworkType（Object）接口用于获取网络类型。
■ wx.onNetworkStatusChange（CallBack）接口用于监测网络状态改变。
■ wx.makePhoneCall（Object）接口用于拨打电话。

■ wx.scanCode（Object）接口用于扫描二维码

获取系统信息
wx. getSystemInfo（Object）接口、wx. getSystemInfoSync（）接口分别用于异步和同步获取系统信息。

wx. getSystemInfo（）接口或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)},})

网络状态

获取网络状态
wx. getNetworkType（Object）用于获取网络类型

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

监听网络状态变化

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

代码：

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

拨打电话

wx. makePhoneCall（Object）接口用于实现调用手机拨打电话

代码：

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

扫描二维码

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