程序员必备技能:如何画好架构图?

Posted liuhongru

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了程序员必备技能:如何画好架构图?相关的知识,希望对你有一定的参考价值。

架构图分类

搜集了很多资料,分类有很多,有一种比较流行的是4+1视图,分别为场景视图、逻辑视图、物理视图、处理流程视图和开发视图。

 

  • 场景视图

场景视图用于描述系统的参与者与功能用例间的关系,反映系统的最终需求和交互设计,通常由用例图表示。

技术图片

  • 逻辑视图

逻辑视图用于描述系统软件功能拆解后的组件关系,组件约束和边界,反映系统整体组成与系 统如何构建的过程,通常由UML的组件图和类图来表示。

 

技术图片

 

  • 物理视图

物理视图用于描述系统软件到物理硬件的映射关系,反映出系统的组件是如何部署到一组可    计算机器节点上,用于指导软件系统的部署实施过程。

 

技术图片

 

  • 处理流程视图

处理流程视图用于描述系统软件组件之间的通信时序,数据的输入输出,反映系统的功能流程 与数据流程,通常由时序图和流程图表示。

 

技术图片

 

  • 开发视图

开发视图用于描述系统的模块划分和组成,以及细化到内部包的组成设计,服务于开发人员,反映系统开发实施过程。

 

技术图片

 

以上 5 种架构视图从不同角度表示一个软件系统的不同特征,组合到一起作为架构蓝图描述系统架构。

 

 

怎样的架构图是好的架构图


 

上面的分类是前人的经验总结,图也是从网上摘来的,那么这些图画的好不好呢?是不是我们要依葫芦画瓢去画这样一些图?

 

先不去管这些图好不好,我们通过对这些图的分类以及作用,思考了一下,总结下来,我们认为,在画出一个好的架构图之前, 首先应该要明确其受众,再想清楚要给他们传递什么信息 ,所以,不要为了画一个物理视图去画物理视图,为了画一个逻辑视图去画逻辑视图,而应该根据受众的不同,传递的信息的不同,用图准确地表达出来,最后的图可能就是在这样一些分类里。那么,画出的图好不好的一个直接标准就是:受众有没有准确接收到想传递的信息。

 

明确这两点之后,从受众角度来说,一个好的架构图是不需要解释的,它应该是自描述的,并且要具备一致性和足够的准确性,能够与代码相呼应。

 

 

画架构图遇到的常见问题


 

1、方框代表什么?

技术图片

为什么适用方框而不是圆形,它有什么特殊的含义吗?随意使用方框或者其它形状可能会引起混淆。

 

2、虚线、实线什么意思?箭头什么意思?颜色什么意思?

技术图片

随意使用线条或者箭头可能会引起误会。

 

3、运行时与编译时冲突?层级冲突?

技术图片

架构是一项复杂的工作,只使用单个图表来表示架构很容易造成莫名其妙的语义混乱。

 

 

本文推荐的画图方法


 

技术图片

 

C4 模型使用容器(应用程序、数据存储、微服务等)、组件和代码来描述一个软件系统的静态结构。这几种图比较容易画,也给出了画图要点,但最关键的是,我们认为,它明确指出了每种图可能的受众以及意义。

 

下面的案例来自C4官网,然后加上了一些我们的理解,来看看如何更好的表达软件架构

 

1、语境图(System Context Diagram)

 

 

技术图片

这是一个想象的待建设的互联网银行系统,它使用外部的大型机银行系统存取客户账户、交易信息,通过外部电邮系统给客户发邮件。可以看到,非常简单、清晰,相信不需要解释,都看的明白,里面包含了需要建设的系统本身,系统的客户,和这个系统有交互的周边系统。

 

用途

这样一个简单的图,可以告诉我们,要构建的系统是什么;它的用户是谁,谁会用它,它要如何融入已有的IT环境。这个图的受众可以是开发团队的内部人员、外部的技术或非技术人员。即:

 

  • 构建的系统是什么

  • 谁会用它

  • 如何融入已有的IT环境

 

怎么画

中间是自己的系统,周围是用户和其它与之相互作用的系统。这个图的关键就是梳理清楚待建设系统的用户和高层次的依赖,梳理清楚了画下来只需要几分钟时间。

 

2、容器图(Container Diagram)

容器图是把语境图里待建设的系统做了一个展开。

 

技术图片

 

上图中,除了用户和外围系统,要建设的系统包括一个基于javaspring mvc的web应用提供系统的功能入口,基于xamarin架构的手机app提供手机端的功能入口,一个基于java的api应用提供服务,一个mysql数据库用于存储,

各个应用之间的交互都在箭头线上写明了。

 

看这张图的时候,不会去关注到图中是直角方框还是圆角方框,不会关注是实线箭头还是虚线箭头,甚至箭头的指向也没有引起太多注意。

 

我们有许多的画图方式,都对框、线的含义做了定义,这就需要画图的人和看图的人都清晰的理解这些定义,才能读全图里的信息,而现实是,这往往是非常高的一个要求,所以,很多图只能看个大概的含义。

 

用途

这个图的受众可以是团队内部或外部的开发人员,也可以是运维人员。用途可以罗列为:

 

  • 展现了软件系统的整体形态

  • 体现了高层次的技术决策

  • 系统中的职责是如何分布的,容器间的是如何交互的

  • 告诉开发者在哪里写代码

 

怎么画

用一个框图来表示,内部可能包括名称、技术选择、职责,以及这些框图之间的交互,如果涉及外部系统,最好明确边界。

 

3、组件图(Component Diagram)

技术图片

组件图是把某个容器进行展开,描述其内部的模块。

 

用途

这个图主要是给内部开发人员看的,怎么去做代码的组织和构建。其用途有:

 

  • 描述了系统由哪些组件/服务组成

  • 厘清了组件之间的关系和依赖

  • 为软件开发如何分解交付提供了框架

 

4、类图(Code/Class Diagram)

技术图片

这个图很显然是给技术人员看的,比较常见,就不详细介绍了。

 

 

案例分享


 

下面是内部的一个实时数据工具的架构图。作为一个应该自描述的架构图,这里不多做解释了。如果有看不明白的,那肯定是还画的不够好。

技术图片

画好架构图可能有许多方法论,本篇主要介绍了C4这种方法,C4的理论也是不断进化的。但不论是哪种画图方法论,我们回到画图初衷,更好的交流,我们在画的过程中不必被条条框框所限制。简而言之,画之前想好:画图给谁看,看什么,怎么样不解释就看懂。

 

参考资料:

C4官网:

https://c4model.com/

 

为什么需要软件架构图:

https://www.infoq.cn/article/GhprrUlOYyOqS8*FR1pH

书籍:《程序员必读之软件架构》

 

以上是关于程序员必备技能:如何画好架构图?的主要内容,如果未能解决你的问题,请参考以下文章

程序员必备画图技能之——流程图

软帝学院七点java程序员进阶必备技能

java程序员面试宝典pdf下载,大厂面试必备技能

[架构之路-102]:《软件架构设计:程序员向架构师转型必备》-12-粗粒度“软件架构的功能模块”划分,架构师必备基础技能

程序员进阶架构师必备架构基础技能:并发编程+JVM+网络+Tomcat等

阿里P8架构师谈:java程序员到架构师,需突破的7大必备技能!