重构指标之如何监控代码圈复杂度

Tech

导读

     随着业务需求不断迭代，项目代码不断更新，开发人员会考虑代码的可测试性，倾向于编写简单的代码。所以代码圈复杂度是衡量工程代码是否适时重构的重要指标之一。本文意在分享基于python三方库提供一种自动监控工程代码圈复杂度的落地方案。

01 引言

在今年的敏捷团队建设中，我通过Suite执行器实现了一键自动化单元测试。Juint除了Suite执行器还有哪些执行器呢？由此我的Runner探索之旅开始了！

      软件应用在发展到适当时机，"重构"，是开发过程中不可避免需要进行的一项工作。重构代码，以适配当前模块设计之初未考虑到的多样化场景，并增加模块的可维护性、健壮性、可测试性。那么，如何明确重构的方向，以及量化重构的结果呢？代码圈复杂度可以是一个供选择的指标。下文将介绍如何获取应用的代码圈复杂度做到线上监控，给到复盘程序复杂程度的数据支撑。

02   背景知识  

理解，首先 MCube 会依据模板缓存状态判断是否需要网络获取最新模板，当获取到模板后进行模板加载，加载阶段会将产物转换为视图树的结构，转换完成后将通过表达式引擎解析表达式并取得正确的值，通过事件解析引擎解析用户自定义事件并完成事件的绑定，完成解析赋值以及事件绑定后进行视图的渲染，最终将目标页面展示到屏幕。从设计稿出发，提升页面搭建效率，亟需解决的核心问题有：

2.1 圈复杂度

      

      圈复杂度（Cyclomatic complexity，简写CC）也称为条件复杂度，是一种代码复杂度的衡量标准。由托马斯·J·麦凯布（Thomas J. McCabe, Sr.）于1976年提出，用来表示程序的复杂度，其符号为VG或是M。它可以用来衡量一个模块判定结构的复杂程度，数量上表现为独立现行路径条数，也可理解为覆盖所有的可能情况最少使用的测试用例数。圈复杂度大说明程序代码的判断逻辑复杂，可能质量低且难于测试和维护。程序的可能错误和高的圈复杂度有着很大关系。

2.2 圈复杂度计算方式

       

常用结构圈复杂度计算：

1. 顺序结构：顺序结构复杂度为1。

2. if-else-else、switch-case：每增加一个分支，复杂度增加1，&& 、|| 运算也为一个分支。

3. 循环结构：增加一个循环结构，复杂度增加1。

4. return：增加一条return语句，复杂度将加1。

2.3 圈复杂度度量标准

       

圈复杂度	说明
1 - 10	代码和质量还是不错的
11 - 15	代码已经较为复杂，可以设法对某些点重构一下
16 - ∞	代码已经非常复杂，可维护性很低， 维护的成本也大，此时必须要进行重构。

      如上列出行业内相对认可的度量数据，实际上是完全看具体的业务体量和项目情况来决定。假设业务很简单，而且是个单体应用，功能都是很简单的CRUD，那圈复杂度也很难变高。此时就可以选择把圈复杂度的重构阈值设定为10。

      假设业务十分复杂，而且涉及到多个其他的微服务系统调用，再加上各种业务中的corner case的判断，圈复杂度上100都是可能的。

2.4 降低圈复杂度方法

       

1. 函数提炼与拆分，单一职责：

拆分成子函数；

每个函数要有明确的功能实现，不要为了追求行数少而合并功能实现；

逻辑模块和数据模块要区分开编写。

2. 优化算法：

减少不必要条件、循环分支，尽量少用 if …else … ，采用三元表达式替换if else。

3. 表达式逻辑优化：

合并条件表达式，比如使用a || b || c

4. 减少提前return。

03   方案概述 

理解，首先 MCube 会依据模板缓存状态判断是否需要网络获取最新模板，当获取到模板后进行模板加载，加载阶段会将产物转换为视图树的结构，转换完成后将通过表达式引擎解析表达式并取得正确的值，通过事件解析引擎解析用户自定义事件并完成事件的绑定，完成解析赋值以及事件绑定后进行视图的渲染，最终将目标页面展示到屏幕。从设计稿出发，提升页面搭建效率，亟需解决的核心问题有：    

