Skip to content

操作 Hook ​

菜单:站点设置 → 操作 Hook(高级菜单) 列表:/_Admin/system/backend-events?SiteId={站点GUID} 编辑:/_Admin/system/backend-events/edit?SiteId={站点GUID}&name={事件名}&display={显示名}

操作 Hook在后台资源 创建、更新、删除 等操作前后触发规则,用于审计、同步、通知或在资源保存前做业务校验。对应服务端 BackendRule + BackendEvent;须同时开启站点级 enableBackendEvents 开关后规则才会执行。

权限

操作权限
查看 Hook 列表与编辑页backendEvents
切换右上角 Hook 开启 / 关闭site·edit(保存站点字段 enableBackendEvents)
新建 Hook、编辑规则并 保存backendEvents·edit
多选 删除 某事件下全部规则backendEvents·edit

当前界面中 新建 Hook 与编辑页底部 保存 按钮仍检查 frontEvents·edit,实施角色权限时请同时核对该项。

总开关

除本页右上角 Hook 开启 外,基础设置 · 高级 中 操作 Hook(enableBackendEvents)须为开;两处修改同一站点字段,任一处关闭则所有操作 Hook 不执行。

与请求 Hook 区分

请求 Hook操作 Hook(本篇)
触发时机前台 HTTP 请求(Route / Page / View)后台 资源操作(创建 / 更新 / 删除等)
路径/system/front-events/system/backend-events
规则资源BusinessRuleBackendRule
总开关enableFrontEventsenableBackendEvents

如何打开 ​

  1. 在 编辑菜单 中勾选 站点设置 → 操作 Hook。
  2. 左侧 站点设置 → 操作 Hook。
操作 Hook 列表

工具栏 ​

控件说明
新建 Hook打开 Hook 类型选择(已配置过的事件类型不再出现)
Hook 开启 / 关闭enableBackendEvents;切换后 立即保存站点(saveSite)
状态文案开启时显示「Hook开启」(蓝色),关闭为灰色「Hook关闭」
操作 Hook 工具栏

Hook 列表 ​

列说明
类型事件 name 的本地化显示(如 PageCreated → 页面已创建,文案以登录语言为准)
规则数量该事件下已保存的规则条数
编辑进入 规则编辑页

多选 删除 会移除所选事件类型的 全部 规则(BackendRule/DeleteEvents),不是单条规则删除。

操作 Hook 列表

新建 Hook ​

点击 新建 Hook 弹出 Hook列表,按资源类别分组展示可选事件;点击某一类型即进入编辑页(尚未保存规则前列表可能仍无该行,保存后出现)。

Hook 类型选择

可选事件类型 ​

Hook 列表按资源分组。显示名由服务端 Hardcoded 本地化;以 BackendRule/EventList 返回为准。

图片事件 ​

时机事件名(name)
上传前 / 后ImageUploading / ImageUpload
更新前 / 后ImageUpdating / ImageUpdated
删除前 / 后ImageDeleting / ImageDelete

通用资源事件 ​

下列资源都遵循 资源前缀 + 时机后缀 的命名规则,例如 PageCreating、ContentUpdated。

后台分组name 前缀
页面Page
组件View
布局Layout
代码Code
菜单Menu
HTML 代码块HtmlBlock
内容Content
标签Label
脚本Script
样式Style
操作时机name 后缀组合示例
创建前 / 后Creating / CreatedPageCreating / PageCreated
更新前 / 后Updating / UpdatedContentUpdating / ContentUpdated
删除前 / 后Deleting / DeletedScriptDeleting / ScriptDeleted

电商事件 ​

后台分组事件名(name)典型时机
商品ProductCreating / ProductCreated商品创建前 / 后
商品ProductUpdating / ProductUpdated商品更新前 / 后
商品ProductDeleting / ProductDeleted商品删除前 / 后
商品ProductCopied复制商品后
商品分类ProductCategoryCreating / ProductCategoryCreated分类创建前 / 后
商品分类ProductCategoryUpdating / ProductCategoryUpdated分类更新前 / 后
商品分类ProductCategoryDeleting / ProductCategoryDeleted分类删除前 / 后
订单OrderConfirmed订单已确认
订单OrderDelivered订单已发货
订单OrderCancelled订单已取消

规则编辑页 ​

面包屑:操作 Hook → {事件显示名}。无侧栏菜单项,深链带 name(必填)与 display(面包屑用)。

规则编辑页

新建规则 ​

工具栏 新建规则 下拉:

类型值结构
IF-ELSE-THENIF-ELSE-THEN条件 IF + 分支 THEN / ELSE(可嵌套子规则)
DODO顺序执行一段或多段 Code

进入编辑页时若尚无规则,默认添加一条 IF-ELSE-THEN 规则。

规则卡片 ​

  • 拖动手柄在卡片 标题栏,可调整同一事件下规则 执行顺序。
  • 标题栏 删除 移除整条规则。

IF-ELSE-THEN ​

区域说明
IF点击标签打开 条件编辑;多条条件以 && 连接展示
THEN / ELSE嵌套子规则列表,可继续添加 IF-ELSE-THEN 或 DO

DO ​

列表展示各 Code 片段摘要;+ 添加 Code,铅笔编辑。Code 在 Monaco 中编写 KScript(language: typescript,KScript 模式);具体脚本对象与 API 用法见文末相关链接。

Code 编辑弹窗

编辑条件 ​

编辑条件
列说明
左值当前事件可用字段(BackendRule/ConditionOption),例如资源 Name、Body、Url、内容 FolderName、商品 Title 等
运算符随左值数据类型变化(如 =、!=、Contains、> 等)
右值比较常量

可 + 增加条件行;确认写回规则 if 数组。条件求值由 ConditionManager.Evaluate 在运行时执行。

保存与离开 ​

底部 KBottomBar:返回 回列表;保存 调用 BackendRule/post(eventName + rules)。离开页面前若有未保存修改会提示(useSaveTip)。

执行顺序(概念) ​

  1. 站点 enableBackendEvents 为真。
  2. 后台资源操作触发对应 BackendEvent(如 PageCreating、ContentUpdated)。
  3. 按列表顺序执行该事件下各规则;IF-ELSE-THEN 先判条件再走 THEN/ELSE;DO 顺序执行 Code。

具体执行由站点后台操作 Hook 引擎负责,按本页配置顺序运行。

典型工作流 ​

  1. 确认 高级 Tab 与本页 Hook 开启。
  2. 新建 Hook → 选择目标资源与时机,例如 ContentUpdated。
  3. 添加 IF-ELSE-THEN 过滤资源字段,或添加 DO 执行后台动作。
  4. 保存 后回到对应后台资源做一次创建、更新或删除验证。
  5. 协作导出时 Hook 对应站点包中的 BackendRule 资源。

CMS 与 API 分工 ​

场景看 CMS看 API / 模板引擎
配置哪些后台操作会触发规则本篇 Hook 类型选择与规则保存—
编写规则里的脚本动作只说明从 Code 弹窗进入开发 → Code、k.site Code API
内容保存后联动内容数据本篇选择 Content 事件k.content
商品、订单事件后联动电商数据本篇选择 Product / Order 事件k.commerce

相关 ​

文档说明
站点设置概述菜单与子路由
基础设置 · 高级enableBackendEvents
请求 Hook前台请求生命周期事件
开发 → CodeKScript 代码资源入口
内容 API内容数据读写能力
电商 API商品、分类、订单相关 API