跳转到文档

关注对话

时序图使用指南

通过参与者、调用、回复、分支和注释,构建按顺序进行的 API 与服务交互。

参与者与消息 → 时序图打开时序图工具

关注讨论

时序图是一个独立的视觉工作区,用于处理人、服务和系统之间的交互。参与者从左到右运行;时间向下流动。流程大纲和图表显示相同的有序模型。

选择 API 请求模板以探索客户端、Orders API、Auth 服务和数据库。该模板验证令牌并使用 if/else 组来返回订单或未授权响应。选择“空白图表”以构建您自己的对话。

构建 API 交互

  1. 为客户端和 API 添加参与者。在“流”面板或图表上选择一个参与者以编辑其名称、符号、颜色和从左到右的顺序。
  2. 空白画布将引导您完成参与者和您的第一条消息。选择新的姓名和消息文本,以便您可以立即键入。选择“消息”,然后在“详细信息”中编辑“发件人”、“收件人”和“消息”。“添加”栏显示新步骤将放置的位置以及谁发送了消息。消息将添加到所选步骤之后,在同一分支中。选择参与者将从该参与者开始下一条消息;选定的消息提供其端点。从选定的参与者添加的注释使用该锚点。如果没有选定的步骤,它将被添加到主流程中。
  3. 选择一个消息并使用 Add reply after this message 来反转其端点并添加一个虚线返回。拖动步骤以按时间顺序放置它们;预览会显示其目的地。Flow’s up/down 控件会在当前分支内重新排序。
  4. 使用分组 → 如果/否则、可选、循环或并行。选择一个分支以编辑其条件或在那里添加步骤。添加分支会在 else 回退之前插入。在流程中,每个分支都有自己的 + 按钮。
  5. 运行检查,查看图表,然后保存或导出结果。在手机上,使用“流”、“图表”和“详细信息”选项卡;“编辑详细信息”会打开选定的元素,“返回图表”会返回到画布。

在图上选择、移动和添加

点击参与者标题或生命线、消息、注释、组边框或分支区域以选中它。按 Enter 或 Space 键打开“详情”。左右拖动参与者标题以调整间距和顺序;垂直拖动消息、注释或整个组以设置其时间顺序并留出间距。在触摸屏上,拖动可见的把手;在其他地方滑动以滚动。

预览显示了建议的图表并命名其目标分支。拖放到另一个分支以传输步骤,或使用“详细信息”中的“移动步骤到”。创建和销毁保留在主流程中;组不能在自身内部移动。拖动以 8 像素为单位对齐。按 Escape 键或取消会使模型保持不变;释放会进行一次可撤消的更改。“整理”会恢复自动间距,同时保持您的顺序和分支。

点击“添加”栏,或者在桌面端将“参与者”、“消息”、“注释”或“组”拖放到图表上。组选项用通俗的语言解释了 If / else、Optional、Loop 和 Parallel。拖放预览和画布页脚会命名目标分支并显示其在时间上的位置。面板拖动从前两个参与者开始;拖动时会显示方向。在“详情”中选择消息端点;在生命线附近放下不会改变它们。

点击空白画布以清除选区。拖动空白画布或使用鼠标中键进行浏览,同时保持选区不变。可以在参与者之前添加组;其画布占位符和“Flow +”按钮会添加第一个参与者,然后提供第一条消息。

参与者与生命线

参与者 (Participant)、角色 (Actor)、边界 (Boundary)、控制 (Control)、实体 (Entity) 和数据库 (Database) 可更改标题符号。它们是交互中的角色,而非数据库表。名称和可选的不透明十六进制强调色随图表一起保存。

拖动参与者标题以定位它;附近的标题会移开以保持可读性。向左移动和向右移动可在显示顺序中交换其位置。消息端点保持不变。“参与者详情”提供“发送消息”和“添加注释”操作。发送给同一参与者的消息会自动变成自调用;单参与者图表会明确提供这一点。删除参与者还会删除涉及它的消息并移除其在注释中的锚点;“撤销”可恢复完整的更改。

调用、回复和生命周期

调用、回复和生命周期
类型含义
同步调用实线和实心箭头。发送者等待被调用的操作。
异步消息实线和空心箭头。发送者可以在不等待的情况下继续。
回复 / 返回返回调用方的虚线。添加回复可反转所选消息端点。
创建参与者创建应属于目标生命线的第一次交互。其表头从此消息开始。
销毁参与者X 标记目标的销毁。这应该是它的最后一次交互。
主流程中、片段外部支持创建和销毁。检查会标记不一致的生命线排序;无效排序会保持整个生命线可见,以免隐藏后续交互。

对分支进行分组而不丢失其含义

If / else (alt) 包含 2–6 个可选分支;正好选择一个匹配的操作数。可选 (opt) 包含一个条件分支。循环包含一个重复的分支;编写迭代条件。并行 (par) 包含 2–6 个操作数,其交互可以交织。

分支成员关系是显式的。流按钮和 Alt+Up/Down 可将步骤保持在其当前分支中。拖动操作可以将消息、注释或整个组传输到预览中命名的分支中;“移动步骤到”在“详细信息”中提供相同的选择。无效的目标会被禁用并带有原因,包括将组移动到自身内部、超过四个嵌套级别,或将创建/销毁置于分支内部。

