如何用UML或替代方案展示Java框架的多项目依赖关系

UML 可用方案 #

你之前觉得类图无法满足需求是对的，类图是用来展示类级别细粒度关系的，展示粗粒度的库/项目依赖应该用UML组件图，这是UML原生适配这类需求的图类型：

• 每个元素（你的Java框架、第三方依赖、其他关联项目）都用UML标准组件符号（带侧边突出小矩形的矩形）表示，直接标注组件名称、版本号即可，不需要涉及任何类层面的细节
• 依赖关系用带箭头的虚线连接，箭头指向被依赖的一方，逻辑直观
• 可以额外添加UML注释节点，标注每个依赖的引入作用、适用版本范围等补充信息
  10个依赖的规模用组件图排版非常宽松，不会出现信息拥挤的问题，只需要记住上面2个基础符号规则就能绘制，学习成本极低。

非UML轻量化方案 #

如果不想遵守UML规范，也可以用更低成本的方式展示：

• 分层方块图：将你的Java框架放在最顶层，所有直接依赖放在下一层，如果需要展示传递依赖可以继续往下分层，用带箭头的实线/虚线表示依赖关系，排版逻辑自定义即可，不需要符合任何规范，只要依赖指向清晰就能看懂
• 原生依赖树：Java生态下可以直接执行构建工具命令导出依赖结构，Maven执行mvn dependency:tree，Gradle执行gradle dependencies，导出的文本结构天然带层级，10个依赖的规模可读性非常高，不需要额外绘图，信息完全准确不会出现手动绘制的错误。

选型建议 #

• 内部文档、技术交流场景优先用原生导出的依赖树，零成本、信息准确
• 对外公开文档、汇报场景优先用UML组件图或分层方块图，可读性更强，无技术背景的人员也能快速理解依赖结构

内容的提问来源于stack exchange，提问作者Said Savci