0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

如何获取应用的代码圈复杂度做到线上监控

电子工程师 来源:OSCHINA 社区 作者:京东云开发者 2022-08-08 15:11 次阅读

1 引言

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

2 背景知识

2.1 圈复杂度

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

2.2 圈复杂度计算方式

常用结构圈复杂度计算

顺序结构:顺序结构复杂度为 1。

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

循环结构:增加一个循环结构,复杂度增加 1。

return:增加一条 return 语句,复杂度将加 1。

2.3 圈复杂度度量标准

9a6f6d2c-16c5-11ed-ba43-dac502259ad0.png 如上列出行业内相对认可的度量数据,实际这个完全是看自己的业务体量和项目情况来决定的。假设你的业务很简单,而且是个单体应用,功能都是很简单的 CRUD,那你的圈复杂度即使想上去也没有那么容易。此时你就可以选择把圈复杂度的重构阈值设定为 10. 假设你的业务十分复杂,而且涉及到多个其他的微服务系统调用,再加上各种业务中的 corner case 的判断,圈复杂度上 100 可能都不在话下。

2.4 降低圈复杂度方法

1)函数提炼与拆分,单一职责

拆分成子函数

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

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

2)优化算法

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

3)表达式逻辑优化

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

4)减少提前 return

3 方案概述

3.1 脚本设计

1)开发语言

python

2)依赖环境

lizard

APScheduler

smtplib

pymysql

3)脚本架构 9a843afe-16c5-11ed-ba43-dac502259ad0.png

3.2 功能介绍

1)支持检索语言范围: 支持 15 种开发语言,包含常用语言如下

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

Java

C# (C Sharp)

JavaScript (With ES6 and JSX)

Python

Golang

2)扫描参数配置说明:
利用 lizard 执行扫描,常用命令如下: 配置检查范围:

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

-l LANGUAGES,--languages LANGUAGES

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

-x EXCLUDE,--exclude EXCLUDE

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

-W WHITELIST,--whitelist WHITELIST

配置阀值警告:

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

-C CCN,--CCN CCN

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

-T THRESHOLDS,--ThresholdTHRESHOLDS

配置报告输出:

根据格式输出到文件

-o OUTPUT_FILE,--output_file OUTPUT_FILE

官网地址:http://www.lizard.ws
源码地址:https://github.com/terryyin/lizard 3)定时执行扫描任务:

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

defdojob():

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 报告

9a9d7532-16c5-11ed-ba43-dac502259ad0.png

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

9ac2ce18-16c5-11ed-ba43-dac502259ad0.png 3.3.3 应用数据监控

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

9aef003c-16c5-11ed-ba43-dac502259ad0.png

4 总结

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

审核编辑:彭静
声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 程序
    +关注

    关注

    116

    文章

    3755

    浏览量

    80742
  • 代码
    +关注

    关注

    30

    文章

    4721

    浏览量

    68216
  • 数据模块
    +关注

    关注

    0

    文章

    11

    浏览量

    9766

原文标题:重构指标之如何监控代码圈复杂度

