JetKVM自定义开发教程：添加新功能和扩展系统能力

JetKVM是一款高性能的开源KVM over IP解决方案，允许用户通过网络远程控制计算机、服务器和工作站。本教程将指导你如何为JetKVM添加新功能和扩展系统能力，即使你是开发新手也能轻松上手。

准备开发环境

开发前必备条件

开始JetKVM开发之旅前，你需要准备以下工具和设备：

• JetKVM设备：用于完整功能测试的硬件设备
• 开发工具：Go 1.24.4+和Node.js 22.15.0
• 版本控制：Git
• 设备访问：通过SSH连接到JetKVM设备的权限

项目克隆与环境搭建

首先，克隆JetKVM项目仓库到本地开发环境：

git clone https://gitcode.com/gh_mirrors/kvm/kvm
cd kvm

检查开发工具版本是否符合要求：

go version && node --version

项目结构解析

了解JetKVM的项目结构有助于你更快找到需要修改的文件：

/kvm/
├── main.go                   # 应用入口点
├── config.go                 # 设置与配置
├── web.go                    # API端点
├── internal/                 # 内部Go包
│   ├── hidrpc/               # HID设备的HIDRPC实现
│   ├── native/               # CGO/原生代码粘合层
│   └── usbgadget/            # USB设备功能
└── ui/                       # React前端
    ├── src/components/       # UI组件
    └── src/routes/           # 页面路由

对于新手开发者，以下文件是最常用的：

• web.go - 添加新API端点
• config.go - 添加新配置项
• ui/src/routes/ - 添加新页面
• ui/src/components/ - 添加新UI组件

添加新功能的基本流程

后端开发：添加API端点

要添加新功能，首先需要在后端添加相应的API端点。编辑web.go文件，添加新的处理函数：

// 在web.go中添加新的API处理函数
func handleNewFeature(w http.ResponseWriter, r *http.Request) {
    // 实现功能逻辑
    json.NewEncoder(w).Encode(map[string]string{"status": "success"})
}

// 在适当位置注册路由
router.HandleFunc("/api/new-feature", handleNewFeature).Methods("POST")

配置管理：添加新配置项

如果新功能需要可配置的参数，编辑config.go文件：

type Config struct {
    // ... 现有字段
    NewFeatureEnabled bool `json:"new_feature_enabled"` // 新功能开关
}

var defaultConfig = &Config{
    // ... 现有默认值
    NewFeatureEnabled: false, // 默认禁用新功能
}

前端开发：创建UI界面

为新功能创建用户界面，需要在ui/src/routes/目录下添加新的页面组件：

// ui/src/routes/settings/new-feature.tsx
import { SettingsPageHeader } from "@components/SettingsPageheader";
import { Switch } from "@components/Switch";

export default function NewFeatureSettings() {
    return (
        <div className="p-6">
            <SettingsPageHeader
                title="新功能设置"
                description="配置JetKVM的新扩展功能"
            />
            <div className="mt-6">
                <Switch
                    label="启用新功能"
                    // 添加开关逻辑
                />
            </div>
        </div>
    );
}

扩展系统能力：创建扩展插件

JetKVM支持通过扩展机制添加额外功能，如ATX电源控制、DC电源控制和串行控制台等。你可以按照以下步骤创建自己的扩展：

扩展开发示例

1. 创建扩展组件：在ui/src/components/extensions/目录下创建新的扩展组件

// ui/src/components/extensions/MyNewExtension.tsx
import { ExtensionComponent } from "@components/extensions/ExtensionComponent";

export function MyNewExtension() {
    return (
        <ExtensionComponent
            title="我的新扩展"
            description="这是一个JetKVM扩展示例"
        >
            {/* 扩展内容 */}
        </ExtensionComponent>
    );
}

2. 注册扩展：在扩展弹窗中注册新扩展

// ui/src/components/popovers/ExtensionPopover.tsx
import { MyNewExtension } from "@components/extensions/MyNewExtension";

const AVAILABLE_EXTENSIONS = [
    // ... 现有扩展
    {
        id: "my-new-extension",
        name: "我的新扩展",
        description: "这是一个自定义扩展",
        component: MyNewExtension
    }
];

测试与部署

本地测试

完成功能开发后，使用以下命令测试你的更改：

# 部署到设备并运行测试
./dev_deploy.sh -r 192.168.1.100 --run-go-tests

查看日志

调试时，通过SSH连接到设备查看实时日志：

ssh root@192.168.1.100
tail -f /var/log/jetkvm.log

前端热重载

开发UI时，使用前端热重载加快开发速度：

cd ui
npm install
./dev_device.sh 192.168.1.100  # 替换为你的设备IP

本地化支持

为确保你的新功能对全球用户可用，需要添加本地化支持：

1. 添加翻译键：在ui/localization/messages/en.json中添加新的翻译键

{
    "new_feature_title": "新功能",
    "new_feature_description": "这是一个强大的新功能"
}

2. 使用翻译函数：在UI组件中使用m函数引用翻译

<SettingsPageHeader
    title={m.new_feature_title()}
    description={m.new_feature_description()}
/>

3. 更新翻译：运行本地化工具更新语言文件

cd ui
npm run i18n

常见问题解决

构建失败

如果遇到构建失败或权限问题，尝试以下命令：

# 修复权限
ssh root@<IP> chmod +x /userdata/jetkvm/bin/jetkvm_app_debug

# 清理并重建
go clean -modcache
go mod tidy
make build_dev

设备连接问题

无法连接到JetKVM设备时：

# 检查网络连接
ping <IP>

# 检查SSH连接
ssh root@<IP> echo "Connection OK"

前端不更新

前端更改未生效时，尝试清除缓存：

cd ui
npm cache clean --force
rm -rf node_modules
npm install

总结

通过本教程，你已经了解了如何为JetKVM添加新功能和扩展系统能力的基本流程。从设置开发环境、修改后端API、创建前端界面到测试部署，每一步都有详细说明。JetKVM的模块化设计使得扩展变得简单，无论是添加小型功能还是开发完整扩展，都可以按照本文档的指导进行。

现在，你可以开始探索JetKVM的代码库，根据自己的需求定制和扩展这个强大的远程控制解决方案了！