uni-app 插件制作与发布全指南从插件目录规范、uni_modules 打包到付费加密与插件市场变现【免费下载链接】uni-appA cross-platform framework using Vue.js项目地址: https://gitcode.com/gh_mirrors/un/uni-app导读本文以 uni-app 官方插件发布文档为核心系统讲解在 DCloud 插件市场ext.dcloud.net.cn上制作、发布、销售与维护插件所需的完整知识从插件 ID 命名、各类插件前端组件、页面/项目模板、JS SDK、uts 插件、App 原生插件、HBuilderX 插件、uniCloud 系列的目录结构要求到基于uni_modules的模块化开发与一键发布流程再到付费插件的普通授权版/源码授权版机制、云编译加密、试用与防盗版策略。读完本文你可以将手头可复用的组件、页面、云函数按规范整理成可发布、可计费、可被使用者一键导入的插件并理解其背后的加密与授权运行原理。为什么要提交插件DCloud 拥有活跃的插件市场并提供计价销售、广告解锁、赞助、评价等机制。提交插件的动力主要有三方面分享写出通用的功能模块时可以分享给其他有相同需求的人人人贡献、人人受益变现通过赞赏、广告分成、计费销售收获物质回报只有 uniCloud 插件和 App 原生或 uts 插件支持付费其他类型插件不能设价格荣誉通过插件下载量、评星、排行收获荣誉。关于插件变现的完整细节赞赏、广告解锁、付费销售、账单结算、提现另见 插件变现指南。插件制作注意目录规范与插件 IDuni 插件本质上是 uni-app 项目下的一部分代码但提交时需要注意遵循插件目录规范其中最重要的是确定插件 ID详见下方命名规范插件包中不应该包含unpackage目录最好也不包含node_modules目录插件包中不应该包含版本控制相关文件和目录如.git、.svn等前端建议使用 scss 预处理并引用 uni.scss或 uni-ui 仓库中的同名文件中的变量定义保持各插件风格统一方便插件使用者通过“搭积木”的方式开发整体风格一致的 App。插件 ID 命名规范格式为作者ID-插件英文名称示例xiaoming-abc其中作者 ID 和插件名称只能包含英文、数字作者 ID 由插件作者自定义不能使用DCloud、uni等关键字长度要求至少 2 位字符插件名称需直观表达插件的作用例如eshop、button等。仓库中大量插件即遵循此规范例如 src/uni_modules/uni-actionSheet/package.json 的id为uni-actionSheet、src/uni_modules/uni-badge-view/package.json 的id为uni-badge-view。uni_modules推荐的插件组织形式从 HBuilderX 3.1 起新增uni_modules它是 uni 生态的重要模块化方案详细目录结构与配置见 uni_modules 文档。自uni_modules发布后建议插件作者首先在自己的项目下建一个uni_modules目录在本地开发调试没问题后对uni_modules下你的插件目录点右键选择“发布到插件市场”。插件市场分多种插件分类下面逐一介绍各类插件的制作与发布要求。前端组件前端组件指 uni-app 前端使用 vue/nvue/wxml 等技术开发的、用于页面内嵌的组件可细分为 vue 组件、uvue 组件、nvue 组件、小程序自定义组件不包含 uts 原生组件。以小明开发的 tag 组件插件 ID 为xiaoming-tag为例上传插件市场时目录结构要求如下xiaoming-tag/ ├── components/ │ └── xiaoming-tag/ │ ├── xiaoming-tag.vue // 组件实现 │ └── ... └── ...仅包含必需文件为保证代码简洁上传插件时仅需包含必需的文件及目录。依赖三方组件时的打包方式若组件依赖三方组件则需将三方组件一起打包上传。假设xiaoming-tag依赖小红开发的 icon 组件xiaohong-icon则发布xiaoming-tag插件时目录结构要求如下xiaoming-tag/ ├── components/ │ ├── xiaoming-tag/ // 本插件组件 │ └── xiaohong-icon/ // 被依赖的三方组件一并打包 └── ...Tips通用组件、nvue 组件目录结构要求相同小程序组件的一级目录名字需从components变更为wxcomponents其它结构要求相同组件不能包含根目录的manifest.json、pages.json、App.vue、main.js等文件。付费前端插件uni-app x 云编译加密插件市场很早就支持原生插件和 uniCloud 云插件的加密保护但前端插件尤其是可编译到 web 和小程序的 ui 库因其载体特殊开放性很难做知识产权保护。HBuilderX 4.19 起DCloud 提供了一种云编译手段来解决前端插件的知识产权保护问题。加密与云编译机制插件作者设置加密后插件使用者下载到的是加密后的版本。在运行、发行对前端代码编译时uni-app x 的编译器会将加密插件发送到 DCloud 的云编译服务器进行编译把编译结果混入本地编译工程从而实现“插件使用者可以使用插件但无法获取插件源码”的效果这种云编译仅在第一次进行云编译一次后会有缓存插件使用者可以获取到编译后的代码但就像 uni-app (x) 编译后的代码非常难懂、不会有人去改一样这种方式虽不严谨但大体上仍能有效保护前端插件作者的知识产权该过程不会把插件使用者的项目源码整体发送到 DCloud 服务器云编译和解密的仅包括加密插件本身。授权版本与绑定规则插件市场所有加密付费的插件均有普通授权和源码授权两种版本。购买源码授权后插件作者可以得到插件的完整源码此时不再发送插件源码到云编译服务器不管是普通授权版还是源码授权版都绑定唯一的 appid 和包名。购买者若更换了这 2 个信息中的任意一个需要重新购买授权具体参考插件购买协议通过开发工具、编译器、运行时的整体配合DCloud 给前端插件作者提供了以往不存在的知识产权保护方案包括源码授权版DCloud 也会检查盗版行为。加密范围与发布配置目前前端插件加密仅支持 uni-app x 下uni_modules形式的、符合 easycom 规范的组件插件可在全平台加密包括 web 端、app 端。DCloud 插件市场会自动加密付费插件中所有 vue、uvue、uts、js、ts 文件除pages、hybrid、static目录外。HBuilderX 发布插件界面暂未支持前端组件价格设置插件作者可在插件package.json中手动配置价格后提交发布后续 ui 上将支持。配置方式参考 uni_modules 配置在package.json的dcloudext下添加sale销售信息例如{ dcloudext: { sale: { regular: { price: 98.00 }, sourcecode: { price: 980.00 } } } }仓库中免费插件的同构配置可参考 src/uni_modules/uni-actionSheet/package.jsondcloudext.sale中regular.price与sourcecode.price均为0.00即免费插件。前端组件付费插件开发注意事项目前仅支持uni-app x项目不支持uni-app项目且最低需要 HBuilderX 4.19不支持混搭utssdk目录、不支持页面加密仅支持符合 easycom 规范的组件可通过依赖的方式配置其他插件目前仅支持依赖同样加密的插件插件需要对外导出方法、类型等内容时必须在插件根目录index.uts做导出使用者不能直接引入插件内部的文件加密组件属性的代码提示配置在发布时云端会自动生成前端组件付费插件使用时会单独上传至云端独立编译此时不会包含项目内的其他内容所以插件不能引入项目内其他目录资源此类需求可以通过 API 让插件使用者传入对应数据app-android 平台不支持导出 vue 的 plugin 和 mixin。前端组件付费插件使用注意事项当项目包含前端付费插件时首次运行或发行到指定平台会触发付费插件在该平台的云端编译此时需要电脑处于联网状态且登录的 HBuilderX 账号具备使用该插件的权限购买、试用、协作等。云端编译成功后后续将使用本地缓存如果更新了插件版本、HBuilderX 版本或运行时勾选了清除缓存会再次触发云端编译不支持直接引入插件内部的文件仅支持导入插件根目录。例如// 正确导入插件根目录需要插件作者在 index.uts 中导出 test import { test } from /uni_modules/test-components // 错误直接引入插件内部文件 import { test } from /uni_modules/test-components/test.utsuni-app 前端模板vue/nvue 页面模板以小明开发的设置模板xiaoming-setting为例上传插件市场时目录结构要求如下xiaoming-setting/ ├── pages/ │ └── setting/... // 页面文件 ├── manifest.json // 页面模板需包含 ├── pages.json // 页面模板需包含 └── ...若页面模板依赖其它组件则需将依赖组件一起打包。假设xiaoming-setting依赖小红开发的 list 组件xiaohong-list则发布页面模板时需一并包含components/xiaohong-list/等目录。依赖管理也可以使用uni_modules在你的uni_modules目录下的package.json中配置依赖另一个uni_modules此时不用再包含其他插件的源码。但这种做法无法锁定版本会在使用者下载你的插件时自动安装最新的依赖。如果你的页面需要在下载时被注册到使用者的项目的pages.json中从HBuilderX 3.5.0插件导入工程时支持合并页面路由到项目的 pages.json详见 uni_modules 文档的 pages_init 章节。Tipsvue 页面模板和 nvue 页面模板目录结构要求相同页面模板打包时需要包含manifest.json、pages.json等文件。uni-app 前端项目模板项目模板无特殊要求注意满足 uni-app 项目目录结构要求即可。仓库中的 examples/hello-uts 与 examples/hello-uvue 即展示了完整项目应具备的目录骨架App.vue/uvue、main.js/uts、pages.json、manifest.json、uni.scss、static 等。Tips项目模板打包时不需要包含unpackage目录项目模板打包时需要包含manifest.json文件manifest.json里不允许有 appid包括 DCloud appid 或微信等三方 appid如果模板中包含 uniCloud 相关的云函数目录如uniCloud-aliyun、uniCloud-tcb请选择“uniCloud”-“前后一体项目模板”。如果不使用云函数功能则应该从插件包中删除 uniCloud 相关目录。JS SDK开发 JS SDK 时对目录结构无特殊要求仅需将 js 文件命名为插件 ID 即可例如xiaoming-md5.js。Tips不能包含根目录的manifest.json、pages.json、App.vue、main.js等文件如果是非uni_modules的 js sdk使用者下载后会被下载到使用者项目根目录下的js_sdk目录。UTS 插件uts 插件开发详见 插件开发文档这里主要说明 uts 付费插件发布的注意事项。uts 付费插件分为普通授权版及源码授权版两种付费方式的区别详见 插件扩展介绍文档。如需发布付费插件可对插件设置两种版本的价格。DCloud 插件市场会对付费插件自动加密uts 付费插件加密规则加密除interface.uts之外的所有 uts 文件加密utssdk/app-android及utssdk/app-ios目录下的 java、kt、swift 等混编文件。试用、购买与绑定当插件用户试用插件时无法查阅这些加密的源码uts 插件试用只能用于打包自定义基座不能用于正式发布如果插件用户购买了普通授权版也看不到这些加密文件的源码提交云打包时会在云端验证并解密文件进行打包如果插件作者上传插件时设置了提供源码授权版且插件使用者购买了源码授权版才能下载到插件的源码不管是普通授权版还是源码授权版都绑定唯一的 appid 和包名。购买者更换了这 2 个信息中的任意一个需要重新购买授权。Tipsuts 加密插件只支持云端传统打包不支持离线打包、也不支持安心打包打包最低需要 HBuilderX 3.7.2一般提交的 uts 插件仅包含 uts 源码不建议包含三方 sdk如 jar这些应配置成仓储从HBuilderX 4.81 起uts 付费插件支持鸿蒙平台如果发行平台为 web、小程序或鸿蒙uts 加密插件需要提交云端编译目前仅支持uni-app x项目不支持uni-app项目。uts 插件与 App 原生语言插件的区别uts 插件和 App 原生插件在功能上重叠都是原生扩展 uni-app 的能力。从 uts 插件发布后DCloud 建议插件作者开发 uts 插件替代老的原生插件。它们的具体差别uts 开发和使用更加简单、清晰、小巧uts 插件更新免审核无需等待 DCloud 管理员审核上架uts 插件天然支持多版本插件作者更新后使用者可以不更新仍然使用之前下载到本地的老版插件uts 插件支持源码版计费可以卖更高的价格相关版权由 DCloud 保护防止盗版和侵权且很多使用者有源码需求担心三方 SDK 有不可控代码。目前 uni-app 的 ext api 全部基于 uts 实现一些内置 api如弹框也已改成 uts 实现。仓库中的 src/uni_modules/uni-actionSheet 即是一个典型的 uts 类型插件其 package.json 的dcloudext.type为uts并在uni_modules.uni-ext-api中声明了showActionSheet、hideActionSheet两个 API 在 app 端由 kotlin/swift/arkts 实现。虽然这些对开发者而言并非需要下载的插件但本质是内置于 runtime 的 uts 插件。未来 uni-app 的所有官方 api 都会改为 uts 实现而原生语言插件只会修改较严重的 bug。在未来uts 插件将同时支持下一代的 uni-app 的 uvue以及现有的 vue、nvue而 app 原生语言插件只支持这一代的 uni-app无法支持 uvue。包括 uts 组件也将支持 vue 页面而原生语言插件的组件模式不会支持 vue 页面只支持 nvue 页面。注意uts 插件目前还不支持离线打包不过插件市场销售的原生语言插件也不支持离线打包。建议有个性化打包需求的开发者使用 HBuilderX 的 cli 来处理自动化打包。FAQ为什么原生插件需要审核且很慢而 uts 插件免审核因为 uts 插件提交的是源码可控原生插件提交给 DCloud 的是编译后的文件需要人工审核。实际上 uniCloud 插件也是免审核的同样是源码凡是提交源码的都免审。App 原生语言插件App 原生语言插件需使用 Android/iOS 原生环境开发实现。压缩包格式要求打开 zip 后根目录需为插件 id 目录二级目录是 ios、android 子目录及 package.jsonuni 原生插件包格式。从 uts 插件发布后DCloud 建议插件作者开发 uts 插件替代老的原生插件原因见上文 uts 插件与 App 原生语言插件的区别。HBuilderX 插件HBuilderX 插件是安装在 HBuilderX 工具里的是编辑器的插件不是手机 App 的插件。uniCloud 插件云函数模板云函数模板对文件命名没有特殊要求但制作插件压缩包时需要注意当模板中包含一个或多个云函数时不能只在插件中放入云函数目录而需要完整的从项目根目录开始如uniCloud/cloudfunctions/cf123。uniCloud可以接受-aliyun或-tcb后缀阿里云和腾讯云这两个目录也可以同时存在云函数有效的入口文件为index.js插件包中必须包含至少一个以此命名的文件涉及账户管理的话请使用 uni-id。仓库中 src/uniCloud-aliyun/cloudfunctions 下即存放了多个以index.js为入口的云函数示例例如 src/uniCloud-aliyun/cloudfunctions/encryption/index.js 就是标准的exports.main入口写法。付费云函数插件的加密配置如果上传付费云函数插件则必须选择要加密的云函数否则插件试用者可以通过试用流程无限期使用你的插件而不需要付费。定义加密云函数为了与 uni_modules 统一规范废弃原encryptlist.json需在插件根目录下添加package.json在uni_modules - encrypt中配置需要加密的文件例如{ uni_modules: { encrypt: [ // 配置要加密的文件为插件包中真实存在且相对根目录的文件路径需注意uniCloud目录的后缀需与项目一致 uniCloud-aliyun/cloudfunctions/function/index.js ] } }encrypt数组中可灵活配置uniCloud/cloudfunctions下云函数及公共模块的 js 文件与原encryptlist.json文件配置整个云函数或公共模块相比更加灵活。定义好要加密的云函数内容后上传插件DCloud 插件市场会自动加密这些云函数当插件用户试用插件时无法查阅这些云函数的源码并且**只有在试用期内一般是 7 天内**这些加密云函数才能在他部署的服务空间上运行过了试用期这些云函数将自动失效即便插件用户购买了插件的普通授权版也看不到这些加密云函数的源码但这些云函数可以正常运行在他购买时绑定的服务空间上且无法上传到其他服务空间如果插件作者上传插件时同时提供了源码授权版且插件使用者购买了源码授权版才能拿到插件的所有源码。关于普通授权版和源码授权版的区别详见 插件扩展介绍文档。从 HBuilderX 3.2.0 版本开始当发布云端一体项目模板或云端一体页面模板的付费插件时前端 js 文件也支持加密设置方式与云函数类似在uni_modules - encrypt中定义文件路径如{ uni_modules: { encrypt: [ js_sdk/index.js, components/demo/demo.js ] } }注意目前只支持付费插件的 js 文件加密vue 及 nvue 文件无法加密业务核心逻辑建议写到 js 中如果发布云端一体项目且包含uni_modules时不会加密uni_modules目录下的文件uni_modules下应该作为独立插件发布分别进行加密配置如果你的插件配置包含涉密信息、希望保护这些配置不被上传可参考 uni_modules 插件上传辅助脚本示例。云端一体页面模板云端一体页面模板如果非uni_modules则为单页面模板只能放一个页面如果是uni_modules可以放任意数量页面。为防止导入时与项目现有代码冲突需注意以下命名规范必须包含云函数相关目录uniCloud/cloudfunctions可以包含js_sdk、pages、components、static等目录云函数、公共模块命名需要包含“-”即带有插件 ID 前缀js_sdk、components、static等目录下的子目录及文件命名需要包含“-”不能包含根目录的manifest.json、App.vue、main.js等文件如需注册页面到项目的pages.json中参考 uni_modules 文档。前后一体项目模板与 uni-app 前端项目模板目录结构基本一致但必须包含 uniCloud 相关目录uniCloud-aliyun、uniCloud-tcb。uniCloud admin 插件在使用 uniCloud admin 基础框架后可以进一步集成插件作者写好的 admin 插件以丰富自己的 admin 系统功能。插件作者可以按本文档提交插件在插件市场的上传发布页面选择uniCloud分类的Admin 插件。DB Schema 及验证函数主要用于提交数据表 schema 及校验函数所以必须包含uniCloud-aliyun/database或uniCloud-tcb/database目录。仓库中 src/uniCloud-aliyun/database 下的 JSON 文件即此类数据表结构定义。pages_init 页面注册该章节文档已迁移至 uni_modules 文档的 pages-init 章节。核心机制当 uni_modules 插件根目录下存在pages_init.json文件在插件导入工程时会弹出合并页面路由的 pages.json 修改界面插件使用者点击确认即可完成插件页面向项目 pages.json 的注册。插件发布注意与 FAQuni-app 原生 SDK 及 web 项目两个分类下插件发布后需要审核才会生效插件不能自行下架如需下架请发邮件到 servicedcloud.io你也可以把插件标题改为“已废弃”DCloud 管理员会及时审核处理如果是非 uni_modules 插件自己压缩的压缩包注意为标准 zip 格式不要使用非主流的压缩软件不要把 rar 等其他格式文件的后缀名改名为 zip。附基于 uni_modules 的发布与变现延伸一键发布流程HBuilderX插件开发完毕后在 HBuilderX 中可完成发布全流程详见 uni_modules 文档项目根目录创建uni_modules目录vue-cli 项目则位于src/uni_modules在uni_modules目录右键“新建 uni_modules 插件”填写插件 ID、选择插件分类本地运行示例项目验证插件功能插件目录右键“发布到插件市场”填写插件信息更新日志会自动与根目录changelog.md同步发布项目模板则在项目根目录创建 package.json 后右键发布后续更新版本的操作与首次发布相同仍为右键“发布到插件市场”。package.json 中的销售与分类配置发布插件时dcloudext节点用于配置插件市场分类标识type与销售信息saleuni_modules节点用于配置依赖、加密文件与平台兼容性。仓库中的实际范例uts 类型插件src/uni_modules/uni-actionSheet/package.jsontype: uts并通过uni_modules.dependencies声明对uni-framework、uni-theme、uni-dialogPage、uni-event等插件的依赖组件类型插件src/uni_modules/uni-badge-view/package.jsontype: component-vue声明了完整的platforms.client平台兼容性矩阵如app-uvue: y自定义元素类型插件src/uni_modules/uni-form/package.jsontype: uts-custom-element并通过uni_modules.pages与uni_modules.components映射各平台的 dom2 渲染实现。插件市场分类标识对应package.json - dcloudext - type主要取值如下一级分类二级分类type前端组件通用组件component-vue前端组件小程序组件component-mpJS SDK通用 SDKsdk-jsuts插件API插件utsuts插件uni-app兼容模式组件component-utsuts插件标准模式组件uts-vue-componentuni-app前端模板前端页面模板uniapp-template-pageuni-app前端模板uni-app前端项目模板uniapp-template-projectuniCloud云函数模板unicloud-template-functionuniCloud云端一体页面模板unicloud-template-pageuniCloud云端一体项目模板unicloud-template-projectuniCloudAdmin插件unicloud-adminuniCloudDB Schema及验证函数unicloud-database插件依赖与忽略文件在package.json的uni_modules - dependencies节点配置三方 uni_modules 插件依赖依赖的插件也必须是 uni_modules 插件如果是三方 npm 插件依赖使用标准的dependencies节点配置发布到插件市场时通常需要忽略unpackage、.hbuilderx、node_modules等目录可通过.npmignore文件实现注意开头有个点。项目根目录下的.npmignore对发布项目、插件模板生效uni_modules/插件ID/.npmignore对发布插件生效。付费插件的通用授权模型综合来看插件市场付费插件的授权模型可总结为插件类型绑定对象加密手段试用方式打包要求uts 插件appid 包名加密除interface.uts外所有 uts 及混编文件打包自定义基座不可正式发布云端传统打包HBuilderX 3.7.2App 原生插件appid 包名编译后文件打包自定义基座不可正式发布云端打包前端组件uni-app xappid 包名云编译加密 vue/uvue/uts/js/ts本地运行或打包自定义基座云编译HBuilderX 4.19仅 uni-app xuniCloud 插件服务空间 spaceId加密云函数/公共模块/js7 天试用到期自动销毁加密云函数部署到绑定服务空间其中 uts/原生插件、前端组件插件的销售与客户端 appid、包名绑定uniCloud 插件的销售与服务空间绑定DCloud 为所有销售插件提供了试用机制详见 插件扩展介绍文档 与 插件变现指南。【免费下载链接】uni-appA cross-platform framework using Vue.js项目地址: https://gitcode.com/gh_mirrors/un/uni-app创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考