知识卡片

普通读书笔记卡 · 2298.b.2

目录和文档作为恢复的辅助

理解等级:中级

目录结构的两个用处(它带主观色彩,所以只作辅助): 1. 聚合零散组件:组件图里常有与其他组件无依赖的零散组件(如测试用例),大量零散组件严重影响可读性;若它们在同一目录中,大概率功能类似,可聚为一个组件组; 2. 验证物理分布的合理性:比对文件、模块、组件三层依赖与目录分布,发现异常——例如目录 A 中某个文件与目录 B 文件的依赖远大于与本目录其他文件,而它又不是接口文件,就应在重构时把它移到目录 B,以体现高内聚低耦合。

架构文档的低要求用法:自顶向下方法要求准确完备的文档,但文档往往滞后。书中方法只要求文档记录“组件 ↔ 代码目录/文件”的包含关系,而且允许不完整: - 包含关系用来辅助组件聚合和组件重命名,提高组件图的准确性和可理解性; - 部分目录缺少所属组件信息,不影响聚类结果,只影响最终命名。 实现上用 Excel 记录项目名、语言、组件名和包含的相对路径(含“不包括子目录”标记),用 Apache POI 解析后深度遍历到叶子文件。

可借鉴:维护一张轻量的“组件 → 目录”映射表,比维护完整架构文档现实得多,却足以让自动化恢复和依赖检查结果变得可读。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      同时也考虑加入目录层次结构包含的架构信息,带来的好处有如下两个方面: 1)聚合零散组件。在实际组件图中很可能存在一些零散的组件,即与其他组件没有任何依赖关系,如测试用例组件等,大量的零散组件会严重影响组件依赖图的可读性。使用目录层次结构可缓解这一问题,如果一部分零散组件存在于同一目录中,则认为这些零散组件存在大概率出现功能类似的情况,进而将其聚合为一个组件组。 2)验证代码文件物理分布的合理性。通过对比项目的文件、模块和组件三个层次的依赖关系,用户会将三个层次的依赖关系同代码文件的物理分布进行匹配

    参考来源

    - 位置:《软件架构理论与实践》第10章《第10章 软件架构恢复》10.2.4 从目录层次提取架构信息;10.2.5 基于架构文档的架构信息提取(源文件:extracted/软件架构理论与实践/_epub-src/OEBPS/text00081.html,来源项目 book-sources) - 结论依据:第10章把目录结构和架构文档作为恢复的辅助:目录可把同目录的零散组件聚成组,并通过比对依赖与物理分布发现应移动的文件;架构文档只需记录组件与目录文件的包含关系且允许不完整,用于辅助聚合和命名,缺失部分只影响命名不影响聚类。 - 原始内容:2)验证代码文件物理分布的合理性。