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

在 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》

以上就是为“架构”再建个模:如何用代码描述软件架构?的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/23834.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
Figma中AI插件生成的图片如何导出?快速导出的详细操作指南
上一篇 2025年11月2日 02:54:39
tiktok网络使用链接 tiktok网页版入口地址
下一篇 2025年11月2日 02:57:43

相关推荐

  • composer require-dev和require有什么不同_Composer Require与Require-Dev区别解析

    require用于声明项目运行必需的依赖,如框架、数据库组件和第三方SDK,这些包会随项目部署到生产环境;2. require-dev用于声明仅在开发和测试阶段需要的工具,如PHPUnit、PHPStan、Faker等,不会默认部署到生产环境;3. 安装时composer install根据环境决定…

    2026年5月10日
    1000
  • Golang JSON序列化:控制敏感字段暴露的最佳实践

    本教程探讨golang中如何高效控制结构体字段在json序列化时的可见性。当需要将包含敏感信息的结构体数组转换为json响应时,通过利用`encoding/json`包提供的结构体标签,特别是`json:”-“`,可以轻松实现对特定字段的忽略,从而避免敏感数据泄露,确保api…

    2026年5月10日
    000
  • 利用海象运算符简化条件赋值:Python教程与最佳实践

    本文旨在探讨Python中海象运算符(:=)在条件赋值场景下的应用。通过对比传统if/else语句与海象运算符,以及条件表达式,分析海象运算符在简化代码、提高可读性方面的优势与局限性。并通过具体示例,展示如何在列表推导式等场景下合理使用海象运算符,同时强调其潜在的复杂性及替代方案,帮助开发者更好地掌…

    2026年5月10日
    100
  • Debian syslog性能优化技巧有哪些

    提升Debian系统syslog (通常基于rsyslog)性能,关键在于精简配置和高效处理日志。以下策略能有效优化日志管理,提升系统整体性能: 精简配置,高效加载: 在rsyslog配置文件中,仅加载必要的输入、输出和解析模块。 使用全局指令设置日志级别和格式,避免不必要的处理。 自定义模板: 创…

    2026年5月10日
    000
  • 比特币新手教程 比特币交易平台有哪些

    比特币是一种去中心化的数字货币,基于区块链技术实现点对点交易,具有匿名性、有限发行和不可篡改等特点;新手可通过交易所购买,P2P交易获得比特币,常用平台包括Binance、OKX和Huobi;交易流程包括注册账户、实名认证、绑定支付方式、充值法币并下单购买,可选择市价单或限价单;比特币存储方式有交易…

    2026年5月10日
    000
  • c++中的SFINAE技术是什么_c++模板编程中的SFINAE原理与应用

    SFINAE 是“替换失败不是错误”的原则,指模板实例化时若参数替换导致错误,只要存在其他合法候选,编译器不报错而是继续重载决议。它用于条件启用模板、类型检测等场景,如通过 decltype 或 enable_if 控制函数重载,实现类型特征判断。尽管 C++20 引入 Concepts 简化了部分…

    2026年5月10日
    000
  • Go语言mgo查询构建:深入理解bson.M与日期范围查询的正确实践

    本文旨在解决go语言mgo库中构建复杂查询时,特别是涉及嵌套`bson.m`和日期范围筛选的常见错误。我们将深入剖析`bson.m`的类型特性,解释为何直接索引`interface{}`会导致“invalid operation”错误,并提供一种推荐的、结构清晰的代码重构方案,以确保查询条件能够正确…

    2026年5月10日
    100
  • Golang goroutine与channel调试技巧

    使用go run -race检测数据竞争,结合runtime.NumGoroutine监控协程数量,通过pprof分析阻塞调用栈,利用select超时避免永久阻塞,有效排查goroutine泄漏、死锁和数据竞争问题。 Go语言的goroutine和channel是并发编程的核心,但它们也带来了调试上…

    2026年5月10日
    000
  • 使用 Jupyter Notebook 进行探索性数据分析

    Jupyter Notebook通过单元格实现代码与Markdown结合,支持数据导入(pandas)、清洗(fillna)、探索(matplotlib/seaborn可视化)、统计分析(describe/corr)和特征工程,便于记录与分享分析过程。 Jupyter Notebook 是进行探索性…

    2026年5月10日
    000
  • 《魔兽世界》将于6月11日开启国服回归技术测试

    《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试

    《%ign%ignore_a_1%re_a_1%》官方宣布,将于6月11日开启国服回归技术测试,时间为7天,并称可以在6月内正式开服,玩家们可以访问官网下载战网客户端并预下载“巫妖王之怒”客户端,技术测试详情见下图。 WordAi WordAI是一个AI驱动的内容重写平台 53 查看详情 以上就是《…

    2026年5月10日 用户投稿
    200
  • 如何在HTML中插入表单元素_HTML表单控件与输入类型使用指南

    HTML表单通过标签构建,包含action和method属性定义数据提交目标与方式,常用input类型如text、password、email等适配不同输入需求,配合label、required、placeholder提升可用性,结合textarea、select、button等控件实现完整交互,是…

    2026年5月10日
    000
  • 网站标题关键词更新后,搜索引擎为何仍显示旧标题?

    网站标题更新后,搜索引擎为何显示旧标题? 网站SEO优化中,站长常修改网站标题关键词,期望搜索结果显示自定义标题。然而,即使更新标签、meta keywords、meta description和结构化数据中的name属性后,搜索结果仍显示旧标题,这令人费解。本文将对此进行解释。 问题:站长修改了网…

    2026年5月10日
    100
  • 创建指定大小并填充特定数据的Golang文件教程

    本文将介绍如何使用Golang创建一个指定大小的文件,并用特定数据填充它。我们将使用 `os` 包提供的函数来创建和截断文件,从而实现快速生成大文件的目的。示例代码展示了如何创建一个10MB的文件,并将其填充为全零数据。掌握这些方法,可以方便地在例如日志系统或磁盘队列等场景中,预先创建测试文件或初始…

    2026年5月10日
    000
  • Python命令怎样使用profile分析脚本性能 Python命令性能分析的基础教程

    使用Python的cProfile模块分析脚本性能最直接的方式是通过命令行执行python -m cProfile your_script.py,它会输出每个函数的调用次数、总耗时、累积耗时等关键指标,帮助定位性能瓶颈;为进一步分析,可将结果保存为文件python -m cProfile -o ou…

    2026年5月10日
    000
  • 使用 WebCodecs VideoDecoder 实现精确逐帧回退

    本文档旨在解决在使用 WebCodecs VideoDecoder 进行视频解码时,实现精确逐帧回退的问题。通过比较帧的时间戳与目标帧的时间戳,可以避免渲染中间帧,从而提高用户体验。本文将提供详细的解决方案和示例代码,帮助开发者实现精确的视频帧控制。 在使用 WebCodecs VideoDecod…

    2026年5月10日
    000
  • 如何插入查询结果数据_SQL插入Select查询结果方法

    如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法

    使用INSERT INTO…SELECT语句可高效插入数据,通过NOT EXISTS、LEFT JOIN、MERGE语句或唯一约束避免重复;表结构不一致时可通过别名、类型转换、默认值或计算字段处理;结合存储过程可提升可维护性,支持参数化与动态SQL。 将查询结果数据插入到另一个表中,可以…

    2026年5月10日 用户投稿
    000
  • Debian Copilot的社区活跃度如何

    debian copilot是codeberg社区维护的ai助手,旨在为debian用户提供服务。尽管搜索结果中没有直接提供关于debian copilot社区支持活跃度的具体数据,但我们可以通过debian社区的整体活跃度和特点来推断其活跃性。 Debian社区的一般情况: Debian拥有详尽的…

    2026年5月10日
    000
  • Discord.py 交互按钮超时与持久化解决方案

    本教程旨在解决Discord.py中交互按钮在一段时间后出现“This Interaction Failed”错误的问题。我们将深入探讨视图(View)的超时机制,并提供通过正确设置timeout参数以及利用bot.add_view()方法实现按钮持久化的具体方案,确保您的机器人交互功能稳定可靠,即…

    2026年5月10日
    000
  • python中zip函数详解 python多序列压缩zip函数应用场景

    zip函数的应用场景包括:1) 同时遍历多个序列,2) 合并多个列表的数据,3) 数据分析和科学计算中的元素运算,4) 处理csv文件,5) 性能优化。zip函数是一个强大的工具,能够简化代码并提高处理多个序列时的效率。 在Python中,zip函数是一个非常有用的工具,它能够将多个可迭代对象打包成…

    2026年5月10日
    000
  • JavaScript 动态菜单点击高亮效果实现教程

    本教程详细介绍了如何使用 JavaScript 实现动态菜单的点击高亮功能。通过事件委托和状态管理,当用户点击菜单项时,被点击项会高亮显示(绿色),同时其他菜单项恢复默认样式(白色)。这种方法避免了不必要的DOM操作,提高了性能和代码可维护性,确保了无论点击方向如何,功能都能稳定运行。 动态菜单高亮…

    2026年5月10日
    200

发表回复

登录后才能评论
关注微信