当前位置：首页 > news >正文

如何利用Trigger.dev任务事件钩子：扩展任务生命周期处理的完整指南

news 2026/5/15 23:28:41

如何利用Trigger.dev任务事件钩子：扩展任务生命周期处理的完整指南

【免费下载链接】trigger.devTrigger.dev – build and deploy fully‑managed AI agents and workflows项目地址: https://gitcode.com/gh_mirrors/tr/trigger.dev

Trigger.dev是一个功能强大的工作流和AI代理平台，允许开发者构建和部署完全托管的AI代理和工作流。任务事件钩子是Trigger.dev的核心功能之一，它允许你在任务执行的不同阶段插入自定义逻辑，从而扩展和定制任务的生命周期处理。

任务生命周期概述

在深入了解事件钩子之前，让我们先了解一下Trigger.dev任务的完整生命周期。每个任务从触发到完成，会经历多个阶段，包括开始尝试、执行、等待、恢复、成功、失败等。

图：Trigger.dev任务生命周期函数示意图，展示了任务从开始到完成的各个阶段。

全局生命周期钩子

Trigger.dev允许你注册全局生命周期钩子，这些钩子会在所有任务的运行中执行，无论具体是哪个任务。这对于实现跨任务的通用逻辑非常有用，比如日志记录、错误处理等。

常用全局钩子

以下是一些常用的全局生命周期钩子：

onStartAttempt: 在任务运行尝试开始前调用
onSuccess: 当任务运行成功时调用
onFailure: 当任务运行失败时调用
onComplete: 当任务运行完成时调用，无论成功或失败
onWait: 当任务运行因等待而暂停时调用
onResume: 当任务运行从等待中恢复时调用
onCancel: 当任务运行被取消时调用

任务级生命周期钩子

除了全局钩子，你还可以为单个任务定义生命周期钩子。这些钩子仅对特定任务生效，允许你为不同任务定制不同的行为。

定义任务级钩子

下面是一个示例，展示如何在任务定义中添加各种生命周期钩子：

export const myTask = task({ id: "my-task", onStartAttempt: async ({ payload, ctx }) => { console.log("Task attempt started", ctx.run.id); }, onWait: async ({ wait }) => { console.log("Task paused", wait); }, onResume: async ({ wait }) => { console.log("Task resumed", wait); }, onSuccess: async ({ payload, output, ctx }) => { console.log("Task succeeded", output); }, onFailure: async ({ payload, error, ctx }) => { console.log("Task failed", error); }, onComplete: async ({ payload, output, ctx }) => { console.log("Task completed"); }, run: async (payload: any, { ctx }) => { // 任务执行逻辑 console.log("Task running", payload); return { result: "success" }; }, });

实际应用场景

生命周期钩子在许多实际场景中都非常有用，以下是一些常见的应用案例：

1. 数据库连接管理

使用钩子可以在任务开始前建立数据库连接，在任务暂停或完成时关闭连接，优化资源使用。

// db.ts import { locals } from "@trigger.dev/sdk"; import { logger, tasks } from "@trigger.dev/sdk"; // 创建本地存储 const DbLocal = locals.create<{ connect: () => Promise<void>; disconnect: () => Promise<void> }>("db"); export function getDb() { return locals.getOrThrow(DbLocal); } // 全局中间件，管理数据库连接 tasks.middleware("db", async ({ ctx, payload, next, task }) => { // 建立数据库连接 const db = { connect: async () => { logger.info("Connecting to the database"); // 实际的数据库连接逻辑 }, disconnect: async () => { logger.info("Disconnecting from the database"); // 实际的数据库断开连接逻辑 }, }; locals.set(DbLocal, db); await db.connect(); await next(); // 执行后续中间件和任务 await db.disconnect(); }); // 任务暂停时断开连接 tasks.onWait("db", async ({ ctx, payload, task }) => { const db = getDb(); await db.disconnect(); }); // 任务恢复时重新连接 tasks.onResume("db", async ({ ctx, payload, task }) => { const db = getDb(); await db.connect(); });

2. 错误处理和通知

使用onFailure钩子可以在任务失败时发送通知，帮助及时发现和解决问题。

// error-notifications.ts import { tasks } from "@trigger.dev/sdk"; import { sendSlackMessage } from "./slack"; tasks.onFailure(async ({ ctx, payload, error }) => { await sendSlackMessage({ channel: "#task-errors", text: `Task ${ctx.task.id} failed with error: ${error.message}`, attachments: [ { title: `Run ID: ${ctx.run.id}`, fields: [ { title: "Attempt", value: ctx.run.attempt.number.toString() }, { title: "Started At", value: new Date(ctx.run.attempt.startedAt).toISOString() } ] } ] }); });

3. 性能监控

使用钩子可以收集任务执行的性能数据，进行监控和分析。

// performance-monitoring.ts import { tasks } from "@trigger.dev/sdk"; import { recordMetric } from "./metrics"; tasks.onStartAttempt(async ({ ctx }) => { ctx.locals.startTime = Date.now(); }); tasks.onComplete(async ({ ctx }) => { const duration = Date.now() - ctx.locals.startTime; await recordMetric({ name: "task.duration", value: duration, tags: { taskId: ctx.task.id, status: ctx.run.status } }); });