# 开发辅助

**Repository Path**: xbcode-plugin/xbDeveloper

## Basic Information

- **Project Name**: 开发辅助
- **Description**: 基于积木云框架的开发者辅助插件
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-18
- **Last Updated**: 2026-02-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xbDeveloper - 插件开发者中心

## 1. 插件介绍
`xbDeveloper` 是专为基于 `webman` 框架的 `xbCode` 生态系统设计的插件开发与管理核心工具。它充当了“插件生成器”和“生命周期管理器”的角色，旨在通过自动化模版生成、命令行工具和可视化界面，极大地降低开发者的插件开发门槛，提高开发效率。

### 核心价值
- **标准化**：统一插件目录结构与配置规范。
- **自动化**：一键生成插件脚手架代码。
- **全生命周期**：覆盖从创建、开发、克隆到导出、安装、卸载的全过程。

---

## 2. 功能特性

| 特性 | 描述 | 核心类/文件 |
| :--- | :--- | :--- |
| **插件创建** | 基于内置模版快速生成完整的插件目录结构，包括 API、控制器、配置、菜单等。 | `PluginsCreate.php`, `data/plugin/` |
| **插件克隆** | 支持对现有插件进行克隆，方便基于已有功能进行二次开发。 | `clone.vue`, `GitUtil.php` |
| **插件导出** | 将开发的插件及其相关数据打包导出，便于分发和分享。 | `PluginsExport.php`, `export.vue` |
| **安装/卸载** | 执行插件的 SQL 初始化及系统注册逻辑。 | `PluginsInstall.php`, `PluginsUnInstall.php` |
| **版本更新** | 处理插件的版本迭代与配置同步。 | `PluginsUpdate.php`, `PluginUpdate.php` |
| **命令行支持** | 提供丰富的 `webman` 命令行指令，支持无界面操作。 | `command/` 目录 |

---

## 3. 使用说明

### 3.1 命令行操作
在项目根目录下执行以下指令：

- **创建插件**：
  ```bash
  php webman plugin:create {插件标识}
  ```
- **安装插件**：
  ```bash
  php webman plugin:install {插件标识}
  ```
- **导出插件**：
  ```bash
  php webman plugin:export {插件标识}
  ```
- **更新插件**：
  ```bash
  php webman plugin:update {插件标识}
  ```

### 3.2 后台管理界面
登录管理后台后，在“开发者中心”菜单下可进行可视化操作：
1. **插件列表**：查看当前系统已加载的插件及其状态。
2. **克隆操作**：点击“克隆”按钮，输入目标插件标识，系统将通过 `GitUtil` 或文件流完成复制。
3. **导出管理**：选择插件后进行打包下载，支持配置导出参数。

---

## 4. 目录结构说明

```text
xbDeveloper/
├── api/                # 核心业务逻辑实现（安装、创建、导出等）
├── app/admin/          # 后台管理控制器与 Vue 视图文件
│   ├── controller/     # IndexController.php 处理后台请求
│   └── view/index/     # clone.vue, export.vue 交互界面
├── base/               # 基础类定义（BasePlugins.php）
├── command/            # Webman 命令行工具类
├── config/             # 插件配置文件（路由、菜单、数据库等）
├── data/plugin/        # 插件生成模版目录（核心）
│   ├── api/            # 接口 TPL 模版
│   ├── app/            # 控制器、视图、队列 TPL 模版
│   ├── config/         # 插件配置 TPL 模版
│   └── setting/        # 动态表单配置 TPL 模版
├── utils/              # 工具类（Git 操作等）
├── plugins.json        # 插件描述信息
└── README.md           # 本说明文档
```

---

## 5. 技术特点与优势

- **模版驱动**：通过 `data/plugin/` 下的 `.tpl` 模版文件，确保生成的每一行代码都符合 `xbCode` 的编码规范（如 2 空格缩进、单引号使用等）。
- **双端支持**：同时提供 **CLI（命令行）** 和 **GUI（后台界面）**，满足不同开发场景的需求。
- **Git 集成**：内置 `GitUtil` 工具，支持从版本库快速克隆或同步插件代码。
- **无缝对接**：生成的插件默认兼容 `webman-v2` 和 `think-orm3` 环境，自带路由与菜单配置。

---

## 6. 适用场景

- **新功能模块开发**：需要为系统增加新的业务模块（如商城、博客）时。
- **第三方插件适配**：将现有的 PHP 逻辑封装为符合 `webman` 插件规范的模块。
- **插件分发**：开发者需要将自己开发的功能打包成 `zip` 供其他用户安装时。
- **团队协作**：通过统一的模版工具，保证团队内多人开发的插件结构高度一致。

---

## 7. 注意事项

- 创建插件时，请确保插件标识使用小驼峰或纯字母命名（如 `myPlugin`），避免使用特殊字符。
- 导出插件前，请确认 `plugins.json` 中的版本号和描述信息已更新。
- 本插件涉及文件系统操作，请确保 `plugin/` 目录具有写权限。