3.1 脚本设计

   图1 脚本架构设计图

3.2 功能介绍

1. 支持检索语言范围：支持15种开发语言，包含常用语言如下：

• C/C++ (works with C++14)

• Java

• C# (C Sharp)

• JavaScript (With ES6 and JSX)

• Python

• Golang

2. 扫描参数配置说明：

利用lizard执行扫描，常用命令如下：

配置检查范围：

• 列出要分析的编程语言。如果留空，将搜索支持的所有语言。

【plain】
-l LANGUAGES, --languages LANGUAGES

      排除与模式匹配的文件。*匹配一切，？匹配任何单个字符，“/folder/*”递归地排除文件夹中的所有内容。可以指定多个模式。不要忘了在模式周围加“”号。

【plain】
-x EXCLUDE, --exclude EXCLUDE

设置白名单, 默认'./whitelizard.txt'

【plain】
 -W WHITELIST, --whitelist WHITELIST

配置阀值警告：

• 圈复杂度数警告的阈值，默认值为15，>15会产生警告。

【plain】
-C CCN, --CCN CCN

      设置字段的限制数。可以代码行数，圈复杂度，令牌数，参数数或自定义字段。如果函数设置超过了限制数会报警。

【plain】
-T THRESHOLDS, --Threshold THRESHOLDS

配置报告输出：

• 根据格式输出到文件

【plain】
-o OUTPUT_FILE, --output_file OUTPUT_FILE

官网地址：http://www.lizard.ws

源码地址：https://github.com/terryyin/lizard

3. 定时执行扫描任务：

通过BackgroundScheduler创建调度任务，自动触发扫描方法，结果写库。

【Python】
def dojob():
    scheduler = BackgroundScheduler()
    scheduler.add_job(func, "cron", hour=21, minute=30)
    scheduler.start()

3.3 结果展示

3.3.1 报告名词解释

• Cyclomatic complexity，圈复杂度也就是分支复杂度，最好保持在15 以下，目前脚本设置阀值10。

• LOC，包含注释的代码行数，目前设置200阀值。

• Token count ，token的个数，一个程序最多可以有 8192 个令牌， 每个令牌都是一个词，例如关键字，标识符，常量，标点符号，操作符。对括号和字符串计数作为 1 个令牌。逗号、句点、LOCAL、分号、END 和注释不计算在内。

• Parameter count，参数统计就是函数的参数个数，目前脚本设置阀值10。

3.3.2 执行结果展示

• Windows环境运行脚本，输入file_root（文件地址）执行扫描，支持自动弹出浏览器展示本次运行的Html报告。

图2 HTML报告演示图

• 每周定期执行，按照系统维度扫描，支持触发邮件通知对应系统研发查看超过阀值方法名称。

图3 邮件报告演示图

3.3.3 应用数据监控

• 每周定期拉取指定分支最新代码，执行文件分析，存储扫描结果，通过数据图表展示：

图4 研发数字化演示样例图

04   总结   

理解，首先 MCube 会依据模板缓存状态判断是否需要网络获取最新模板，当获取到模板后进行模板加载，加载阶段会将产物转换为视图树的结构，转换完成后将通过表达式引擎解析表达式并取得正确的值，通过事件解析引擎解析用户自定义事件并完成事件的绑定，完成解析赋值以及事件绑定后进行视图的渲染，最终将目标页面展示到屏幕。     

      对于软件代码好坏的衡量，圈复杂度可以作为一个参考指标，研发可以通过提炼拆分函数、优化算法、优化逻辑表达式等方法降低模块（函数）圈复杂度。以上阐述的圈复杂度为一种线上监控方法，利用好线上化数据，结合现有团队项目情况，才能形成更好的实践机制。

推荐阅读微电SCRM平台之一起玩转电销系统
基于Hive的数据立方体实践
基于商业版Hadoop搭建的数据仓库解决方案
高复用性自动化脚本设计实践

求分享

求点赞

求在看