为“架构”再建个模:如何用代码描述软件架构?

发布时间 - 2025-07-15 00:00:00    点击率:

在 archguard 平台中,为了实现对架构的治理,我们需要通过代码和模型来描述所需处理的内容和数据。因此,archguard 引入了代码模型、依赖模型、变更模型等,而架构模型和架构治理模型则是两个核心的部分。其它如构建模型等,将会在后续逐步引入到系统中。

PS:本文中的架构展开是基于自动化分析需求的,模型也是基于这个动机出发的。

架构是什么?对单个语言的代码建模并不困难,因为每个语言有其特定的概念,如包、类、字段、函数等。在明确这些概念的基础上,结合业务需求,就能构建出基本的模型。采用领域驱动设计(DDD)等建模方式时,通过达成共识、提炼知识、形成概念,就能构建出模型的雏形。

起点:架构是重要的元素,然而,对于架构,业内没有统一的定义。例如,Martin Fowler 喜欢引用 GoF(设计模式的作者)之一 Ralph Johnson 对于架构的描述:

同样的,Grady Booch(UML 的发明者之一)也以类似的方式来概括架构:

这些描述让我们感觉说了等于没说,我们需要定义什么是重要的东西。而重要的东西,在不同人、不同场景下是存在差异的。哪怕是同一种类型的软件,在不同公司、不同利益相关者的背景下,重要的东西也各不相同。

原则:那么到底哪些是重要的?于是,我尝试引用最新的架构相关书籍,如在编写本文时参考的《软件架构:架构模式、特征及实践指南》,其中 Neal Ford 对架构的定义:

从模型构筑的角度来看,这本书中的定义也提供了一种灵活性。在架构特征的定义中,关注的是各种能力(ability),如互操作性、可适用性、可测试性等。

在 ArchGuard 这个业务场景下,我们难以自动化地识别出各类特征。因为从实践的层面上来说,这些能力并不一定已经实现,它们是目标架构,可能只存在于架构蓝图中。在这个层面上,这里定义的架构更偏向于设计层面的定义。

从另一方面来说,架构决策是我们在架构治理过程中关注的核心。我们可以在后续针对这些原则的规则,构建一个描述架构特征的 DSL。

重要的元素:组件、边界与通信接着,让我们回到 Bob 大叔(Robert C. Martin)的《架构整洁之道》中的定义:

从 Clean Architecture 模式来说,Bob 大叔一直强调的是:顶层抽象策略与底层实现要实现解耦。如如何划定合理的边界?如何组合相关的策略与层次?从这个模式上,我们得到了一个越来越清晰的定义。

然而,我们还面临一个更难的问题:如何定义一个组件是什么?还有关系是什么?在书的序言中,Kevlin Henney(《面向模式的软件架构》卷4、卷5的作者之一)给了一个更精确的描述词:组织结构(structure),从宏观到微观的构筑过程,其中包含了组件、类、函数、模块、层级、服务等。

对于大型软件来说,其组织结构方式异常复杂,类似于一个国家的层级关系,有一级部门、二级部门等。部门之间又有复杂的关系,正是层级关系 + 层级的构件构建成了这个复杂的系统。(PS:为了让系统能良好运行,即其中的组件(螺丝钉)按规则执行,则需要一个督察组织。)

层次结构:组件和关系软件架构已经有几十年的历史,我们已经用“模式”这一词对过去的架构进行了一系列的总结。二十年前,人们初步总结了《面向模式的软件架构》(POSA)。在这里,引述 POSA 1 的第 6 章,有一个完整的层级关系介绍:

在今天来看,从模式上来说,软件架构本身并没有发生太大的变化。只是定义发生了变化,如组件和接口。在微服务架构风格流行的今天,一个微服务也可以视为一个组件,它包含了一系列的接口,对外提供了复用的能力。而用来描述它们的关系的元素,则不再是过去的函数调用,变为了远程调用、事件触发。

现在,我们有了一个详尽的定义,在建模上,可能还欠缺一些元素,如如何分析出组件间的关系。

第 3 种架构视图:展示工程关注点在 ArchGuard 中,我们使用了 C4 架构可视化模型作为一种参考视图。这种实现的方式主要是从分析和可视化的层面来考虑的。除了 C4 之外,另外一种主流的方式是 4 + 1 视图。顺带一提,在 4 + 1 的论文《Architectural Blueprints—The “4+1” View Model of Software Architecture》中,也有一个描述架构的表示公式:Software architecture = {Elements, Forms, Rationale/Constraints}

从通识的角度来看,采用 4 + 1 视图是一个比较理想的方式。只是,由于存在大量的 PaaS、IaaS 等 xx 即服务设计的不合理性,使得这些记录基础设计相关信息的代码,并没有与代码库一起存放,使得在辩识上存在一定的难度。

因此,从实现的层面来说,在这里,我们要引用的是《面向模式的软件架构》中提到的《Software Architecture in Industrial Applications》(也可以参考《实用软件体系结构》一书)架构视图:

