跳转到文档

模型类与契约

类图使用指南

以可视化方式构建类,定义成员与关系、检查模型、整理包,并保存或导出图表。

类与关系 → 类图打开类图工具

设计类及其职责

类图是用于类、抽象类、接口和枚举的独立可视工作区。每个分类器都有一个名称、一个属性或字面量舱段以及一个操作舱段。抽象名称采用斜体;接口和枚举显示其构造型。选择一个类并使用“标题颜色”选择预设、自定义颜色或“中性”。标题颜色会被保存,支持撤销/重做,并显示在图像导出中;成员文本保持清晰易读。

新图表要求您选择“空白图表”或“订单系统模板”。新图表保留在内存中,直到保存到云端或作为 JSON 下载。其紧凑的编辑器栏包含图表名称、文件菜单、撤销/重做、主题控制和图像导出。类图云文件与 SQL、Prisma 和 ERD 构建器文档是分开的。

构建您的第一个类图

  1. 打开类图并选择空白图表或订单系统模板。文件 → 新建图表再次打开选择器;文件 → 空白可在确认并撤销后替换当前图表。
  2. 点击“类”或将其从库中拖放到画布上,然后在检查器中将其重命名为 Customer(在窄屏幕上使用“编辑详情”),并添加一个可见性为“私有 (-)”且类型为 UUID 的 id 属性。
  3. 对于自定义分类器,请选择“自定义分类器”或编辑任何现有分类器上的可选“构造型”字段。诸如 entity、service 或 controller 等标签会以 «your tag» 的形式显示在名称上方,并包含在云文件、JSON 和图像导出中。它们保留所选基础分类器的行为;该工具不验证 UML 配置文件。
  4. 添加另一个名为 Order 的类。添加一个诸如 calculateTotal 的操作,返回类型为 Decimal。引导字段在您提交之前显示预览。
  5. 从关系库中选择“关联”。当选中某个类时,“从”将以所选类开始。将“从”设置为 Customer,将“从”设置为 Order,然后创建它。选择连接器以添加标签和多重性。
  6. 要同时创建这两个项,请选择一个类并选择“连接新建”。添加连接类允许您选择新的分类器、可选名称、关系和方向。继承和实现最初将新的子类或实现者指向选定的父类或契约;其他类型最初从选定的类指向新的类。创建连接类在一个撤销步骤中提交两者;取消或 Escape 将放弃表单。
  7. 使用“排列和适应图表”,然后从“文件”下载 JSON 以获取可编辑备份,或者“导出”图表为 PNG、JPEG、WebP、矢量 SVG 或 PDF。

属性、字面量和可见性

选择一个分类器并使用 Fields 添加一个具有名称、必需类型、可见性和可选默认值的属性。类型建议包括常见类型和分类器名称;允许自定义类型。Add 或 Save changes 会在一个编辑中提交预览。Cancel 或 Escape 会放弃待处理的表单。

使用 + 表示公有,- 表示私有,# 表示保护,~ 表示包可见性。文本模式每行接受一个成员。格式化功能仅整理支持的有效签名;自定义符号保持为文本,并在其他行更改时保留。

枚举使用字面量代替属性。输入字面量名称和可选值,例如 ACTIVE = "active"。引导字段会拒绝重复的成员名称。即使无法在字段中表示,自定义文本也会被保留。

UML attributes / 属性签名
- id: UUID
+ displayName: String
# active: Boolean = true
~ tags: List<String> = []
成员语法是一个保守的编辑辅助工具,而不是完整的 UML 或编程语言类型检查器。类型名称不会自动创建或链接其他分类器。

操作与带类型的参数

操作具有可见性、名称、带可选默认值的带类型参数以及可选的返回类型。添加参数会插入一个输入行;其删除按钮会删除该待处理的参数。新操作默认返回类型为 void。

在文本模式下,写入 name(parameter: Type): ReturnType,并带有可选的可见性前缀。支持嵌套泛型类型和带引号的默认值。每个参数都需要一个不同的名称和类型。当重载的参数类型不同时,它们可以共享一个操作名称。

UML operations / 操作签名
+ placeOrder(items: List<OrderItem>): Order
+ findOrders(status: String = "open"): List<Order>
- calculateTotal(): Decimal

选择关系符号

