小程序插件使用

插件介绍

插件是对一组 js 接口、自定义组件 或页面的封装,用于嵌入到小程序中使用。插件不能独立运行,必须嵌入在其他小程序中才能被用户使用;而第三方小程序在使用插件时,也无法看到插件的代码。因此,插件适合用来封装自己的功能或服务,提供给第三方小程序进行展示和使用。

插件开发者可以像开发小程序一样编写一个插件并上传代码,在插件发布之后,其他小程序方可调用。小程序平台会托管插件代码,其他小程序调用时,上传的插件代码会随小程序一起下载运行。

相对于普通 js 文件或自定义组件,插件拥有更强的独立性,拥有独立的 API 接口、域名列表等,但同时会受到一些限制,如 一些 API 无法调用或功能受限。还有个别特殊的接口,虽然插件不能直接调用,但可以使用 插件功能页 来间接实现。

接入流程

以下为插件开发接入流程:

  1. 开通插件功能
  2. 填写开发信息并开发
  3. 完善基本信息
  4. 提交审核、发布
  5. 管理插件使用申请

开通插件功能

开发插件前,请阅读了解 《小程序插件接入指南》 了解开通流程及开放范围,并开通插件功能。如果未开通插件功能,将无法上传插件。
插件开发
插件开发文档

插件的功能描述、使用步骤等,例如:收钱吧轻pos插件的说明文档

使用插件
添加插件

小程序管理后台的"设置-第三方设置-插件管理"中添加插件。

开发者可登录小程序管理后台,通过 appid 查找插件并添加。如果插件无需申请,添加后可直接使用;否则需要申请并等待插件开发者通过后,方可在小程序中使用相应的插件。

引入插件代码包

使用插件前,使用者要在 app.json 中声明需要使用的插件,例如:

json 复制代码
{
  "plugins": {
    // 插件名称
    "lite-pos-plugin": {
      "version": "1.0.0", // 插件的版本号
      "provider": "wx7903bb295ac26ac7" // 插件的appid
    }
  }
}

插件的自定义组件

使用插件提供的自定义组件,和 使用普通自定义组件 的方式相仿。在 json 文件定义需要引入的自定义组件时,使用 plugin:// 协议指明插件的引用名和自定义组件名,例如:

js 复制代码
{
  "usingComponents": {
    "hello-component": "plugin://myPlugin/hello-component"
  }
}

插件页面跳转

需要跳转到插件页面时,url 使用 plugin:// 前缀,形如 plugin://PLUGIN_NAME/PLUGIN_PAGE, 如:

html 复制代码
<navigator url="plugin://myPlugin/hello-page">
  Go to pages/hello-page!
</navigator>
js 复制代码
wx.navigateGo({
  url: `plugin://lite-pos-plugin/cashierV2?token=${order_token}&appid=${appId}&openid=${open_id}&selected=giftcard&union_id=${union_id}`
});

插件的js接口

使用插件的 js 接口时,可以使用 requirePlugin 方法。例如,插件提供一个名为 hello 的方法和一个名为 world 的变量,则可以像下面这样调用:

js 复制代码
var myPluginInterface = requirePlugin('myPlugin');

myPluginInterface.hello();
var myWorld = myPluginInterface.world;

基础库 2.14.0 起,也可以通过插件的 AppID 来获取接口,如:

js 复制代码
var myPluginInterface = requirePlugin('wxidxxxxxxxxxxxxxxxx');

接入成功案例
收钱吧轻POS插件=>欧舒丹

相关推荐
都叫我大帅哥1 天前
Java JJWT 完全指南:从入门到生产级实践
java
前端开发张小七1 天前
Java 学习笔记 · 第一课:基础语法与核心概念
java·后端
ThsPool1 天前
【ENVI二次开发学习整理 04】ENVI功能扩展与二次开发
java·前端·javascript
赤壁小虾1 天前
【渲染流水线】[逐片元阶段]-[透明度测试]以UnityURP为例
java·前端·数据库
SelectDB1 天前
基于 Apache Doris 搭建 RAG 系统:从基础 RAG 到知识图谱增强的完整实现与选型指南
apache
青山木1 天前
Hot 100 --- 搜索插入位置
java·数据结构·算法·leetcode
Jul1en_1 天前
【Claude Code Compact】源码级别的学习上下文压缩
java·前端·学习·github·ai编程
摇滚侠1 天前
《SpringBoot 3:入门与应用实战》第 15 章 生产级特性 管理 Spring Boot 应用 阅读笔记
java·spring boot·笔记
SelectDB1 天前
SelectDB Enterprise 4.0.5:企业级实时分析与 AI 数据底座怎么选?安全合规配置指南
apache
XWalnut1 天前
SpringBoot快速入门
java·spring boot·后端