概念视图:描述了整个系统需求向整个体系结构的转化。模块视图:描述了如何将系统划分成模块并将模块组织成层。执行视图:描述了系统的动态元素以及它们之间的交互。代码视图:描述了源代码的组织结构。在这个视图的定义里,它更能清晰地划分开几个不同层面的考虑因素。采用作者们在最早的论文里提到的示例:

从表格的右边里,我们就可以直接对应到系统所需要的每个层面的设计因素,如编程语言等元素放在代码架构上。换句话说,在微服务、单体架构下,都能找到自己合适的位置。

概念的最后:描述模型的类型系统最后,为了保证本文在概念上的完整性,我们还需要一种方式来描述这个系统中的模型和一系列的概念,从形式上来说,它是一个类型系统。如我们在 UML 中所表示的(PlantUML 表示方式):

class Architecture {
    Component[] components
    System[] subSystems
    Relation[] relations
    ArchStyle archStyle
    Rule[] archRules
    ...
}

一个用来描述类型的系统,就是一个类型系统,和编程语言里的类型是等同的。它可以用来解释一系列的概念,以及概念之间如何连接。

顺带一提,如果我们把编程语言看作是一个系统,那么我们就会发现其在设计上的有趣之处。类型系统与结构体(或者类)可以用于构建系统中的概念,一个个的表达式则是用于构建概念之间的关系。

建模对于概念来说,哪怕是有了如此多丰富的展开,要做一个小结也并非一件容易的事情。更何况于模型而言,它是数值上的标准化,一种接近于通用的模型形态。

设计:第一个版本的架构模型所以,我的第一个尝试是从《面向模式的软件架构》的定义下手:

class SystemArchitecture(val archStyle: ArchitectureStyle, val subSystem: List, var components: List, val connections: List)

示例:对于一个系统来说,它存在一个主的架构模式,如微服务架构。而在每个微服务相当于是一个子系统或者说组件。当然了,一个子系统可以包含多个微服务。而对于个组件来说,它包含了输入和输出,以及一系列的计算逻辑。所以,它的一个模型可能是这样的:

class ArchComponent(val name: String, val type: ArchComponentType, val inbounds: List, val outbound: List, val components: List)

而麻烦的一点在于,组件是动态的,组件之间是存在关系的,组件内部也存在关系。所以,我们还需要考虑如何表示组件间的关系?

class Connection(val connectors: String, val source: String, val target: String, var connectionType: ConnectionType, val connectorStyles: ConnectorStyle)

所以,如果以宽泛的定义来看,组件其实是树形结构的。同样的,对于架构来说,这种 Connection 也是存在的。根据上面的一系列形态展开,我们就能得到一个初始版本的架构模型。

更多模型相关内容,详见 ArchGuard Scanner 中的初始版本 Architecture.kt。

实现思路:生成架构模型ArchGuard 中的模型是通过代码来生成的。在这种业务场景下,在构建模型的时候,需要平衡设计与实现。由此,基于代码分析的视图方式更适用我们。从代码和依赖中,我们可以:

基于目录结构分析出分层关系,进而得到代码的结构视图。分析依赖管理工具,进而得到一个模块的视图。分析依赖的软件,如 Spring、Dubbo 等,进而得到一个执行的视图。分析软件中的模型,进而得到概念视图。结合之下,我们就能构建出一个更完整的架构模型。

实现:放弃第一个版本的模型设计挺美好的,但是当我开始写第一行代码的时候,发现不对劲了:我们有了一个分析的模型,但是输入呢?

仅从项目的分析来说,我们拿到的只是一个代码仓库的代码。一个代码仓库可能是一个模块,一个系统,又或者是一个服务。所以,我们的输入是什么?基于已有的分析情况,如项目依赖(依赖管理工具)、源码结构、语言等?我们缺少构建一个项目所需要的上下文。

我们从源码所能分析到的内容如下所示:

data class PotentialExecArch(var protocols: List = listOf(), var appTypes: List = listOf(), var connectorTypes: List = listOf(), var coreStacks: List = listOf(), var concepts: List = listOf())

对应的一些分析细节:

协议信息。解析源码和 Gradle、Maven、NPM 中的依赖信息,如含 Dubbo 就视为带 RPC;如带 java.io.File 就认为带 FileIO应用类型。解析依赖信息,如包含 clikt 就视为 Kotlin 的 CLI 应用。连接类型。同上核心技术栈。根据依赖类型分析。概念模型。需要先分析潜在的分层架构模型,根据分层架构模型,就能得到概念集。当然了,这部分代码还没写完,如果有兴趣,也欢迎来加入我们。

多种架构模型于是,在 ArchGuard 的背景下,“架构”的架构模型有多种形态的:

扫描形态下的架构模型(对应到 ArchGuard Scanner)。即,从各个项目的源码中得到的架构模型,从源码、依赖、数据库等中计算出来。分析形态下的架构模型(对应到 ArchGuard Backend)。基于分析形态下的架构模型,构建出包含架构相关知识的架构模型。展示形态下的架构模型(对应到 ArchGuard Frontend)。结合可视化的知识,展示出对应的架构模型。每一个模型都是在上一步的基础上添加了领域知识,那么什么是领域知识呢?如何做好架构?