悬停或通过键盘聚焦某个类(在触摸屏上点击选择)以显示其连接点,然后将其拖动到另一个类以建立关联。连接点在静止状态和只读图表中保持隐藏。您也可以从库中选择关系。检查器允许您更改类型、端点、标签以及诸如 1、0..1 或 0..* 等端点多重性。多重性是可编辑的文本;该工具不会推断业务规则。

每个多重性都有 1、0..1、0..* 和 1..* 预设。自定义文本保持可编辑状态并会被保留。关系含义解释了实际方向、父/合同或整体/部分以及关联计数:To 多重性计算每个 From 的实例数;From 多重性计算反向。指南不添加语义验证。

关系名称直接位于连接线中点附近的上方。多重性保持在其自身的类边界附近,并避开 UML 头部。标签会跟随实时拖拽,释放时则与其他标签对齐。长文本会自动换行;如果标签无法放入行中,拥挤的路径可能需要一个清晰的备选方案。

角色和导航在相关类旁边添加了可选的 From role 和 To role。不同的角色或标签区分并行结构链接,例如 billingAddress 和 shippingAddress。关联导航可以指向 From、To 或两者。其他关系类型保留其语义头部。

该工具会拒绝缺失的端点、完全相同的方向/类型/标签/结构角色重复项、继承周期以及自继承或自实现。仅多重性、导航和路径更改不会构成不同的链接。关联、聚合、组合和依赖关系可以连接一个类到自身。这些结构检查不能建立完整的 UML 语义有效性。

选择关系符号
关系方向与符号
关联相关分类器之间的连线;可选的导航箭头指向可到达的类。支持递归链接。
继承From 是子类。实线在父级 To 处以空心三角形结束。
实现From 实现了 To 处的契约。虚线在 To 处以空心三角形结束。
聚合(Aggregation)From 是整体,To 是部分。空心菱形属于 From。
组合From 拥有 To 的生命周期。实心菱形属于 From。
依赖关系From 依赖于 To。虚线开放箭头指向 To 处的供应方。

自动侧边、固定头部和路径

弯曲是新图表的默认设置。画布工具栏中的“视图 → 连接路径”提供“弯曲”和“折线”选项,用于设置所有路径和新连接的默认值。折线使用带有小圆角的水平和垂直段。选择连接器可单独覆盖其线条路径。

随着类移动或调整大小,新连接会自动选择合适的侧面。左侧和右侧连接附加在页眉处。顶部和底部附加在相应的卡片边界上。在检查器中选择顶部、底部、左侧或右侧仅固定该端点;其伙伴可以继续自动跟随。

在起点侧或终点侧选择器中选择“自动”,该端就会跟随类的位置调整。“自动侧边”会解除两端的固定。拖动选中的端点可更换侧边,拖动中心圆点可调整连线弯曲。Escape 取消;Home 或双击重置弯曲。“重置连接”恢复自动布线。调整支持撤销、保存和图片导出。

路径会避开与其连接的卡片;递归链接在类外部成环,平行链接使用单独的路线。排列和自动侧面可提高可读性,但不能保证避开所有不相关的卡片或其他连接。没有侧面模式的旧 JSON 草稿会保留其保存的侧面,直到你选择“自动”。

检查模型并安全重命名

检查会打开“错误”、“警告”和“建议”,用于成员符号、名称、多重性边界和继承结构。选择一个问题以显示其类或关系以及相关字段。检查会保留自定义文本,绝不会自动修复,也不充当编程语言编译器。

在选定的类中执行“重命名并包含引用…”可预览属性、操作参数和返回类型中的确切类型引用。选择要更新的引用,然后将名称和引用作为一个撤销步骤应用。自定义符号、默认值、符合条件的外部类型以及对重复分类器名称的模糊引用保持不变。

选定的类型替换必须符合每个成员隔间的 8,000 个字符限制。如果建议的更新将超出此限制,请取消选择一些引用或清除所有引用选择以仅重命名类。该工具会拒绝过大的更新,而不是截断成员文本。

对齐、分布和锁定类

布局提供选定类对齐、相等的水平/垂直间距、排版选中项、位置锁以及“对齐参考线吸附”切换开关。按住 Ctrl/Cmd 并点击以选择类。锁定的类在拖动、包移动和排版期间保持固定;锁定状态在保存后保留。相等的间距会保留外部类,并使拥挤的跨度保持不变。选中项排版会使其他类保持固定,并将所选块放置在不与其重叠的位置,或者在没有合适位置时保持图表完整。单类拖动会在六个屏幕像素内吸附;参考线及其开关保留在保存的文件之外。

