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

本文转载自微信公众号:阿里巴巴中间件


640?wx_fmt=jpeg

️ Photo by Kelly Sikkema on Unsplash


技术传播的价值,不仅仅体现在通过商业化产品和开源项目来缩短我们构建应用的路径,加速业务的上线速率,也体现在优秀工程师在工作效率提升、产品性能优化和用户体验改善等经验方面的分享,以提高我们的专业能力。


本文作者阿里巴巴技术专家三画,分享了自己和团队在画好架构图方面的理念和经验,首发于阿里内部技术分享平台,阿里巴巴中间件授权转载,梓敬、鹏升和余乐对此文亦有贡献。


当我们想用一张或几张图来描述我们的系统时,是不是经常遇到以下情况:


  • 对着画布无从下手、删了又来?

  • 用一张图描述我的系统,并且让产品、运营、开发都能看明白?

  • 画了一半的图还不清楚受众是谁?

  • 画出来的图到底是产品图功能图还是技术图又或是大杂烩?

  • 图上的框框有点少是不是要找点儿框框加进来?

  • 布局怎么画都不满意……


如果有同样的困惑,本文将介绍一种画图的方法论,来让架构图更清晰。



先厘清一些基础概念



1、什么是架构

架构就是对系统中的实体以及实体之间的关系所进行的抽象描述,是一系列的决策。


架构是结构和愿景。


系统架构是概念的体现,是对物/信息的功能与形式元素之间的对应情况所做的分配,是对元素之间的关系以及元素同周边环境之间的关系所做的定义。


做好架构是个复杂的任务,也是个很大的话题,本篇就不做深入了。有了架构之后,就需要让干系人理解、遵循相关决策。


2、什么是架构图

系统架构图是为了抽象的表示软件系统的整体轮廓和各个组件之间的相互关系和约束边界,以及软件系统的物理部署和软件系统的演进方向的整体视图。


3、架构图的作用

一图胜千言。要让干系人理解、遵循架构决策,就需要把架构信息传递出去。架构图就是一个很好的载体。那么,画架构图是为了:


  • 解决沟通障碍

  • 达成共识

  • 减少歧义


4、架构图分类

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


  • 场景视图

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

640?wx_fmt=png

  • 逻辑视图

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


640?wx_fmt=jpeg


  • 物理视图

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


640?wx_fmt=png


  • 处理流程视图

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


640?wx_fmt=jpeg


  • 开发视图

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


640?wx_fmt=png


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



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



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


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


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



画架构图遇到的常见问题



1、方框代表什么?

640?wx_fmt=jpeg

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


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

640?wx_fmt=png

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


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

640?wx_fmt=png

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



本文推荐的画图方法



640?wx_fmt=png


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


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


1、语境图(System Context Diagram)



640?wx_fmt=png

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


用途

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


  • 构建的系统是什么

  • 谁会用它

  • 如何融入已有的IT环境


怎么画

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


2、容器图(Container Diagram)

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


640?wx_fmt=jpeg


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

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


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


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


用途

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


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

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

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

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


怎么画

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


3、组件图(Component Diagram)

640?wx_fmt=png

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


用途

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


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

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

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


4、类图(Code/Class Diagram)

640?wx_fmt=png

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



案例分享



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

640?wx_fmt=jpeg

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


参考资料:

C4官网:

https://c4model.com/

为什么需要软件架构图:

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

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




—————END—————




喜欢本文的朋友们,欢迎长按下图关注订阅号程序员小灰,收看更多精彩内容


640?wx_fmt=jpeg

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/bjweimengshu/article/details/88386734

智能推荐

如何在2023年将fydeOS/ChromeOS自带linux子系统更改为arch?_fyde os root-程序员宅基地

文章浏览阅读1.2k次,点赞25次,收藏14次。之前已经有人写过类似教程了。但是,随着chromeos的版本更新,过去的操作变得不再适用。_fyde os root

python 3d大数据可视化软件_5个最受欢迎的大数据可视化工具!-程序员宅基地

文章浏览阅读358次。想像阅读书本一样阅读数据流?这只有在电影中才有可能发生。 在现实世界中,企业必须使用数据可视化工具来读取原始数据的趋势和模式。大数据可视化是进行各种大数据分析解决的最重要组成部分之一。 一旦原始数据流被以图像形式表示时,以此做决策就变得容易多了。 为了满足并超越客户的期望,大数据可视化工具应该具备这些特征:1· 能够处理不同种类型的传入数据2· 能够应用不同种类的过滤器来调整结果3· 能够在分析过..._大数据3d工具

React —> input标签输入中文的拼音时候会触发onChange事件解决_ui input中文输入快速触发onchage-程序员宅基地

文章浏览阅读2.4k次。在React开发项目的过程中,避免不了会用到input标签(比如在登录、录入用户信息等界面),而使用input标签时候,为了体验限制只能输入数字、或者只能输入数字或者字母、或者只能输入英文等限制条件。今天在这里记录一下在项目中遇到的一个问题,描述如下:在做用户登录界面,用户登录名字可以是数字、字母或者是数字和字母的组合,在控制用户输入只能是数字或者字母的时候,用IOS的全键盘输入汉字,在还没有..._ui input中文输入快速触发onchage

