1. 共享契约
插件化手册
  • FH2 插件开发手册
    • 产品简介
    • 典型场景
    • 发版说明
    • 快速开始
      • 快速开始总览
      • 第一个插件
      • 后端插件
      • 全栈闭环
    • AI辅助开发
      • AI 开发 Skill
      • 安装与复验
      • 第一个工程
      • 真实需求示例:现场问题上报
      • 改造已有工程
      • 调试与交付
    • 开发指南
      • 开发指南
      • 基础概念
        • 基础概念总览
        • 什么是插件开发
        • 平台架构
        • 前端宿主、扩展点与能力
        • 后端运行时、入口与权限
        • 开发流程
        • 安全与隔离
        • 支持范围与问题反馈
      • 开发指南
        • 开发指南总览
        • 前端插件
          • 前端插件深度指南
          • 前端工程结构
          • 插件清单(fh2-plugin.json)
          • 入口与生命周期
          • 界面与状态
          • 多宿主插件
          • 跨宿主通信服务
          • HTTP、WebSocket 与事件
          • 存储、Blob 与定时器
          • 工具链与本地调试页面
        • 后端插件
          • 后端开发深度指南
          • 后端插件的结构
          • 后端源清单 fh2-plugin.json
          • HTTP 接口处理函数
          • 消息订阅与事件处理函数
          • ctx 与能力注入
          • 数据存储与缓存
          • 流程编排
          • 触发方式
          • 连接外部系统
          • 流程编排练习(DAG)
        • 前后端协作
          • 前后端协作总览
          • 前后端共享契约
          • 端到端幂等
          • 事件、通知与状态
          • 统一错误模型
          • 链路标识与诊断日志
        • 完整练习
          • 环境准备
          • 第一个前端插件
          • 第一个后端插件
          • 第一个全栈插件
      • 能力总览
        • 能力地图
        • 能力可用性矩阵
        • 前端能力
          • 平台通用能力
            • 平台通用能力总览
            • 基础运行时:HTTP、事件、WebSocket 与存储
            • 导航、位置与通知
            • 弹窗、音频与剪贴板
            • 地图能力
            • 项目设备能力
            • WPMZ 与航线预览
            • 受控对象上传
          • 项目宿主
            • 项目宿主总览
            • 项目上下文
            • 项目侧边栏入口
            • 项目插件路由
            • 项目工作区
          • 消息宿主
            • 消息宿主总览
            • 消息告警弹层
            • 消息导航与通知
          • 计划库宿主
            • 计划库宿主总览
            • 计划库表单上下文
            • 计划库表单扩展
            • 校验、提交与 `biz_ext`
          • 驾驶舱
            • 驾驶舱插件能力总览
            • 驾驶舱扩展点
            • 上下文与遥测
            • 相机、检测与 AI
            • 场景几何与直播指针
            • 飞控、云台与任务
            • 驾驶舱平台事件
        • 后端能力
          • 后端能力地图
          • 后端能力总览
          • 配置、受管出网与集成连接
          • 事件与流程
          • 飞行任务与违停巡逻
          • 数据存储
          • 媒体与前端通知
          • 资源租约
          • 作业、目标轨迹与视频处理
      • 调试与测试
        • 调试与测试总览
        • 快速入门排错
        • 本地开发
        • Web IDE:打开工程与保存改动
        • 工作流编辑器:节点、接线与交付
        • 知识与 MCP:先判断需要哪一层事实
        • 前端本地调试
        • 后端运行时与流程调试
        • 模拟数据与测试数据
        • 集成测试与 E2E
        • 日志与链路追踪
        • 常见问题排查
      • 完整示例
        • 示例与案例总览
        • 项目侧边栏与工作区
        • 消息告警卡片
        • 计划表单任务清单
        • 驾驶舱动作与左侧面板
        • 最小后端插件
        • 最小全栈插件
        • 多宿主插件实战
        • 事故快处
        • 交通抓拍
        • 违停巡逻完整案例
      • 构建发布与安全
        • 构建、发布与安全
        • 质量门禁
        • 行业包构建与打包
        • 能力版本发布
        • 安装、升级与回滚
        • 安全基线
      • API参考
        • API 参考总览
        • 前端
          • 前端 API 参考
          • 前端插件清单结构
          • 前端 SDK API
          • 前端扩展点目录
          • 前端能力目录
          • 前端平台事件目录
          • 跨宿主通信服务 API
          • 工具链命令行参考(`fh2-plugin`)
        • 后端
          • 后端 API 参考
          • 后端插件源清单
          • 后端 HTTP 接口参考
          • 后端事件消费参考
          • 后端脚本上下文(`ctx`)
          • 后端数据存储
          • 流程编排语言
          • 流程触发器参考
          • 后端能力目录
          • 后端 HTTP API
        • 共享契约
          • 共享契约参考
          • 类型与契约目录
          • 错误模型
          • 版本兼容性
      • 附录
        • 错误码
        • 术语表
        • 常见问题
  1. 共享契约

