fastadmin:插件addons开发实战

第 06 章 插件(Addons)开发实战

Addons 是 FastAdmin 的功能分发单位:一个插件可以包含控制器、模型、视图、JS、配置与安装 SQL,即插即用、可卸载、可上架官方市场。

插件位于根目录 addons/插件标识/,标识为小写字母开头的目录名,如 addons/myblog/。

addons/myblog/
├── Myblog.php            # 插件主类(必须,类名=目录名首字母大写)
├── info.ini              # 插件信息
├── config.php            # 插件配置(可在后台修改)
├── install.sql           # 安装时执行的 SQL
├── LICENSE
├── bootstrap.js          # 前端钩子注入脚本
├── controller/           # 插件控制器
├── model/
├── view/
└── lang/
snippet.ini
name = myblog
title = 我的博客
intro = 一个演示插件
author = 你的名字
version = 1.0.0
state = 1
url = /myblog
snippet.php
<?php
namespace addons\myblog;
 
use think\Addons;
 
class Myblog extends Addons
{
    public function install()   { return true; }
    public function uninstall() { return true; }
    public function enable()    { return true; }
    public function disable()   { return true; }
}

四个生命周期方法返回 true 表示成功,返回字符串则作为错误提示。

snippet.bash
php think addon -a myblog -c create

生成完整骨架文件,避免手写 ini 与目录。

钩子允许插件在不修改核心代码的情况下向系统注入行为:

  1. 定义钩子:在 application/tags.php 或插件市场已有钩子点(如 app_init、view_filter)
  2. 插件实现:主类中定义同名 public 方法
snippet.php
// 在页面底部注入统计代码
public function viewFilter(&$content)
{
    $content = str_replace('</body>', '<script>/* 统计 */</script></body>', $content);
}

安装插件时钩子会自动注册到 application/extra/addons.php。

插件同样支持一键 CRUD:

snippet.bash
php think crud -t myblog_post -c myblog/post --addon=myblog

生成的控制器继承 app\common\controller\Backend,访问路径为 /admin/myblog/post/index?ref=addtabs,插件后台菜单需在 info.ini 或后台插件配置中登记。

config.php 返回数组即可在后台「插件管理 → 配置」中可视化编辑:

snippet.php
return [
    ['name' => 'per_page', 'title' => '每页数量', 'type' => 'number', 'value' => '10', 'tip' => ''],
    ['name' => 'audit', 'title' => '开启审核', 'type' => 'radio',
     'options' => ['1' => '是', '0' => '否'], 'value' => '1', 'tip' => ''],
];

代码中读取:

snippet.php
$config = get_addon_config('myblog');
$perPage = $config['per_page'];
snippet.bash
php think addon -a myblog -c package

生成 zip 包。发布到官方市场需遵守命名、目录与安全规范,确保 install.sql 使用 __PREFIX__ 占位表前缀:

snippet.sql
CREATE TABLE `__PREFIX__myblog_post` ( ... );
  • 业务功能优先做成插件,避免直接改动核心代码,便于升级
  • 插件 SQL 一律使用 __PREFIX__,不要硬编码 fa_
  • 卸载时清理自己的数据表与 fa_auth_rule 中登记的菜单节点

插件 = 主类 + ini + 可选的 MVC 与钩子。掌握生成命令、生命周期与配置机制,就能把任何功能封装成可复用插件。下一章转向 API 接口开发。

该主题尚不存在

您访问的页面并不存在。如果允许,您可以使用创建该页面按钮来创建它。

  • fastadmin/插件addons开发实战.txt
  • 最后更改: 2026/08/20 10:02
  • 由 张叶安