小结:挑战模型,一个开始,它需要不断地演进才能适用需要。而有了一个凑合能用的模型,只是这一系列工作的开始,我们还会遇到一系列的挑战。

描绘目标架构系统中的架构反应的只是现状,如何去描述未来的架构,并将两者进行匹配,又是一个非常有意思的话题。

衡量变化性我们还将面临的另外一个问题是,软件架构并非是不变的。

软件只要一直在开发,就会以细微地方式变化着。从宏观的层面来说,尽可能架构师都在努力地不去大范围地变动结构。而我们需要面对于这些挑战,诸如于基础设施变化,而这种变化带来的是临时性的中间状态。

如何去表示这种临时性的中间状态,就变得更加有意思。

在这里只开始了迈出了第一步,如果大家有兴趣,欢迎来 ArchGuard 为技术建模。

参考资料《整洁架构之道》《架构之美》《软件架构:架构模式、特征及实践指南》《面向模式的软件架构 卷 1:模式系统》《实用软件体系结构》《Software Architecture in Industrial Applications》《Architectural Blueprints—The “4+1” View Model of Software Architecture》


# linux  # 工具  # ai  # Java  # kotlin  # spring  # 架构  # npm  # maven  # dubbo  # 结构体  # 接口  #   # 事件  # 数据库  # paas  # gradle  # rpc  # uml  # 自动化  # 是一个  # 就能  # 的是  # 在这里  # 第一个  # 应到  # 这一  # 组织结构  # 在这个  # 让我们 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: Laravel数据库迁移怎么用_Laravel Migration管理数据库结构的正确姿势  Laravel如何使用Gate和Policy进行授权?(权限控制)  Windows家庭版如何开启组策略(gpedit.msc)?(安装方法)  教学论文网站制作软件有哪些,写论文用什么软件 ?  Laravel的Blade指令怎么自定义_创建你自己的Laravel Blade Directives  如何快速生成橙子建站落地页链接?  Laravel怎么集成Log日志记录_Laravel单文件与每日日志配置及自定义通道【详解】  如何快速完成中国万网建站详细流程?  使用Dockerfile构建java web环境  轻松掌握MySQL函数中的last_insert_id()  如何在腾讯云服务器快速搭建个人网站?  Laravel控制器是什么_Laravel MVC架构中Controller的作用与实践  如何用景安虚拟主机手机版绑定域名建站?  极客网站有哪些,DoNews、36氪、爱范儿、虎嗅、雷锋网、极客公园这些互联网媒体网站有什么差异?  js代码实现下拉菜单【推荐】  如何在 React 中条件性地遍历数组并渲染元素  canvas 画布在主流浏览器中的尺寸限制详细介绍  简历在线制作网站免费版,如何创建个人简历?  大同网页,大同瑞慈医院官网?  百度浏览器网页无法复制文字怎么办 百度浏览器复制修复  Laravel的.env文件有什么用_Laravel环境变量配置与管理详解  Midjourney怎样加参数调细节_Midjourney参数调整技巧【指南】  香港网站服务器数量如何影响SEO优化效果?  如何快速查询网址的建站时间与历史轨迹?  标准网站视频模板制作软件,现在有哪个网站的视频编辑素材最齐全的,背景音乐、音效等?  Laravel Docker环境搭建教程_Laravel Sail使用指南  Laravel如何与Inertia.js和Vue/React构建现代单页应用  东莞专业网站制作公司有哪些,东莞招聘网站哪个好?  html5如何设置样式_HTML5样式设置方法与CSS应用技巧【教程】  网站建设整体流程解析,建站其实很容易!  如何在浏览器中启用Flash_2025年继续使用Flash Player的方法【过时】  Laravel队列任务超时怎么办_Laravel Queue Timeout设置详解  ai格式如何转html_将AI设计稿转换为HTML页面流程【页面】  历史网站制作软件,华为如何找回被删除的网站?  网站制作大概多少钱一个,做一个平台网站大概多少钱?  香港服务器网站推广:SEO优化与外贸独立站搭建策略  Android Socket接口实现即时通讯实例代码  C++时间戳转换成日期时间的步骤和示例代码  高性能网站服务器配置指南:安全稳定与高效建站核心方案  Laravel全局作用域是什么_Laravel Eloquent Global Scopes应用指南  如何快速生成ASP一键建站模板并优化安全性?  动图在线制作网站有哪些,滑动动图图集怎么做?  Python文件流缓冲机制_IO性能解析【教程】  详解jQuery中基本的动画方法  黑客如何利用漏洞与弱口令入侵网站服务器?  Laravel队列由Redis驱动怎么配置_Laravel Redis队列使用教程  头像制作网站在线观看,除了站酷,还有哪些比较好的设计网站?  怎么制作一个起泡网,水泡粪全漏粪育肥舍冬季氨气超过25ppm,可以有哪些措施降低舍内氨气水平?  如何在景安云服务器上绑定域名并配置虚拟主机?  成都品牌网站制作公司,成都营业执照年报网上怎么办理?