版本兼容性

这一页讲「我的插件能不能在目标环境跑起来」怎么判断。分三件事:后端看 contractsRange,前端看构建产物里的清单版本字段,SDK 与工具链要求同版本。
当前发行版和完整兼容矩阵见发版说明。本页只解释判断方法,不重复维护发行记录。

后端宿主契约版本范围(contractsRange)#

后端宿主有一个契约版本;插件在后端源清单 fh2-plugin.json 里声明自己兼容的范围(构建时进入 dist/plugin.json),装载时比对,不在范围内则拒绝装载。
值的写法:
contractsRange: "<比较式> [<比较式> ...]"   // 多个比较式用空格连接(AND)
比较式: (">=" | ">" | "<=" | "<" | "=" | "==") + 三段数字版本
不支持 ^、~、||、通配符和预发布号。
留空表示不检查:能装,但失去一层保护,不建议省略。
装载失败会明确提示契约不符。处理方式:先由部署方升级兼容的后端运行环境,再发布插件包。新包使用新清单字段而运行环境仍是旧版本时,也会被拒绝装载。

前端:构建产物的版本字段#

源清单 fh2-plugin.json 不写任何版本兼容字段;manifestVersion、engines、buildInfo 由 fh2-plugin build 写进 dist/fh2-plugin.json。
安装时宿主校验这些字段:清单版本不一致 → MANIFEST_INVALID;宿主版本不在 engines 声明的范围 → ENGINE_INCOMPATIBLE。
所以只发布构建产物,不要手写或手改这些字段。

SDK 与工具链同版本#

插件 SDK 与工具链必须使用同一版本。版本不一致时 fh2-plugin validate / generate 报 FH2_SDK_VERSION_MISMATCH,应按开发者工具的依赖配置升级配套版本。
升级时两个包一起升,保持一致。

兼容组合速查#

组合结果
源清单直接交给宿主安装拒绝:缺工具链写入的构建字段
构建产物的清单版本与宿主不一致MANIFEST_INVALID
宿主版本不在 engines 范围ENGINE_INCOMPATIBLE
前端权限声明了但当前宿主没有该能力安装可成功;运行时 get() 返回 undefined,按能力缺失降级
后端新字段 + 旧宿主严格解析拒装:先升级宿主再发包
旧式模板的后端清单装生产宿主拒装:清单格式不同(见后端清单)

演进规则#

公共 ID、错误码、事件名、已有字段语义不原地修改;先新增并双栈支持,再标废弃,经迁移窗口后才移除。
「目录里存在」不等于「当前宿主可用」:新增能力不要求插件升级,但插件必须处理拿不到的情况(见能力目录)。
后端各运行实例应装载同一份插件资产(同版本、同资产指纹),由部署方确认装载一致,避免部分实例运行旧版。

常见问题#

现象原因与处理
后端包装载报契约不符contractsRange 不含宿主契约版本;调整范围,或先升级宿主
validate 报 FH2_SDK_VERSION_MISMATCHSDK 与工具链版本不一致;统一到同一版本
安装报 MANIFEST_INVALID用了手工改动或缺构建字段的产品;用 fh2-plugin build 重新产出
新包在旧环境装不上严格解析 + 新字段:先升级宿主进程,再发插件包
修改于 2026-10-22 03:40:06
上一页
错误模型
下一页
错误码
Built with