知识卡片

普通读书笔记卡 · 1938.e

用变更历史找重构热点

理解等级:中级

版本控制系统是宝库(Adam Tornhill《代码即犯罪现场》):能看出哪些文件经常改、多少人了解某部分代码、一段时间内改了多少代码,帮助找到适合重构的热点。

三个指标(d 为天数): - 更改数量(d):文件在过去 d 天内被改了多少次,频繁更改可能揭示设计不稳定; - 代码变更(d):过去 d 天内向文件添加和删除的行数;除以文件行数得代码变更率(d)——“代码变更率(90) = 2”可解释为“过去 90 天里这个文件被重写了两次”,比单纯计次提供更多上下文; - 作者数量(d):过去 d 天内有多少不同的人提交过更改,用于发现知识垄断——“作者数量(365) = 1”的文件过去一年只有一个人改过,他可能是唯一了解它的人,他离开就是公司的风险。

找重构候选:结构侵蚀的症状之一是改动常在看似不相关的地方引发问题,这些问题很可能出在经常更改的复杂文件里,它们往往也是有大量输入和输出依赖的“瓶颈类”。找到热点并考虑如何通过重构降低复杂度,很有机会解决问题。

软件城市可视化:Sonargraph-Architect 为 Cassandra 渲染的 3D 城市里,每栋建筑是一个源文件,按模块、包分组;占地面积与代码行数成比例,高度是平均复杂度,颜色深浅是过去 90 天的更改频率——又高又深色的建筑是很好的重构候选。例:左侧一栋不算很高但颜色较深的建筑,按行数排第三,经常被修改,原来是 NoSQL 数据库的关键类 StorageManager。任意两个指标都可以组合(高度换成输入依赖数,颜色换成复杂度),用很少的工作量做复杂分析。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《软件架构指标:度量软件系统的性能和架构质量》第09章《第9章 使用软件度量指标来确保可维护性》9.4.3 变更历史指标(源文件:extracted/软件架构指标 度量软件系统的性能和架构质量/_epub-src/index_split_078.html,来源项目 book-sources) - 结论依据:第9章介绍从版本控制中提取的更改数量、代码变更与变更率、作者数量三个指标,用于发现设计不稳定和知识垄断,建议在经常更改的复杂瓶颈类中寻找重构热点,并以Cassandra软件城市(面积为行数、高度为复杂度、颜色为90天更改频率)为例说明组合可视化。 - 原始内容:例如,所有在“作者数量”(365)上具有值1的文件都是在过去一年内只有一名人员提交更改的文件。