本文原发布于 2022-07-08,从旧博客迁移至此处。 整理:Hermes
FastAdmin 插件 - 打包发布教程
开发完 FastAdmin 插件后,需要打包成 ZIP 文件以便分发和安装。本文介绍如何正确打包 FastAdmin 插件。
📁 插件目录结构
标准的 FastAdmin 插件目录结构如下:
plugin_name/
├── manifest.json # 插件manifest文件(必需)
├── config.php # 插件配置文件(可选)
├── controller/ # 控制器目录
├── model/ # 模型目录
├── view/ # 视图目录
├── public/ # 公共资源目录
├── sql/ # 数据库脚本目录
├── assets/ # 前端资源
├── README.md # 说明文档
└── LICENSE # 许可证📄 manifest.json 文件
这是插件的核心配置文件:
{
"name": "plugin_name",
"title": "插件名称",
"version": "1.0.0",
"author": "作者名",
"description": "插件描述",
"icon": "fa fa-plugin",
"admin": {
"name": "admin",
"title": "管理后台"
},
"config": {
"key1": {
"title": "配置项1",
"type": "string",
"value": "默认值"
}
},
"dependencies": {
"fastadmin": ">=1.0.0"
}
}📦 打包步骤
方法一:使用命令行
# 进入插件根目录
cd /path/to/plugin_name
# 创建 ZIP 文件(排除无关文件)
zip -r ../plugin_name_1.0.0.zip \
manifest.json \
config.php \
controller/ \
model/ \
view/ \
public/ \
sql/ \
assets/ \
README.md \
LICENSE \
--exclude="*.git*" \
--exclude="runtime/*" \
--exclude=".idea/*"方法二:使用压缩软件
- 右键点击插件目录
- 选择"添加到压缩包"
- 设置压缩格式为 ZIP
- 排除以下文件:
.git/目录runtime/目录.idea/目录node_modules/目录
✅ 打包检查清单
| 检查项 | 说明 |
|---|---|
| manifest.json | 必须存在且格式正确 |
| 无敏感信息 | 不包含数据库密码、API 密钥等 |
| 无开发文件 | 排除 .git、runtime、.idea 等 |
| 文件完整 | 所有必需文件都已包含 |
| 权限正确 | 文件权限设置合理 |
📝 发布建议
- 版本命名:使用语义化版本号(如 1.0.0)
- 更新日志:在 README.md 中记录版本变更
- 文档完整:提供详细的使用说明
- 测试验证:在干净环境中测试安装
💡 最佳实践
- 使用
.gitignore排除无关文件 - 定期清理
runtime/缓存 - 保持插件目录结构规范
- 提供详细的安装说明
整理:Hermes