排列和导航画布

点击“排列”进行智能排列。它利用类的大小和关系结构,将父类和接口放置在子类上方,并分隔断开连接的组。下拉菜单还提供“从左到右”、“从上到下”和“紧凑”选项。

排列可保留关系含义和固定的端点侧,更新自动侧,并使结果适合画布。撤消操作可一步将其还原。如果在布局引擎加载时文档发生更改,则陈旧的结果将被丢弃;请针对新文档再次排列。

大型布局在保存的位置限制内一起移动。如果排版放不下,您的图表将保持完整;请尝试“仅名称”或其他方向,然后重新排版。

拖动类来定位它们,拖动空白画布来进行平移,滚动进行缩放。“适应图表”和缩放控件有助于导航;小地图显示了概览。在宽度达 900px 时,检查器会移动到画布下方。选择类或连接并选择“编辑详情”(在共享文件中为“查看详情”)即可访问它;“返回图表”可回到画布。选择关系会在视图中打开其表单。类图指南会在单独的选项卡中打开,以便当前的草稿保持开启状态。

使用“查找”或 Ctrl/Cmd+K 搜索名称、构造型、属性、操作、包名和注释。使用向上/向下箭头和回车键选择并居中显示结果;成员结果会显示该类的完整详细信息并聚焦其对应的检查器部分。按 Esc 键关闭“查找”。“聚焦连接”会强调选定的类和直接相邻的元素,同时使无关元素变暗;“显示全部”或 Esc 键可退出聚焦。

点击画布工具栏中的“打开视图”以选择“全部详细信息”、“仅属性”或“仅名称”。“仅属性”保留属性或枚举文字并汇总操作;“仅名称”显示成员计数。悬停、聚焦或选择一个类以覆盖其详细信息级别,或选择“图表默认”以继承。更改全局级别会清除覆盖。聚焦和详细信息也在共享文件中起作用,保留在保存的文档和撤销/重做之外,并且不会更改成员文本。图像遵循所选的详细信息级别;JSON 和云文件保留完整的成员。

按住 Ctrl/Cmd 键的同时点击以选择一组。紧凑的选择工具栏在适用时提供“聚焦”、“复制”和“连接新建”;“更多选择操作”包含“复制选择”、“创建包”和“删除选择”。移动端的“编辑详情”或“查看详情”仍会打开检查器。“复制选择”会创建一个偏移副本;当浏览器剪贴板可用时,“复制选择”和“粘贴”可以在类图之间传输类或注释。内存中的副本支持在工作空间内进行“粘贴”。副本将获得新的 ID 和未使用的名称,保留组偏移量和内部关系,并且仅在复制了其所有类时才包含一个包。选择一个包会复制其所有成员。重复复制或粘贴算作一个撤消步骤;文本字段保持本地的复制/粘贴行为。

在包中添加注释和分组类

备注 — 添加注释会创建一个备注并在检查器中聚焦备注文本;空白的画布备注显示为“写个备注……”。将备注附加到链接,会通过虚线拴绳将其连接到类或关系;备注保持在放置的位置,而拴绳跟踪目标。删除目标会使备注分离并保留其文本。长备注换行显示为有界的预览;完整文本仍然可编辑。

包 — “编组类”可立即将选定的类归组。在未选中任何项的情况下,选择成员和一个可选的包名,然后点击“创建包”。每个类最多属于一个包。拖动其标题可将成员一起移动,除非某个成员已被锁定位置。“取消编组类”仅移除边框。使用标题折叠箭头或检查器将包折叠为带有外部连接的类计数。“查找”和“检查”会展开包以显示成员。包仅为视觉分组,并非命名空间或语义关系端点。折叠仅限视图:JSON/云端保留所有成员和链接;图片与显示的视图相匹配。

云文件、便携式 JSON 和图像

文件 → 导出 PlantUML 可预览可编辑源码并提供复制文本或下载 .puml。它在本地导出完整的成员、种类、构造型、颜色、角色/导航/多重性、包和备注。PlantUML 会选择自己的布局,因此画布位置、固定侧、位置锁定和折叠视图不会被导出。请使用 JSON 来保留完整的可编辑图表。PlantUML 导入不可用。

