Keystone Hooks怎么用 自定义钩子开发教程

Keystone Hooks是KeystoneJS的钩子系统，可以在内容操作前后执行自定义逻辑，适合做TypeScript内容管理框架的自动化工作流。比如创建文章时自动补全标题、检查数据是否合法，或在用户注册后触发通知。下面以Keystone 6为例，从编写函数到测试运行，带你做一个简单的文章钩子。

第一步：创建钩子函数

先打开项目的schema配置文件，找到文章列表，例如Post。钩子写在list配置的hooks属性里，不需要另外安装插件。建议先想清楚自动化规则：哪些数据要调整，什么条件下要执行，以及失败时是否应该阻止保存。把逻辑控制在小范围，后续更容易维护。

例如，文章标题可能被编辑者输入成小写，可以在resolveInput里统一首字母格式。这个钩子接收resolvedData，也就是当前已解析的内容；处理后要返回新的对象。记得用展开语法保留其他字段，避免只返回title导致正文等数据被意外遗漏。

第二步：配置列表钩子

在列表定义中导入list和text等字段函数，再为Post添加fields和hooks。字段名要与resolvedData中的键一致。钩子可按create、update分别配置，也可以按项目需求处理不同操作。以下示例把新建或更新文章的标题首字母转成大写；标题为空时不做处理，仍返回原数据。

配置完成后保存文件，检查括号与逗号，并确保字段名和列表名与项目schema一致。Keystone的列表钩子面向整条记录，适合跨字段处理；若规则只针对某个字段，例如邮箱格式检查，也可以把逻辑配置在对应字段的hooks中。

使用操作前和操作后

resolveInput适合转换即将保存的数据；若要在数据库写入前执行检查或副作用，可用beforeOperation；写入完成后记录日志、发送通知，则可用afterOperation。通常create、update、delete可分别设置处理函数。beforeOperation抛错会使操作失败；afterOperation抛错时数据可能已经保存，因此非关键通知宜妥善捕获错误。

示例可以这样组织：在resolveInput中规范标题，在beforeOperation中检查业务条件，在afterOperation中根据operation判断是否为create，再调用通知函数。发送邮件等外部服务最好设置超时与错误处理，避免服务暂时不可用时影响用户判断；同时避免把敏感信息直接写入日志。

第三步：测试和调试钩子

启动开发服务器后，通过Admin UI或GraphQL执行一次新建操作，再检查保存结果是否符合预期。接着编辑同一条记录，确认update分支也生效；若设置了条件分支，还要分别测试条件成立与不成立的情况。测试时使用可识别的样例数据，避免误改真实内容。

调试时可在钩子中临时记录operation、resolvedData和item等信息，定位输入与当前记录的差别。不要长期输出完整用户数据；排查后移除临时日志。若操作失败，查看终端错误和GraphQL响应，并核对钩子是否返回了正确对象。也可为关键业务规则写自动化测试，覆盖创建、更新和异常分支。

最后把重复逻辑抽到独立函数，并利用TypeScript类型检查参数与返回值；项目若能生成Keystone类型，可用对应列表类型标注函数，减少字段拼写错误。本文由润灭整理。若在国内寻找界面原型或产品设计辅助工具，可了解墨刀AI：modao.cgref.cn。

“`