程序员你是怎么绘制架构图?

Container容器

元素如下:

元素名称 函数
容器 Container
容器数据库 ContainerDb
容器虚框 Container_Boundry

元素如下:

元素名称 函数
组件 Component
组件数据库 ComponentDb

即通用的,元素如下:

元素名称 函数
虚框 Boundry
从上到下关系 Rel
反向关系 Rel_Back
从上到下关系 Rel_U
从下到上关系 Rel_D
从左到右关系 Rel_L
从右到左关系 Rel_R

代码级别可使用PlantUML绘制时序图,流程图,类图描述具体接口或者功能的实现细节;

这块是PlantUML的基础知识了,不详细展开,自行查阅资料即可。

它是两个东西的合体,提供了一种简单的方法来描述和沟通软件架构。

C4模型对软件架构来说是一个抽象第一的绘图方式。基于抽象,可以反映出软件架构师和开发者是如何思考和构建软件的。 少量的抽象和绘图类型是的C4模型很容易学习和使用; C4代表着context,containers,components,code;这一系列水平层级的图,你可以使用它来从不同的尺度向不同的听众描述你的软件架构。

C4模型和plantUML 分工如下:

技术点 用途
plantUML 写简单的代码即可绘图
c4模型 一种对系统架构的抽象的方法论
C4PlantUML 定义一种C4模型的绘图风格,使用PlantUML进行文本绘图

使用方式: 下载C4PlantUML 选择你熟悉的IDE集成即可使用;

IDE 使用方式
vscode 安装 PlantUML 和 PlantUML Preview 插件 , Jdk , graphviz
vscode引入
.vscode/C4.code-snippets.
idea 下载plantUML插件,安装好 graphviz
打开C4PlantUML文件即可

命名规则:

  • context 上下文图
  • container 容器图
  • component 组件图
  • sequence 时序图
  • usecase 用例图
  • class 类图
  • activity 活动图
  • state 状态图
  • object 对象图
  • deployment 部署图
  • timing 定时图

绘图步骤:

1.创建模型图名,按照上面的命名规则, xxx_项目名称.puml;

2.引入相对路径下的 path/C4_Component.puml

3.使用内置的函数,绘图;

小结

如果看完之后你只能记住一句话:C4PlantUML提供了一个绘图方式让你轻松的描述和表达软件架构;

C4模型图.png

想要我的学习资料吗留下你的评论。

声明:本站部分文章及图片源自用户投稿,如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢!

上一篇 2020年8月1日
下一篇 2020年8月1日

相关推荐