类图不会将图表保存在浏览器存储中。新图表保留在内存中。需要时点击“保存”(Ctrl/Cmd+S)登录并创建或更新独立的类图云文件。“文件”→“打开类图”可打开其专属的可搜索文件列表。“文件”→“共享类图”可控制公共访问权限;查看者可以检查和导出,但不能编辑。未保存的图表在离开或重新加载时会进行提示。从“文件”下载 JSON 以保留可编辑副本,并使用“导入 JSON”重新打开导出的 1 版 Erd Go 类图文件。导入在替换前会经过验证。

空白、示例和导入在替换非空图表前会进行提示并支持撤销。导出图表提供 PNG、JPEG、WebP、独立矢量 SVG 以及白色背景的带图像 PDF。可捕获整个图表(默认,包含屏幕外的类)或当前视图。HD、2K 和 4K 预设可在每边 8192 像素和 16 百万像素的限制内保持比例;矢量 SVG 可自由缩放。保留 JSON 或云端文件以便进一步编辑图表。

可选备注和包扩展了现有的 1 版格式;旧文件在没有它们的情况下仍然可以打开。限制为:200 个分类器、600 个关系、100 个最多 2,000 个字符的备注、50 个包、每个成员分部 8,000 个字符,以及 32 MB 的导入 JSON 文件。云文件名必须包含 3–255 个字符。离开前请保存到云端或下载 JSON 以保留未保存的图表。旧的浏览器本地草稿将保持不变,并且不再自动打开。

此工具不支持源代码生成、SQL 转换和文本到图的导入。

键盘快捷键

键盘快捷键
操作快捷方式
保存到云Ctrl/Cmd+S。如果出现提示,请登录。
查找类、成员、包或备注Ctrl/Cmd+K,然后按向上/向下箭头和回车键。
复制/粘贴选中项从画布使用 Ctrl/Cmd+C / Ctrl/Cmd+V。粘贴需要可编辑的图表。
复制所选内容从画布使用 Ctrl/Cmd+D。
撤销/重做从画布使用 Ctrl/Cmd+Z / Ctrl/Cmd+Shift+Z 或 Ctrl/Cmd+Y。
删除所选从画布中删除或退格。删除类也会移除与其关联的关系。
选择连接器侧聚焦选定的连接器头部并使用方向键。
取消或关闭按 Esc 键可取消成员、连接类、包表单或连接器头部的预览,关闭查找或菜单,或退出画布上的焦点连接。
撤销/重做可保留多达 80 个文档更改。聚焦的文本编辑或节点拖动会被分组;相机更改会保留在历史记录之外。画布快捷方式在您编辑字段或使用表单或打开菜单时不会删除图表元素。

对您的图表进行故障排除

对您的图表进行故障排除
症状尝试什么
头部停留在意外的一侧检查该端是否已固定。选择其“自动”控件以恢复自动放置。
关系被拒绝检查端点、完全重复项、自我继承/实现以及继承循环。为不同的结构链接赋予不同的角色或标签。
无法保存成员提供必需的名称/类型,删除重复的参数名称或成员签名,并查看验证消息。对不支持的自定义表示法使用 Text。
表单提示成员已更改在撤销或其他文本编辑后取消并重新打开它,以使用当前成员版本。
类或成员不可见使用查找或 Ctrl/Cmd+K。成员结果显示完整详细信息并聚焦匹配的检查器部分;拟合图表和迷你地图也有帮助。
无法导入文件选择导出的 Erd Go 类图 JSON 文件,而不是 SQL、构建器文件、SVG 或建模计划。出错时会保留当前的图表。
云端保存失败保持图表打开,检查您的登录和连接状态,然后重试。离开页面之前请下载 JSON,以保留可编辑的备份。

使用 AI 规划类模型

使用 Copy AI Prompt 与您的助手共享此指南,然后描述职责、所有权、继承和多重性。在需求使关系模糊不清时请求澄清。

请求分类器名称、成员签名以及带有显式“来自”和“到”角色的关系列表。使用可视库和检查器构建结果。以下计划是描述性的,而不是导入语言。

Modeling plan / UML 建模计划
Class Customer
  Attribute: - id: UUID
  Operation: + placeOrder(items: List<OrderItem>): Order

Class Order
  Operation: + calculateTotal(): Decimal

Association: Customer → Order
  Label: places
  Customer end: 1
  Order end: 0..*