XIUNOX 二次开发入门：自定义功能模块开发教程

爱马仕 Lv2 3小时前

XIUNOX 二次开发入门：自定义功能模块开发教程

XIUNOX 不仅是一个功能完善的开源论坛系统，更是一个可高度定制的开发平台。它完整保留了 Xiuno BBS 4.0.4 的插件架构，同时引入了现代化的 RESTful API 和 Bootstrap 5.3 前端框架。无论你是想给论坛增加一个签到功能，还是开发复杂的积分商城系统，本文都能带你快速上手。

一、理解 XIUNOX 的 MVC 架构

在开始动手之前，先了解 XIUNOX 的代码组织方式。它采用经典的 MVC 分层设计：

Model（模型层）：位于 model/ 目录，负责所有数据库交互。比如 bbs_user_model.php 处理用户相关的增删改查。
View（视图层）：位于 view/ 目录下的 htm/ 子目录，使用 XIUNOX 自带的模板引擎编写，渲染结果就是浏览器看到的 Bootstrap 5.3 界面。
Controller（控制器层）：分布在 route/ 和 api/v1/ 目录，负责处理用户请求、调用模型、返回视图或 JSON 数据。

这种清晰的架构让二次开发变得非常直观——你只需要找到对应的分层，在合适的位置插入你的业务逻辑即可。

二、插件目录结构与配置

创建自定义插件时，在 plugin/ 目录下新建一个以插件名命名的文件夹，按以下结构组织文件：

plugin/my_plugin/
├── conf.json          # 插件元信息，包括名称、版本、钩子列表
├── hook/               # 钩子文件——插件的核心
│   ├── index_begin.php
│   └── thread_create_end.php
├── install.php         # 安装脚本（自动创建数据表、初始化配置）
├── uninstall.php       # 卸载脚本（清理数据表、删除配置项）
└── lang/               # 多语言支持
    └── zh-cn.php

三、插件配置文件详解

conf.json 是插件的"身份证"，定义了插件的基本信息、依赖哪些钩子、以及需要创建哪些数据表。以下是一个典型配置：

{
    "name": "my_plugin",
    "version": "1.0.0",
    "description": "我的第一个 XIUNOX 插件",
    "author": "开发者名称",
    "hooks": [
        "index_begin",           // 首页加载时触发
        "thread_create_end"      // 发帖完成后触发
    ],
    "table": [
        "CREATE TABLE IF NOT EXISTS {table_prefix}my_data (
            id INT AUTO_INCREMENT PRIMARY KEY,
            tid INT NOT NULL,
            content TEXT,
            create_date INT NOT NULL
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;"
    ]
}

四、实际开发：相关推荐功能

下面通过一个真实案例来展示开发流程。目标是在帖子底部增加"相关推荐"模块，根据当前帖子的版块推荐同版块的其他帖子。在 hook/thread_view_end.php 中编写：

<?php
// hook/thread_view_end.php
$tid = $thread['tid'];
$related = db()->query("SELECT tid, subject FROM bbs_thread 
    WHERE fid = ? AND tid != ? 
    ORDER BY create_date DESC LIMIT 5", 
    [$thread['fid'], $tid]);
?>
<div class="card mt-3">
    <div class="card-header">相关推荐</div>
    <div class="card-body">
        <ul class="list-unstyled mb-0">
        {loop $related $r}
            <li><a href="?thread-{$r[tid]}.htm">{$r[subject]}</a></li>
        {/loop}
        </ul>
    </div>
</div>

五、用 RESTful API 扩展后端能力

XIUNOX 的 API 位于 api/v1/ 路径，支持标准 REST 风格的路由。如果你需要开发一个给第三方应用调用的统计接口，只需在 api/v1/ 下新增一个路由文件：

<?php
// api/v1/mycustom.php
Route::get('/api/v1/mycustom/stats', function() {
    $count = db()->get("bbs_thread", "COUNT(*) as total");
    return json(['code' => 0, 'data' => ['threads' => $count]]);
});

这样外部应用就能通过 GET /api/v1/mycustom/stats 获取论坛帖子统计数据了。API 自动支持 App ID + Bearer Token 双层认证，安全性有保障。

XIUNOX 的二次开发门槛很低，对熟悉 PHP 和 MySQL 的开发者非常友好。作为现代化的PHP论坛系统和开源论坛，XIUNOX 这一优秀的论坛软件为社区建站提供了充分的灵活性和扩展空间，让你的创意落地变得简单高效。

点赞收藏

XIUNOX 二次开发入门：自定义功能模块开发教程