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. 项目宿主

项目上下文

project:context 让插件读取当前项目、组织和用户信息,并在它们变化时收到通知。清单声明 project:context 权限,代码里 await ctx.capabilities.get('project:context') 获取并判空。只在项目宿主可用。
fh2-plugin-sdk 是插件开发 SDK;下文模块名用于说明,实际导入路径保留生成工程配置。模块名不表示已发布的 npm 包名。
const project = await ctx.capabilities.get('project:context')
if (!project) {
  ctx.logger.warn('project:context 不可用')
  return
}

方法清单#

方法说明
getState()返回当前状态快照
onStateChanged(handler)订阅变化;注册后立即回调一次当前状态;返回可释放句柄
状态结构:
interface ProjectContextState {
  readonly projectId: string | null
  readonly organizationId: string | null
  readonly userInfo: {
    readonly org_role: string | null
    readonly project_role: string | null
    readonly user_id: string | null
    readonly nick_name: string | null
    readonly account: string | null
  }
}
字段说明:
字段为 null 是正常的过渡态(宿主刚挂载、项目切换中)。不要把 null 转成空字符串后继续发业务请求。
org_role 优先取项目用户里的组织角色,缺失时回退组织用户角色。
account 依次回退项目账号、组织账号。

集成片段#

先按第一个前端插件建立可运行工程,再按项目侧栏扩展接入项目宿主。下面不是完整的 fh2-plugin.json,不可整份替换:将 permissions 去重合并到现有清单,保留现有项目宿主扩展、界面声明/注册和入口。权限不会触发激活;清单若只有 extensions: [],activate() 不会执行。
合并到 fh2-plugin.json 的字段:
{
  "permissions": ["project:context", "platform:http"]
}
下面的 definePlugin 只示范入口逻辑组织,不是可直接替换完整工程的入口;保留生成工程的 SDK 导入路径,将能力逻辑合入已有项目宿主的 activate 和业务收尾,保留项目扩展贡献与界面注册。/audit/project-entered 需由你的业务后端提供。
// plugin.ts
import { definePlugin } from 'fh2-plugin-sdk'

export default definePlugin({
  async activate (ctx) {
    if (ctx.host.id !== 'project') return
    const project = await ctx.capabilities.get('project:context')
    if (!project) {
      ctx.logger.warn('project:context 不可用')
      return
    }

    let activeProjectId: string | null = null
    async function apply (state: Awaited<ReturnType<typeof project.getState>>) {
      activeProjectId = state.projectId
      if (!state.projectId || !state.organizationId || !state.userInfo.user_id) return
      await ctx.apiCall('/audit/project-entered', {
        method: 'POST',
        body: {
          projectId: state.projectId,
          organizationId: state.organizationId,
          userId: state.userInfo.user_id,
          projectRole: state.userInfo.project_role,
        },
        idempotencyKey: `entered-${state.projectId}-${state.userInfo.user_id}`,
      })
    }

    await apply(await project.getState())
    const subscription = await project.onStateChanged((state) => {
      if (state.projectId === activeProjectId) return
      void apply(state).catch(error => ctx.logger.error('项目上下文处理失败', {
        message: error instanceof Error ? error.message : String(error),
      }))
    })

    return {
      async dispose () {
        await subscription.dispose()
      },
    }
  },
})

注意事项#

其他宿主即使声明了这个权限,get() 也是 undefined。
上下文是只读快照:不能用它修改项目数据,也不能替代业务权限校验(角色字段只是展示信息,不是授权依据)。
离开项目页后不再收到回调;不要复用旧的 projectId。
宿主卸载会清理订阅;由回调发起的自有异步工作要自己取消。

常见问题#

现象原因与处理
首次进入没触发业务请求projectId 等字段还是 null(过渡态);等状态完整后再发请求
切换项目收到重复回调自己记录上一次 projectId,相同则跳过(见示例)
想根据角色控制功能角色字段仅用于展示判断;真正的权限由后端接口校验
离开项目页还在发请求在 dispose 里释放订阅,并取消回调发起的未完成请求
修改于 2026-10-22 07:06:53
上一页
项目宿主总览
下一页
项目侧边栏入口
Built with