什么是类图?
类图是 UML 结构图,用于对面向对象系统的静态结构进行建模。它们显示类、属性、方法以及它们之间的关系(继承、关联、组合、聚合)。类图作为软件架构的蓝图,帮助开发人员在编写代码之前可视化系统设计。
编辑与预览
使用 Mermaid 语法创建 类图,实时查看效果。
常见使用场景
软件架构规划
在实现之前设计应用程序的结构。定义类、职责以及它们如何交互以构建可维护、可扩展的系统。
面向对象设计
建模继承层次结构、接口和抽象类。可视化多态性、封装和设计模式,如工厂、单例或观察者模式。
代码文档
生成现有代码结构的可视化文档。帮助新团队成员快速理解复杂的类层次结构和依赖关系。
数据库架构规划
将对象模型映射到数据库表。在实现 ORM 模型或数据库架构之前识别实体、关系和基数。
核心功能
类结构定义
定义类名、带有可见性修饰符(public、private、protected)的属性,以及带有返回类型和参数的方法。
关系类型
使用适当的 UML 表示法对继承(泛化)、关联、聚合、组合和依赖关系进行建模。
接口和抽象类
使用标准 UML 约定和构造型区分具体类、抽象类和接口。
多重性和约束
指定关系基数(1..1、1..*、0..*)并添加约束或注释以阐明业务规则和设计决策。
最佳实践
从核心类开始
从最重要的领域实体开始,逐步添加支持类。不要试图一次对所有内容建模。
使用适当的可见性
用适当的可见性标记属性和方法:+ 表示公共,- 表示私有,# 表示受保护。这记录了封装决策。
显示相关关系
只包含有意义的关系。不是每个类交互都需要显示——专注于架构意义。
保持图表专注
为不同的子系统创建多个较小的图表,而不是一个庞大的图表。每个图表都应该讲述一个清晰的故事。
探索其他图表类型
流程图
用节点和方向箭头可视化流程、工作流和算法。非常适合业务流程和决策树。
时序图
记录不同参与者或系统之间的时序交互。非常适合 API 文档和系统设计。
状态图
表示系统或应用程序中的状态转换。非常适合建模生命周期状态和工作流。
甘特图
规划和跟踪项目时间线、任务和依赖关系。非常适合项目管理和进度安排。
ER 图
设计包含实体和关系的数据库架构。非常适合数据库建模和文档编写。
用户旅程图
绘制用户在各个接触点的体验和交互。非常适合用户体验设计和客户旅程分析。
Git 图
可视化 Git 分支策略和提交历史。有助于解释版本控制工作流。
思维导图
组织创意、头脑风暴和创建层次化视觉结构。适合规划和知识管理。
饼图
以圆形图表展示数据比例分布。适合显示百分比和市场份额分析。
时间线
沿时间轴可视化事件和里程碑。适合项目历史和路线图展示。
看板
将任务按工作流阶段组织到列中。适合敏捷项目管理和任务追踪。
四象限图
在双轴网格上绘制项目进行比较和优先级排序。适合功能优先级和战略分析。
桑基图
用比例箭头可视化节点间的流量。适合能源流、预算分配和转化漏斗。
XY 图表
创建带有可自定义坐标轴的柱状图和折线图。适合数据可视化和趋势分析。
块状图
用行列排列的块构建结构化布局。适合系统架构和组件概览。
架构图
使用服务图标和连接设计云和系统架构。适合基础设施文档。
数据包图
可视化网络协议数据包结构和位级字段布局。适合网络协议文档。