SDK 介绍

WARNING

请注意,当前域名 https://dev.weixin.qq.com/docs/framework 文档已不维护,请前往微信文档中心open in new window 找到对应的新文档继续使用

一、基本信息

1.1 iOS SDK

1.2 Android SDK

二、使用介绍

  • 为了保证 SDK 的安全稳定性以及控制 SDK 体积,将 SDK 拆分为基础 SDK 与扩展 SDK,后者是前者的补充,因此使用扩展 SDK 也必须依赖基础 SDK。
  • 而扩展 SDK 开发者可以按需在微信开发者工具的project.miniapp.json中进行配置,即扩展 SDK 为可选项。

2.1 基础 SDK

  • 基础 SDK 中集成了丰富的 API 与相关组件,用来保障最基础的应用的正常运行,如下组件或者 JSAPI 在基础 SDK 中已经包含,即开发者在微信开发者工具的project.miniapp.json只需要配置对应的对应的 SDK 版本即可
  • 基础 SDK 收集设备型号及操作系统版本信息,用于解决在不同设备、不同操作系统下SDK产品的兼容性问题

  • 如果开发者的业务逻辑中调用了例如日历、联系人等涉及用户个人信息的 JSAPI,应当在隐私政策中进行声明(点此可查看个人信息监控范围open in new window

2.1.1 基础 SDK 已经包含的 JSAPI 如下:

JSAPI 分组名称接口详情
「基础」相关API「API 总览 - 基础」open in new window
「系统」相关API「API 总览 - 系统」open in new window
「生命周期」相关API「API 总览 - 生命周期」open in new window
「应用级事件」相关API「API 总览 - 应用级事件」open in new window
「调试」相关API「API 总览 - 调试」open in new window
「性能」相关API「API 总览 - 性能」open in new window
「路由」相关API「API 总览 - 路由」open in new window
「EventChannel」相关API「API 总览 - EventChannel」open in new window
「界面」相关API「API 总览 - 界面」open in new window
「导航栏」相关API「API 总览 - 导航栏」open in new window
「Tab Bar」相关API「API 总览 - Tab Bar」open in new window
「字体」相关API「API 总览 - 字体」open in new window
「滚动」相关API「API 总览 - 滚动」open in new window
「动画」相关API「API 总览 - 动画」open in new window
「置顶」相关API「API 总览 - 置顶」open in new window
「自定义组件」相关API「API 总览 - 自定义组件」open in new window
「菜单」相关API「API 总览 - 菜单」open in new window
「发起请求」相关API「API 总览 - 网络 - 发起请求」open in new window
「下载」相关API「API 总览 - 网络 - 下载」open in new window
「上传」相关API「API 总览 - 网络 - 上传」open in new window
「进入多端App」相关API「API 总览 - 监听进入多端App」open in new window
「数据缓存」相关API「API 总览 - 数据缓存」open in new window
「画布」相关API(iOS)「API 总览 - 画布」open in new window
「富文本」相关API「API 总览 - 媒体 - 富文本」open in new window
「文件」相关API「API 总览 - 文件」open in new window
「日历」相关API「API 总览 - 日历」open in new window
「联系人」相关API「API 总览 - 联系人」open in new window
「电量」相关API「API 总览 - 电量」open in new window
「剪贴板」相关API「API 总览 - 剪贴板」open in new window
「加密」相关API「API 总览 - 加密」open in new window
「屏幕」相关API「API 总览 - 屏幕」open in new window
「键盘」相关API「API 总览 - 键盘」open in new window
「电话」相关API(Android)「API 总览 - 电话」open in new window
「加速计」相关API(Android)「API 总览 - 加速计」open in new window
「罗盘」相关API(Android)「API 总览 - 罗盘」open in new window
「设备方向」相关API(Android)「API 总览 - 设备方向」open in new window
「陀螺仪」相关API(Android)「API 总览 - 陀螺仪」open in new window
「振动」相关API(Android)「API 总览 - 振动」open in new window
「短信」相关API(Android)「API 总览 - 短信」open in new window
「Worker」相关API「API 总览 - Worker」open in new window
「WXML」相关API「API 总览 - WXML」open in new window

2.2 扩展 SDK

  • 多端应用框架中部分小程序 JSAPI 抽离成了单独的模块以减少应用打包体积,用户可根据自身需要引入所需功能。开发者可以在开发者工具通过可视化编辑项目的 project.miniapp.json 中 拓展 SDK 配置来设置对应的拓展模块是否使用

  • 部分截图如下,详情可查看扩展SDKopen in new window

  • 部分扩展 SDK 涉及收集了个人信息,如果你的应用使用了涉及收集个人信息的 JSAPI,开发者需在应用的隐私政策中详细说明,否则会被应用市场驳回;上架相关问题可以查看上架应用市场常见问题 open in new window

  • 补充:点此可查看个人信息监控范围open in new window

  • 注意:开启配置以后需要重新构建App。

2.2.1 iOS 扩展 SDK

project.miniapp.json 中对应的名称JSAPI 分组名称接口详情
OpenFuns SDK(不含支付)wx.miniapp.shareXXX 相关API以及 wx.miniapp.loginAPI 总览 - 转发open in new window
API 总览 - 登录open in new window
OpenFuns SDK(含支付)wx.miniapp.shareXXX 相关API以及 wx.miniapp.login、wx.miniapp.requestPaymentAPI 总览 - 转发open in new window
API 总览 - 登录open in new window
API 总览 - 支付open in new window
Network SDKWebSocket、mDNS、TCP 通信、UDP 通信、WIFI、网络相关APIAPI 总览 - 网络 - WebSocketopen in new window
API 总览 - 网络 - mDNSopen in new window
API 总览 - 网络 - TCP 通信open in new window
API 总览 - 网络 - UDP 通信open in new window
API 总览 - WIFIopen in new window
API 总览 - 网络open in new window
LBS SDK地图、位置相关APIAPI 总览 - 媒体 - 地图open in new window
API 总览 - 位置open in new window
Media SDK图片、视频、音频、背景音频、录音、相机相关APIAPI 总览 - 媒体 - 图片open in new window
API 总览 - 媒体 - 视频open in new window
API 总览 - 媒体 - 音频open in new window
API 总览 - 媒体 - 背景音频open in new window
API 总览 - 媒体 - 录音open in new window
API 总览 - 媒体 - 相机open in new window
Bluetooth SDK蓝牙APIAPI 总览 - 蓝牙 - 通用open in new window
API 总览 - 蓝牙 - 低功耗中心设备open in new window
API 总览 - 蓝牙 - 低功耗外围设备open in new window
API 总览 - 蓝牙 - 信标(Beacon)open in new window
Idaas SDK苹果登录相关APIwx.appleLoginopen in new window
TPNS SDK消息推送相关APIwx.miniapp.getXGPushManageropen in new window
补充:点此查看消息推送合规指南open in new window
GDT SDK腾讯广告相关APIwx.miniapp.setEnableAdSplashopen in new window
补充:点此查看腾讯广告合规指南open in new window
Others SDK电话、扫码、短信相关APIAPI 总览 - 电话open in new window
API 总览 - 扫码open in new window
API 总览 - 短信open in new window
LBS SDK加速计、罗盘、设备方向、陀螺仪相关APIAPI 总览 - 加速计open in new window
API 总览 - 罗盘open in new window
API 总览 - 陀螺仪open in new window
API 总览 - 设备方向open in new window

2.2.2 Android 扩展 SDK

project.miniapp.json 中对应的名称JSAPI 分组名称接口详情
Network SDKWebSocket、mDNS、TCP 通信、UDP 通信、WIFI、网络相关APIAPI 总览 - 网络 - WebSocketopen in new window
API 总览 - 网络 - mDNSopen in new window
API 总览 - 网络 - TCP 通信open in new window
API 总览 - 网络 - UDP 通信open in new window
API 总览 - WIFIopen in new window
API 总览 - 网络open in new window
LBS SDK地图、位置相关APIAPI 总览 - 媒体 - 地图open in new window
API 总览 - 位置open in new window
Media SDK图片、视频、音频、背景音频、录音、相机相关APIAPI 总览 - 媒体 - 图片open in new window
API 总览 - 媒体 - 视频open in new window
API 总览 - 媒体 - 音频open in new window
API 总览 - 媒体 - 背景音频open in new window
API 总览 - 媒体 - 录音open in new window
API 总览 - 媒体 - 相机open in new window
Bluetooth SDK蓝牙APIAPI 总览 - 蓝牙 - 通用open in new window
API 总览 - 蓝牙 - 低功耗中心设备open in new window
API 总览 - 蓝牙 - 低功耗外围设备open in new window
API 总览 - 蓝牙 - 信标(Beacon)open in new window
Scanner SDK扫码相关APIAPI 总览 - 扫码open in new window
XWEB SDK画布 canvas相关APIAPI 总览 - 画布open in new window
XWEB Embed SDK画布 canvas相关APIAPI 总览 - 画布open in new window
TPNS SDK消息推送相关APIwx.miniapp.getXGPushManageropen in new window
补充:点此查看消息推送合规指南open in new window
GDT SDK腾讯广告相关APIwx.miniapp.setEnableAdSplashopen in new window
补充:点此查看腾讯广告合规指南open in new window

三、SDK 更新日志