首页/默认分类/正文
API小程序开发框架:丰富微信原生API及多种类型详细介绍

 2025年08月26日  阅读 1

摘要:事件监听API事件监听API以on开头,用于监听特定事件是否触发,例如wx.onAppHide、wx.onError等。这类API需要传入一个回调函数作为参数。当监听的事件被触发时,系统会自动调用该回调函数,并将事件相关数据以参数形式传递到函数中。通过这种方...

事件监听API

事件监听API以on开头,用于监听特定事件是否触发,例如wx.onAppHidewx.onError等。这类API需要传入一个回调函数作为参数。当监听的事件被触发时,系统会自动调用该回调函数,并将事件相关数据以参数形式传递到函数中。通过这种方式,开发者可以实时响应小程序运行过程中的各类事件。

同步API

同步API包括以Sync结尾的接口(如wx.setStorageSyncwx.getSystemInfoSync),以及其他明确标注为同步的API(如wx.canIUsewx.getLaunchOptionsSync)。同步API的特点是调用后立即返回执行结果,开发者可以直接通过函数返回值获取数据。如果执行过程中出现错误,系统会直接抛出异常,需要使用try-catch语句进行捕获和处理。同步API适合需要立即获取结果的场景,但需注意避免在主线程执行耗时操作。

wx.onCompassChange(function (res) {
  console.log(res.direction)})

异步API

大多数小程序API采用异步调用方式,例如wx.requestwx.login等。异步API接受一个Object类型的参数,该对象支持配置以下回调函数:

1. success:接口调用成功时执行

try {
  wx.setStorageSync('key', 'value')} catch (e) {
  console.error(e)}

开发免费微信小程序_同步API与异步API区别_小程序API使用

2. fail:接口调用失败时执行

3. complete:调用结束必定执行(无论成功失败)

4. 其他接口定义的参数

回调函数会收到一个包含以下字段的Object参数:

errMsg:错误信息,成功时格式为${apiName}:ok

errCode:错误码(部分API支持),成功时为0

其他接口返回数据

Promise化调用方式

从基础库2.10.2版本开始,异步API支持Promise和回调两种调用方式。当参数中不包含success/fail/complete回调时,API会自动返回Promise对象。开发者可以使用then/catch语法处理调用结果,例如:


wx.request({url: ''}).then(res => {}).catch(err => {})

wx.login({
  success(res) {

开发免费微信小程序_小程序API使用_同步API与异步API区别

    console.log(res.code)   }})

但需注意:如果调用失败且未捕获Promise拒绝,会触发Unhandled promise rejection错误,可以通过wx.onUnhandledRejection监听未处理的Promise拒绝事件。

特殊异步API处理

某些异步API(如wx.connectSocketwx.createCameraContext)本身具有返回值,这些接口的Promise化需要开发者自行封装。在使用Promise调用方式时,如果函数执行失败,控制台会显示Unhandled promise rejection警告。

云开发API

通过开通小程序云开发服务,开发者可以直接在小程序端调用云函数。云开发API提供了包括数据库操作、文件存储、云函数调用等后端服务能力,无需自行搭建服务器即可实现完整的小程序后端功能。这些API同样遵循小程序的标准调用规范,支持异步回调或Promise调用方式。

// callback 形式调用wx.chooseImage({
  success(res) {
    console.log('res:', res)
  }})// promise 形式调用wx.chooseImage().then(res => console.log('res: ', res))

版权声明:本文为 “博览广文网” 原创文章,转载请附上原文出处链接及本声明;

原文链接:http://wen.bjhwtx.com/post/35782.html

标签:

博览广文网

博览广文网为所有文学爱好者、新闻爱好者、关注生活多方面内容的观众朋友提供多方位的内容呈现、提升阅读空间、填充碎片时间,开阔读者的视野、增长见识、了解民生、一个让您不出户尽知天下事的网站平台!
热门标签
关于我们
广文舒阅网—让天下读者有家可归!这里汇聚了各类优质文化信息,无论是全球热点、历史故事,还是实用百科、趣味探索,您都能轻松获取。我们希望用阅读点亮您的世界,让每一次浏览都充满收获和乐趣。
导航栏A标题
广文舒阅网
扫码关注
联系方式
全国服务热线:0755-88186625
Q Q:8705332
Email:admin@lanyu.com
地址:深圳市福田区海雅缤纷国际大厦5层501
Copyright 深圳市蓝宇科技有限公司 版权所有 备案号:京ICP备20013102号-1