802.11e(Direct Link Protocol,DLS)_启用终端直通(dls)-程序员宅基地

文章浏览阅读443次。由于蜂窝网是需要基站负责数据的中转的,但是有时会出现节点与节点间距离比较近,通信质量比较好,而节点与基站间都距离比较远,通信质量比较差的情况。所以此时,如果能让节点与节点间直接形成链路,那么就最好的了。那么解决这个问题的技术就是D2D技术。在802.11中,由于本身就存在支持节点与节点间连接的Ad-hoc模式(IBSS模式),所以D2D技术需求并没有很大。Remark:如果AP或者目标节点不支持DLS,那么AP在接收到STA1的DLS request后,会直接反馈response,指示无法建立连接。_启用终端直通(dls)

windows释放GPU内存方法_释放gpu内存软体-程序员宅基地

文章浏览阅读3.6w次,点赞13次,收藏55次。在进行pytorch训练的时候,会出现类似以下错误:RuntimeError: CUDA out of memory. Tried to allocate这表示显卡内存不足,搜索怎么释放显卡的内存的时候,大多都是linux下的解决方法。windows下可以这样做:打开cmd窗口,输入nvidai-smi查看显卡使用情况如图可以看到下边有个PID表示进程id,然后打开任务管理器,点击详细信息,根据pid找到需要释放的进程结束即可。..._释放gpu内存软体

python的wxpy库_Python库学习 wxpy - 微信机器人-程序员宅基地

文章浏览阅读433次。本周考虑到实现一个微信机器人的功能,研究了一下 wxpy 这个库参考文档简单的demo例子1:获取聊天群里面所有@我的消息,并回复信息#!/usr/bin/env python# -*- coding: utf-8 -*-from wxpy import *bot = Bot(cache_path=True)# 机器人账号自身myself = bot.self# 给机器人自己发送消息bot.sel..._wxpy库详解

随便推点

慕课网导航的html_慕课网导航栏怎么写html-程序员宅基地

文章浏览阅读359次。<!DOCTYPE html><html lang="en"><head> <meta charset="UTF-8"> <title>float</title> <style> *{ padding: 0; margin..._慕课网导航栏怎么写html

One To Many‘ attribute value type should not be ‘Comment‘_one to many' attribute value type should not be-程序员宅基地

文章浏览阅读2.3k次。One To Many’ attribute value type should not be ‘Comment’今天在写项目的时候发现一直报这个错,有可能的原因是这个原因:我项目中使用的是spring data jpa ,框架会把该属性当成数据库的一个字段,而set不是mysql的数据类型;但是我自己的问题是忘记把实体类加上注解了entity的注解了,没加的话jpa不会将它识别为一个数据库的表,所以也会产生这个错误@Entity(name = "t_comment")@Tablepubl_one to many' attribute value type should not be

大咖访谈 | 做开源,最核心的就是要随缘 —— Apache SkyWalking 创始人吴晟-程序员宅基地

文章浏览阅读1k次。转载自| 开源雨林编辑|高旖阳责编| 钱英宇本期访谈阵容嘉宾:吴晟 ShengWu•Tetrate 创始工程师,Apache 软件基金会首位华人董事,开源 APM 项目 Apache SkyWalking 创始人,分布式追踪与诊断技术专家,骨灰级开源社区爱好者。主持:庄表伟•开源社理事、华为开源管理中心开源专家。常年参与社区各类活动,热心开源治理、开源成长、开源学..._吴晟skywalking

Missing artifact commons-lang:commons-lang:jar:2.5 解决方案_commons-lang:commons-lang:jar:2.5 is invalid-程序员宅基地

文章浏览阅读5.7k次。Missing artifact commons-lang:commons-lang:jar:2.5 解决方案_commons-lang:commons-lang:jar:2.5 is invalid

使用R语言进行数据汇总统计_r数据 汇总计数统计-程序员宅基地

文章浏览阅读276次。R语言作为一种功能强大的统计分析工具,提供了丰富的函数和包来支持数据的汇总统计操作。本文将介绍如何使用R语言进行数据汇总统计,并提供相应的源代码示例。在实际应用中,根据具体需求,您还可以使用其他的R包和函数来进行更复杂的数据汇总统计分析。首先,我们可以计算数据集的基本统计信息,如均值、中位数、最大值、最小值等。下面的示例将按照性别字段对数据集进行分组,并计算每个性别组的平均分数。如果我们想按照某个字段对数据集进行分组,并计算每个组的统计信息,可以使用。下面的示例将统计性别字段的频数。_r数据 汇总计数统计

文本分类-程序员宅基地

文章浏览阅读1.9k次,点赞2次,收藏17次。1. 简述文本分类的方法属于有监督的学习方法,分类过程包括文本预处理、特征抽取、降维、分类和模型评价。本文首先研究了文本分类的背景,中文分词算法。然后是对各种各样的特征抽取进行研究,包括词项频率-逆文档频率和word2vec,降维方法有主成分分析法和潜在索引分析,最后是对分类算法进行研究,包括朴素贝叶斯的多..._文本分类

推荐文章

热门文章

相关标签