文章出处:【微信号:OSC开源社区,微信公众号:OSC开源社区】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    评论

    相关推荐

    简洁至上——探索产品与技术的优雅原则

    ,将复杂的逻辑转化为直观、易用的用户功能,并将冗长、难以维护的代码结构变为简洁、效率高的形式。 在《人月神话》中作者提到,软件开发的复杂度可以划分为本质复杂度和偶然
    的头像 发表于 10-25 11:12 754次阅读
    简洁至上——探索产品与技术的优雅原则

    时间复杂度为 O(n^2) 的排序算法

    作者:京东保险 王奕龙 对于小规模数据,我们可以选用时间复杂度为 O(n2) 的排序算法。因为时间复杂度并不代表实际代码的执行时间,它省去了低阶、系数和常数,仅代表的增长趋势,所以在小规模数据情况下
    的头像 发表于 10-19 16:31 955次阅读
    时间<b class='flag-5'>复杂度</b>为 O(n^2) 的排序算法

    10月25日|英飞凌储存器解决方案线上技术论坛

    主要面向方案设计群体(系统架构师、设计工程师等),探讨(由多种需求驱动的)设计复杂度增加,和资格认证所带来的挑战,以及如何减少开发成本并缩短上市时间。话题涵盖:可
    的头像 发表于 10-15 08:04 246次阅读
    10月25日|英飞凌储存器解决方案<b class='flag-5'>线上</b>技术论坛

    汽车异构硬件平台开发如何进行静态代码分析

    随着汽车软件开发复杂度的提升,异构硬件平台的应用已成为必然趋势。多编译器环境的引入不仅是技术发展的自然产物,更是解决日益增长的功能需求和技术挑战的有效途径。在此背景下,Helix QAC 作为一款
    的头像 发表于 10-09 16:15 423次阅读
    汽车异构硬件平台开发如何进行静态<b class='flag-5'>代码</b>分析

    卷染机物联网远程监控系统方案

    随着纺织行业的快速发展,卷染机作为纺织生产中的重要设备,其稳定性和效率直接影响到产品的质量和生产成本。然而,传统的卷染机监控方式存在着数据不集中、响应速度慢、资源浪费严重及操作复杂度高等痛点,这些
    的头像 发表于 10-08 15:53 99次阅读
    卷染机物联网远程<b class='flag-5'>监控</b>系统方案

    PCB与PCBA工艺复杂度的量化评估与应对措施

    一站式PCBA智造厂家今天为大家讲讲PCBA工艺复杂吗?PCBA工艺的复杂性应对PCBA工艺复杂性的措施。在电子制造领域,PCBA工艺是至关重要的环节。尽管对许多人来说,PCBA工艺可能看似
    的头像 发表于 09-13 09:21 323次阅读

    业务复杂度治理方法论--十年系统设计经验总结

    一、复杂度综述 1、什么是复杂度 软件设计的核心在于降低复杂性。 --《软件设计的哲学》 业界对于复杂度并没有统一的定义, 斯坦福教授John Ousterhout从认知负担和工作量方
    的头像 发表于 09-05 14:11 919次阅读
    业务<b class='flag-5'>复杂度</b>治理方法论--十年系统设计经验总结

    关于音电机一些参数的解析

    在日常对接客户的时候,小编多次遇到如下情况,譬如客户上来就问你们的音电机速度能做到多快?你们的音电机模组精度能做到多高?等等诸如此类的问题,在此,小编想跟大家解释一番。 关于音
    的头像 发表于 09-04 08:19 251次阅读
    关于音<b class='flag-5'>圈</b>电机一些参数的解析

    CISC(复杂指令集)与RISC(精简指令集)的区别  

    复杂度, 将复杂性交给编译器。举一个例子,CISC提供的乘法指令,调用时可完成内存a和内存b中的两个数相乘,结果存入内存a ,需要多个CPU周期才可以完成;而RISC不提供“一站式”的乘法指令,需
    发表于 07-30 17:21

    PCB与PCBA工艺复杂度的量化评估与应用初探!

    , 不知道如何区分普通和复杂的PCB和 PCBA的设计,并采用什么样的方式来处理。 基于上述考虑, 我们参考了业 界已有的作法, 设计了一个PCB 和 PCBA的工艺复杂度计算公式以解决这 方面
    发表于 06-14 11:15

    软件架构搞好了,还用担心代码可读性差?

    一、架构的概念及由来嵌入式软件架构是指在嵌入式系统中用于组织和管理软件组件的结构和设计。嵌入式软件架构的出现是为了解决嵌入式系统中软件复杂度和系统要求不断增加的挑战。以下是嵌入式软件架构出现的原因
    的头像 发表于 06-14 08:10 233次阅读
    软件架构搞好了,还用担心<b class='flag-5'>代码</b>可读性差?

    STM32F303启动文件中的Stack_Size和Stack_Mem如何在C代码获取其地址或值?

    为了在业务代码监控系统的堆栈使用情况,想在业务代码获取Stack_Mem的内存地址和Stack_Size的值。目前定义如下:可实现读取栈地址但无法读取栈大小 extern unsi
    发表于 04-01 08:18

    时间复杂度为O (nlogn)的排序算法简述

    归并排序遵循分治的思想:将原问题分解为几个规模较小但类似于原问题的子问题,递归地求解这些子问题,然后合并这些子问题的解来建立原问题的解。
    的头像 发表于 12-05 09:57 546次阅读
    时间<b class='flag-5'>复杂度</b>为O (nlogn)的排序算法简述

    降低Transformer复杂度O(N^2)的方法汇总

    首先来详细说明为什么Transformer的计算复杂度是 。将Transformer中标准的Attention称为Softmax Attention。令 为长度为 的序列, 其维度为 , 。 可看作Softmax Attention的输入。
    的头像 发表于 12-04 15:31 1043次阅读
    降低Transformer<b class='flag-5'>复杂度</b>O(N^2)的方法汇总

    如何降低SigmaDSP音频系统复杂度的情形

    电子发烧友网站提供《如何降低SigmaDSP音频系统复杂度的情形.pdf》资料免费下载
    发表于 11-29 11:13 0次下载
    如何降低SigmaDSP音频系统<b class='flag-5'>复杂度</b>的情形