小程序插件开发,上传，接入

矫情吗；* 2022-12-26 00:50 173阅读 0赞

# 创建插件项目([官方文档][Link 1]) #

打开开发者工具，选中开发模式=> ***"插件"***，填入AppID => ***"wx0xxe517147XXXXX"，***如若AppID暂无可可勾选***测试号***

小程序的 AppID 可以创建小程序插件项目，插件是独立于小程序之外的，但是 AppID 是公用的，所以不要使用原有的小程序项目进行插件开发。 在创建项目页面，选择一个空文件夹作为项目路径，可以选择创建小程序插件快速启动模板 ([开发插件文档][Link 2])

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhaGFoaGFoYWhhaGhhMTIzNDU2_size_16_color_FFFFFF_t_70][]

快速启动模板说明：

1.  `miniprogram` 文件夹是一个普通小程序项目，用来编写小程序插件的使用 Demo，上传插件代码时这个 Demo 会一起上传，并作为小程序插件的发布的审核依据.
2.  `plugin` 文件就是小程序插件项目，用来编写小程序插件的代码。
3.  ***`project.config.json` ***需要关注 `compileType` 字段，***`compileType == 'plugin'`*** 时才能正常的使用插件项目。[详情][Link 3]

## 打开已存在的插件项目 ##

如果是之前创建的插件项目，可以在项目列表中直接打开；

如果重新创建项目，选择一个非空目录，那么这个非空目录中需要有 `project.config.json` [详情][Link 3]，确保这个文件中有以下字段：

{
      "miniprogramRoot": "./miniprogram",
      "pluginRoot": "./plugin",
      "compileType": "plugin"
    }

在项目开发期间，可以手动修改 **`project.config.json`** 文件的 *`compileType`* 字段来切换项目的编译类型。

### 插件上传 ###

![20201202204734124.png][]

上传插件代码前，需要指定版本号，格式为 数字.数字.数字 ，每个数字最大为 999。

每次提交版本号需要递增，插件使用者会用到这个版本号，请谨慎填写。

上传插件时，同时会将 `project.config.json` 中 `miniprogramRoot` 指定的目录的内容作为插件使用 Demo 一起上传，这个 Demo 需要覆盖到插件的所有使用场景，便于插件的审核

## 插件文档编写、预览和上传 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhaGFoaGFoYWhhaGhhMTIzNDU2_size_16_color_FFFFFF_t_70 1][]

插件文档必须放置在插件项目根目录中的 `doc` 目录下，插件文档的入口文件是 `doc/README.md`，在 `README.md` 中引用的图片必须是 `doc` 目录下的本地图片。

在开发者工具中编辑 ***`README.md`*** 后，在该文件上右键，弹出的菜单中可以选择 “上传文档”

## 插件使用[&url][url] ##

在小程序项目的 `app.json` 的 `plugins` 字段中可以声明使用插件。如果当前的编译类型为小程序时，需要指定已发布的插件的版本号，开发者工具会根据版本号去拉取对应版本的插件进行编译。

只有在 `project.config.json` 的 `compileType == 'plugin'` 时，插件的版本号才能为 `'dev'`

"compileType": "miniprogram",// 小程序
    "compileType": "plugin",// 插件

### 添加插件 ###

在使用插件前，首先要在小程序管理后台的“***设置-第三方服务-插件管理***”中添加插件。开发者可登录小程序管理后台，通过 appid 查找插件并添加。如果插件无需申请，添加后可直接使用；否则需要申请并等待插件开发者通过后，方可在小程序中使用相应的插件。

## 接入流程 (两种方式) ##

### 1: 在小程序管理后台添加插件 ###

小程序开发者可在“小程序管理后台-设置-第三方服务-插件管理”中查找需要的插件，并申请使用。插件开发者在24小时内通过后，小程序开发者可在小程序内使用该插件。

### ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhaGFoaGFoYWhhaGhhMTIzNDU2_size_16_color_FFFFFF_t_70 2][] ###

### 2: 引入插件代码包 ###

使用插件前，使用者要在 `app.json` 中声明需要使用的插件，例如：

**代码示例：**

{
      "plugins": {
        "myPlugin": {
          "version": "1.0.0",
          "provider": "wxidxxxxxxxxxxxxxxxx"
        }
      }
    }

如上例所示， `plugins` 定义段中可以包含多个插件声明，每个插件声明以一个使用者自定义的插件引用名作为标识，并指明插件的 appid 和需要使用的版本号。其中，引用名（如上例中的 `myPlugin`）由使用者自定义，无需和插件开发者保持一致或与开发者协调。在后续的插件使用中，该引用名将被用于表示该插件。

[微信小程序 第三方插件的使用][Link 4]

`小程序插件接入指南`

`插件与文档上传后，并不会马上发布刷新文档，需要进入 插件管理后台 进行提交审核，审核通过后，小程序即可根据关联插件 hash-key 如上图代码下载指定生产版本，之后就可愉快的玩耍啦～`

# #

[Link 1]: https://developers.weixin.qq.com/miniprogram/dev/devtools/plugin.html
[Link 2]: https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/development.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhaGFoaGFoYWhhaGhhMTIzNDU2_size_16_color_FFFFFF_t_70]: /images/20221120/72b9a01c3b694323aa89c591d8a350c4.png
[Link 3]: https://developers.weixin.qq.com/miniprogram/dev/devtools/projectconfig.html
[20201202204734124.png]: /images/20221120/3f42ee00b6ab4e22903915b1df9dfa90.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhaGFoaGFoYWhhaGhhMTIzNDU2_size_16_color_FFFFFF_t_70 1]: /images/20221120/01c396b0ca2a4c0a8b4e33f12eb3c36d.png
[url]: https://developers.weixin.qq.com/miniprogram/introduction/plugin.html#%E4%BD%BF%E7%94%A8%E6%8F%92%E4%BB%B6
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhaGFoaGFoYWhhaGhhMTIzNDU2_size_16_color_FFFFFF_t_70 2]: /images/20221120/76356c8543304f90b67fc0ad35343a3e.png
[Link 4]: https://www.jianshu.com/p/de4003b06661