将多分支组更改为可选或循环时,会提示是否仅保留其第一个分支。删除分支会提示是否删除其步骤;如果只剩下一个分支,该组将变为可选,而删除唯一的分支则会移除该组。删除组会连同其所有步骤一起删除,并需进行确认。撤销可恢复完整的更改。并行分支的垂直排列并不暗示它们之间的执行顺序。

备注、编号和激活

添加注释并选择它应跨越的参与者。注释在其框架内自动换行并随序列顺序移动。将它们用于约束或解释,而不是在消息箭头上放置段落。

查看控件消息编号和自动激活栏。这些外观选项会被保存并包含在图像导出中。编号提供阅读顺序;它们不是测量时间戳或跨并行分支的总执行顺序。

激活条根据同步调用和绘制的回复进行推断。自调用可以嵌套。替代分支是单独计算的,因此一个分支中的回复不会关闭另一个分支中的调用。缺少回复会使激活保持开放到该作用域结束;这是一个视觉辅助,而不是执行分析。

新图表以可读的比例开始;宽图表可以水平滚动。适合图表宽度可在保留垂直阅读的同时提供全局概览。滚动以进行探索,使用缩放控件,或按 Ctrl/Command 加滚动以围绕指针缩放。查找搜索参与者名称和类型、消息及其端点、备注、群组描述和条件。匹配的步骤保持其相关的分支上下文;排除了 ID 和位置。清除或按 Escape 可恢复完整的流程,空结果会解释可尝试的操作。选择流程或检查结果,或者添加元素,会将其标签带入视野而不改变缩放。在手机上,当你返回“图表”时会发生这种情况。画布滚动、缩放和选择是文档和撤销历史之外的工作区视图。

保存、共享和导入

新图表保留在内存中。保存会在需要时登录并创建一个独立的时序图云文件。“文件”→“打开时序图”会打开其自己的文件列表。在共享只读公共链接之前保存最新更改。公共查看器可以检查和导出,但不能编辑文件。

文件 → 下载 JSON 可保留完整的可编辑文档,包括参与者位置和步骤间距。云端保存和图像导出也会保留此布局。导入 JSON 接受导出的 Erd Go 时序图版本 1 文件(最大 4 MB),在替换前验证整个文件并支持撤销。旧文件保持自动间距;重叠的导入位置会安全显示。SQL、类图、Mermaid 和 PlantUML 不是导入格式。

文件 → 新建图表会再次打开空白/模板选择器。空白和 API 请求示例会替换现有模型(需确认并支持撤销)。未保存的图表在离开或重新加载时会进行提示。没有任何内容写入浏览器存储。

导出图表或文本源码

导出可创建 PNG、JPEG、WebP、独立矢量 SVG 或图像支持的 PDF。选择整个图表或当前视图(在手机上请先打开图表面板)以及高清、2K 或 4K 宽度。光栅尺寸限制为每边最多 8192 像素且 16 百万像素;非常高的图表可能会被缩减。对于可缩放的大型图表,请使用 SVG,或者使用当前视图来查看可读的部分。

文件 → 导出 PlantUML / Mermaid 可预览、复制和下载本地文本。文本渲染器控制其自身的布局和外观;参与者符号或颜色可能会有所不同。JSON 是完整的可编辑格式。没有源码发送到第三方渲染服务器。

Mermaid / API 请求流文本示例
sequenceDiagram
participant Client
participant API
participant Auth
participant Database
Client ->> API: GET /orders
API ->> Auth: verify token
Auth -->> API: identity
alt valid token
  API ->> Database: SELECT orders
  Database -->> API: orders[]
  API -->> Client: 200 OK
else invalid token
  API -->> Client: 401 Unauthorized
end
以可视方式构建此流程或使用 API 请求模板。此示例说明了文本导出;它不能导入到 Erd Go 中。

快捷方式和限制

快捷方式和限制
操作或限制行为
Ctrl/Cmd+S保存到云;在提示时登录。
Ctrl/Cmd+K打开并聚焦流面板中的“查找”。
Ctrl/Cmd+Z / Shift+Z / Ctrl+Y文本字段外的撤销/重做。文本字段保留本地编辑快捷方式。
Enter / Space打开聚焦图表元素的详细信息。
Alt+Left / Right将所选参与者向左或向右移动。
Alt+Up / Down在当前分支内移动所选步骤。
Delete / Backspace在文本字段外删除所选项,或使用画布上的垃圾桶按钮。参与者级联以及群组/分支移除需要确认。
在拖动期间按 Esc 键取消预览而不更改模型。
整理恢复自动间距,同时不改变顺序或分支;“撤销”可恢复布局。
参与者与步骤30 个参与者和 300 个总步骤,包括片段和注释。
文本每个参与者名称 80 个字符,每个消息/条件/组标签 240 个字符,每个注释 2,000 个字符。
文件与历史记录4 MB 导入的 JSON、3–255 个字符的云文件名以及 80 个撤销状态。

审查与排错

检查会标记空名称、重复的参与者名称、缺失的消息标签、空分支、缺失的条件以及不一致的创建或销毁顺序。选择一条发现以显示其“详情”。这些检查不会执行对话或证明 API 行为。

如果导入失败,您当前的图表将保持不变。较旧的挂起文件读取无法替换较新的文档、较新的导入或已编辑的模型。如果云端保存失败,请保持图表打开并在离开前下载 JSON。

使用 OMG UML 规范来理解交互符号的含义。PlantUML 和 Mermaid 有自己的文本语法;生成的文件的这些工具的导出文件,而不是 Erd Go 的导入语言。