插件
Me-Admin有灵活的插件系统,可快速扩展应用
安装插件
复制插件
将插件包复制到 addons文件夹下
安装插件
执行npx meadmin addon 【插件包文件夹名】 安装插件,以 doc插件为例,执行npx meadmin addon doc, 执行命令后会执行以下操作:
- copy插件目录下的
template文件到项目对应目录 - 执行插件的
install.sql文件生成数据库表 - 执行插件
addons.json的installShells的命令列表
- 如果插件已经安装完成, 请先卸载插件或使用-f参数(-f会先卸载再安装)
npx meadmin -m local addon doc -f - meadmin 命令 支持-m传入 env环境变量, 以读取对应的数据库配置,例如
npx meadmin -m local addon doc
二次开发
插件安装完毕后,后端文件会在src/app/admin/addons/插件文件夹和src/app/index/addons/插件文件夹,前端文件会分别在view/admin/src/addons/插件文件夹和view/index/src/addons/插件文件夹下。具体目录规则请参考 后端文档 和 前端文档
卸载插件
执行 npx meadmin addon 【插件包文件夹名】 --rm卸载插件,以 doc插件为例,执行npx meadmin addon doc --rm, 执行命令后会执行以下操作:
- 删除下列文件夹:
src/app/admin/addons/插件包文件夹名/、src/app/index/addons/插件包文件夹名/、view/admin/src/addons/插件包文件夹名/、view/index/src/addons/插件包文件夹名/ - 执行插件的
uninstall.sql文件删除数据库表 - 执行插件
addons.json的uninstallShells的命令列表
meadmin 命令 支持 -m 传入 env环境变量, 以读取对应的数据库配置,例如 npx meadmin -m local addon doc --rm
开发插件
创建插件模板
运行npx meadmin addon 插件名称 -c创建对应插件包
开发插件代码
- 创建数据库实体 ,实体名称必须以
aon插件名称.entity.ts小驼峰方式命名 - 运行
npx meadmin sync命令 同步插件数据库结构 - 运行
npx meadmin crud 插件实体类名 -a 插件名称生成对应的增删改查文件
插件目录结构为:src/app/admin/addons/插件包文件夹名/、src/app/index/addons/插件包文件夹名/、view/admin/src/addons/插件包文件夹名/、view/index/src/addons/插件包文件夹名/
相关实例可参考doc插件
打包插件
- 在插件根目录加入安装和卸载sql脚本,
install.sql、uninstall.sql - 运行
npx meadmin addon 插件名称 --cp复制插件模板到addons/插件目录/template下 - 完善 插件配置文件:
addons/插件目录/addons.json的installShells、uninstallShells的命令列表