---

name: dbos-typescript description: "构建可靠、容错的 TypeScript 应用程序指南，使用 DBOS 持久化工作流。适用于将 DBOS 添加到现有 TypeScript 代码、创建工作流和步骤，或使用队列进行并发控制。" risk: safe source: "https://docs.dbos.dev/" date_added: "2026-02-27"

DBOS TypeScript 最佳实践

构建可靠、容错的 TypeScript 应用程序指南，使用 DBOS 持久化工作流。

适用场景

在以下情况下参考这些指南：

• 将 DBOS 添加到现有 TypeScript 代码
• 创建工作流和步骤
• 使用队列进行并发控制
• 实现工作流通信（事件、消息、流）
• 配置和启动 DBOS 应用程序
• 从外部应用程序使用 DBOSClient
• 测试 DBOS 应用程序

按优先级分类的规则

| 优先级 | 类别 | 影响程度 | 前缀 | |--------|------|----------|------| | 1 | 生命周期 | 关键 | lifecycle- | | 2 | 工作流 | 关键 | workflow- | | 3 | 步骤 | 高 | step- | | 4 | 队列 | 高 | queue- | | 5 | 通信 | 中 | comm- | | 6 | 模式 | 中 | pattern- | | 7 | 测试 | 低-中 | test- | | 8 | 客户端 | 中 | client- | | 9 | 高级 | 低 | advanced- |

关键规则

安装

始终安装最新版本的 DBOS：

npm install @dbos-inc/dbos-sdk@latest

DBOS 配置和启动

DBOS 应用程序必须在运行任何工作流之前配置并启动 DBOS：

import { DBOS } from "@dbos-inc/dbos-sdk";

async function main() {
  DBOS.setConfig({
    name: "my-app",
    systemDatabaseUrl: process.env.DBOS_SYSTEM_DATABASE_URL,
  });
  await DBOS.launch();
  await myWorkflow();
}

main().catch(console.log);

工作流和步骤结构

工作流由步骤组成。任何执行复杂操作或访问外部服务的函数都必须使用 DBOS.runStep 作为步骤运行：

import { DBOS } from "@dbos-inc/dbos-sdk";

async function fetchData() {
  return await fetch("https://api.example.com").then(r => r.json());
}

async function myWorkflowFn() {
  const result = await DBOS.runStep(fetchData, { name: "fetchData" });
  return result;
}
const myWorkflow = DBOS.registerWorkflow(myWorkflowFn);

关键约束

• 不要在步骤内部调用、启动或入队工作流
• 不要使用线程或不受控的并发来启动工作流 - 使用 DBOS.startWorkflow 或队列
• 工作流必须是确定性的 - 非确定性操作放在步骤中
• 不要从工作流或步骤中修改全局变量

使用方法

阅读各规则文件获取详细说明和示例：

references/lifecycle-config.md
references/workflow-determinism.md
references/queue-concurrency.md

参考资料

• https://docs.dbos.dev/
• https://github.com/dbos-inc/dbos-transact-ts

限制

• 仅在任务明确匹配上述描述范围时使用此技能。
• 不要将输出视为特定环境验证、测试或专家审查的替代品。
• 如果缺少所需的输入、权限、安全边界或成功标准，请停下来寻求澄清。