知识卡片

普通读书笔记卡 · 1938.b.3

可维护性适应度函数与黄金法则

理解等级:中级

适应度函数与取舍:架构特征(-ilities)是你想通过架构实现的目标;适应度函数度量架构在这些特征上表现多好(用同时在线用户数和平均响应时间度量可扩展性,用相对循环性和可维护性级别度量可维护性)。架构师最重要的任务之一是权衡——不能在不增加难以管理的复杂度的情况下拥有所有特征,有些还相互对立(最大性能与最大安全:加密耗 CPU)。建议优先考虑最多三个特征,再加上可维护性——很少有可维护性不重要的情况。

可维护性适应度函数示例:可维护性级别 ≥ 75%;相对循环性组件级 ≤ 4%、包/命名空间级 0%;组件的结构债务指数 < 100;把平均缩进 > 3、平均复杂度 > 10 或行数 > 800 的文件视为复杂文件,复杂文件代码行占总行数不超过 10%。在 CI 构建中检查,违反就中断构建。

随时间跟踪:每天在自动化构建中收集指标并送入跟踪工具,画出趋势(如 90 天内代码行数的增长);建议跟踪所有适应度函数,再加一些耦合和规模指标。硬阈值违反时中断构建,软阈值只告警,但看到变化趋势通常更有用。工具:SonarQube 部分语言免费但指标有限,可加 Sonargraph 插件;Jenkins 中用免费的 Sonargraph-Explorer;商业版有灵活的自定义图表;有好的数据源时自建也不难。

黄金法则(新项目从一开始采用,会比 90% 同规模同复杂度的项目更好;现有代码库先止住恶化,再按月或季度设定目标逐步减少违规比例): - 有一个正式且可执行的架构模型,定义各部分及其允许的依赖; - 避免包/命名空间级循环依赖; - 限制源文件/类级循环——超过 5 个元素的循环组很可能变成代码癌症,能避免的小循环也尽量避免; - 避免复制粘贴造成的代码重复(偶尔用于打破极难打破的循环是罕见的边缘情况); - 源文件限制在 800 行(软阈值); - 最大缩进 4、改进圈复杂度 15(软阈值)。 最好用工具在 CI 中自动验证,并在整个组织推行。如果还没准备好大范围使用指标,至少专注于避免或限制循环依赖——这能阻止结构侵蚀最严重的副作用,也让以后采用更严格的规则更容易。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《软件架构指标:度量软件系统的性能和架构质量》第09章《第9章 使用软件度量指标来确保可维护性》9.5 架构适应度函数;9.6 如何随时间跟踪度量指标;9.7 改进软件的几条黄金法则;9.8 结论(源文件:extracted/软件架构指标 度量软件系统的性能和架构质量/_epub-src/index_split_079.html,来源项目 book-sources) - 结论依据:第9章建议优先考虑最多三个架构特征再加可维护性,给出可维护性适应度函数阈值(ML≥75%、组件相对循环性≤4%且包级0%、SDI<100、复杂文件代码不超过10%),说明用硬软阈值和趋势图持续跟踪,并列出架构模型、包间无循环、限制类循环、避免复制粘贴、800行、缩进4与圈复杂度15等黄金法则。 - 原始内容:最后,我建议优先考虑最多三个特征,再加上可维护性。