Huawei Sample Whistle Plugin

这是一个简单的 Whistle 插件示例，用于演示插件的基本功能。

插件信息

• 插件名称: whistle.huawei-sample-plugin
• 版本: 1.0.4
• Options 页面 URL: http://127.0.0.1:8899/whistle.huawei-sample-plugin/

注意: Options 页面 URL 必须使用 whistle. 前缀，而不是 plugin. 前缀。

功能特性

• 支持 sample://test 协议请求处理
• 支持 HTTP 路径 /sample-plugin-test 访问
• 支持域名 http://test.sample-plugin.com/ 的请求处理

使用方法

在 Whistle 规则配置中添加以下任意规则：

sample://test your-target-url
your-domain.com/sample-plugin-test sample://test  
test.sample-plugin.com http://your-target-server

安装与调试

插件必需文件

Whistle 插件必须包含以下关键文件：

.
├── lib/
│   └── index.js          # 插件主逻辑文件
├── public/
│   └── index.html        # Options 页面入口文件
├── whistle.js            # ⭐ 插件配置文件（必需）
├── package.json          # 插件元数据
└── README.md             # 本说明文件

whistle.js 文件内容：

module.exports = {
  main: require('./lib/index.js'),
  ui: './public'
};

安装插件

# 方式1: 通过npm安装（如果已发布到npm）
w2 plugin install whistle.huawei-sample-plugin

# 方式2: 本地开发安装（创建符号链接）
# 在 ~/.whistle/plugins 目录下创建指向本项目的符号链接
ln -s /path/to/your/sample-plugin ~/.whistle/plugins/whistle.huawei-sample-plugin

重启服务

修改插件代码后，需要重启 Whistle 服务才能生效：

w2 restart

验证插件

1. 访问 Whistle 管理界面: http://127.0.0.1:8899/
2. 点击 "Plugins" 标签页，确认插件已加载
3. 访问 Options 页面: http://127.0.0.1:8899/whistle.huawei-sample-plugin/

常见问题

Q: 访问 Options 页面返回 404

A: 请检查以下几点：

1. URL 是否正确: 确保使用 whistle.huawei-sample-plugin 而不是 plugin.huawei-sample-plugin
2. public 目录是否存在: 确认插件根目录下存在 public/index.html 文件
3. whistle.js 配置文件: 确认存在 whistle.js 文件并正确配置了 ui: './public'
4. 服务是否重启: 修改文件后执行 w2 restart 重启服务
5. 插件是否加载: 在 Plugins 页面确认插件状态

Q: 插件规则不生效

A:

• 确认 Whistle 规则配置正确
• 检查插件是否在 Plugins 页面显示为已启用状态
• 重启 Whistle 服务

目录结构

.
├── lib/
│   └── index.js          # 插件主逻辑文件
├── public/
│   └── index.html        # Options 页面入口文件
├── whistle.js            # 插件配置文件（必需）
├── package.json          # 插件元数据
└── README.md             # 本说明文件