本文分享对该模块进行重构时的实践经验, 具体的重构手段可参考《代码大全2》或《重构:改善既有代码的设计》,本文不再班门弄斧,而侧重重构时一些粗浅的“方法论”,旨在提高重构效率。
小编未采用重量级的重构工具,仅用到Source Insight的”Smart Rename”功能。也未使用CUnit等单元测试工具,而是通过在线调测和自动化测试保证代码的正确性。
一 背景
MDU系列产品从他处接手,OMCI模块相关人员含作者在内不过三五人。除新增功能的开发外,大量时间花费在处理遗留故障上。但该模块代码庞杂且可读性差,导致大家仅了解其“大概轮廓”,难以放心地使用和维护。
此外,忙碌容易使人迷失方向。主要的时间精力花费在故障处理上时,自然无暇考虑整改代码,从而陷入四处救火、疲于奔命的尴尬境地。
二 目标
重构的主要目的在于改善既有代码的设计,而不是修改缺陷、新增功能等。
重构可以是修改变量名、重新安排目录这样简单的物理重构,也可以是抽取子函数、精简冗余设计这样稍许复杂的逻辑重构。但均不改变现有代码的功能。
重构可以将意大利面条式的杂乱代码整理为千层饼式的整洁代码。整洁的代码更加健壮,因其便于建立完善的测试防护网。同时,新手老人均可放心地修改。
期望重构之后,代码逻辑一目了然,扩展和修改非常方便,出现故障时能迅速定位和修复。前人摔跤过的地方后人不再栽倒,前人思考出的成果后人可直接借用。总之,高度人性化,极大解放人力和脑力。
最初的想法是,通过重构部分流程和代码(代码先行),建立测试防护体系,生成阶段报告,展现代码质量(实例加数据)和故障收敛曲线。借助这样的报告,可望获得领导层的支持和宣贯,也有利于绩效考核。
三 实践
具体实践时,作者并未进行纯粹的“重构”,还兼做缺陷修改,并增加自动化测试等辅助功能。原则上,对既有代码注重重构,对新增代码注重复用。
3.1 代码研读
OMCI模块代码庞杂,分支众多,上手困难(据称半年勉强入门,一年才能熟练)。若不能有效掌握现有代码,后续难免被迫付出时间健康而又得不到项目认同(事实上,模块内发现的遗留故障源源不断)。反之,若能全面掌握现有代码,后续才可能通过反向工程、系统/代码恢复和重构等手段,将模块改造得更易开发和维护,最终解放编码者自己。
为提高代码研读效率,可采用分工阅读和代码注释的方法。
“分工阅读”是指将模块分为若干块子功能(如协议解析、告警、统计、二层、语音等),组内每人负责一块或几块,不定期地交流和轮值。
“代码注释”是指在学习代码过程中,随手注释代码(大至流程、函数,小至代码行),功能、意图、技巧、缺陷、疑问等均可(凡经过思考的地方都是可加注释之处)。其中“疑问”既可咨询兄弟产品同一模块的同事再转换为功能或意图,也可由其他注释者解答。
这样做的好处是:避免重复钻研;经验积累;可供量化。
代码可取产品最新版本,建立服务器公共代码目录(SVN管理更好)。注释时不要覆盖其他人的注释即可。
建议注释统一格式,便于识别和检索,形如”//>”。以下示出一个代码注释实例:
1caseOMCI_ME_ATTRIBUTE_2://Operationalstate 2if(attr.attr.ucOperationState!=0&&attr.attr.ucAdminState!=1)//xywang0618>BUG:shouldbeucOperationState! 3{ 4returnOMCI_FUNC_RETURN_OUT_OF_RANGE; 5} 6break;
3.2 可读性
首先,规范变量、函数等命名。具体方法不再赘述。
其次,注释到位,尤其是全局变量和通用函数。举例如下:
1/****************************************************************************** 2*函数名称:ByteArray2StrSeq 3*功能说明:掩码字节数组字符串化 4该数组元素为掩码字节,将其所有值为1的比特位置转换为指定格式的字符串 5*输入参数:pucByteArray:掩码字节数组 6ucByteNum:掩码字节数组待转换的有效字节数目 7ucBaseVal:掩码字符串起始字节对应的数值 8 *输出参数: pStrSeq :掩码字符串,以','、'-'间隔 9形如0xD7(0b'11010111)--->"0-1,3,5-7" 10*返回值: pStr :pStrSeq的指针备份,可用于strlen等链式表达式 11*用法示例:INT8UaucByteArray[8]={0xD7,0x8F,0xF5,0x73}; 12CHARszSeq[64]={0}; 13ByteArray2StrSeq(aucByteArray,4,0,szSeq); 14---->"0-1,3,5-8,12-19,21,23,25-27,30-31" 15memset(szSeq,0,sizeof(szSeq)); 16ByteArray2StrSeq(aucByteArray,4,1,szSeq); 17---->"1-2,4,6-9,13-20,22,24,26-28,31-32" 18*注意事项:因本函数内含strcat,故调用前应按需初始化pStrSeq 19******************************************************************************/ 20CHAR*ByteArray2StrSeq(INT8U*pucByteArray,INT8UucByteNum,INT8UucBaseVal,CHAR*pStrSeq);
最后,整改晦涩难懂的代码。主要有两种手段:
1) 改写方法
以PON光路检测为例,底层接口提供的光功率单位为0.1uW,OMCI协议Test消息上报的光功率单位为0.002dBuW,而Ani-G功率属性单位则为0.002dBmW。
原有代码转换如下(为突出重点有所改编):
1INT16SwRxPower=GetRxPowerInDot1uW();//接收光功率 2if(wRxPower< 1){ 3 wRxPower = 1; 4 } 5 /*0.1uw to 0.002dbm*/ 6 dblVal = 10 * log10(wRxPower) - 40; 7 dblVal = dblVal * 500; 8 wRxPower = (INT16U)dblVal; 9 wRxPower = (int)wRxPower*100; 10 11 /*opt pwr 0.00002db X * 0.00002*/ 12 wRxPower = wRxPower + (30 * 500) * 100; 13 if(wRxPower < 0){ 14 val = (INT16U)((0 - wRxPower) / 100); 15 val = (((~val) & 0x7fff) + 1) | 0x8000; 16 wRxPower = val; 17 } 18 else{ 19 wRxPower = wRxPower / 100; 20 }
可见,原实现中转换关系非常晦涩难懂。其实借助1dBuW=10*lg(1uW)和1dBuW-1dBmW=30dB两个公式,经过简单的数学推导即可得到更简洁易懂的表达(为突出重点有所改编):
1INT16SwRxPower=GetRxPowerInDot1uW();//接收光功率 2//Test单位0.002dBuW,底层单位0.1uW,转换关系T=(10*lg(B*0.1))/0.002=5000*(lgB-1) 3wRxPower=(INT16S)(5000*(log10((DOUBLE)wRxPower)-1)); 4 5//Ani-G功率属性单位0.002dBmW,Test结果单位0.002dBuW 6//转换关系A(dBmW)*0.002+30=T(dBuW)*0.002,即A=T-15000 7INT16SwAniRxPwr=wRxPower-15000;
注意,原实现中误认为Ani-G功率属性与Test结果的单位相同,新实现已修正该错误。
2) 封装函数
以实体属性的掩码校验为例,原有代码如下:
1/*掩码初校验*/ 2if((OMCIMETYPE_SET==vpIn->omci_header.ucmsgtype) 3||(OMCIMETYPE_GET==vpIn->omci_header.ucmsgtype)) 4{ 5wMask=W(response.omcimsg.auccontent[0],response.omcimsg.auccontent[1]); 6usSupportMask=(1<< (OMCI_ATTRIBUTE_NUMBER - map.num))-1; 7 if( 0 != (wMask & usSupportMask)) 8 { 9 OmciPrint_warn("[%s] check mask warning: (meclass[%u], meid[%u], msgtype[%u], mask[0x%x], unsupport mask[0x%x])! ", 10 FUNCTION_NAME, vpIn->omci_header.wmeclass,vpIn->omci_header.wmeid,vpIn->omci_header.ucmsgtype,wMask,usSupportMask); 11} 12}
对usSupportMask赋值及判断的语句(第6~7行),用于校验掩码是否越界。为更具可读性,将其封装为如下函数:
1/****************************************************************************** 2*函数名称:OmciIsMaskOutOfLimit 3*功能说明:判断实体属性掩码是否越界(比特1数目超过属性数目) 4*输入参数:INT16UwMeMask:实体掩码 5*INT8UucAttrNum:属性数目 6*输出参数:NA 7*返回值:BOOL 8******************************************************************************/ 9BOOLOmciIsMaskOutOfLimit(INT16UwMeMask,INT8UucAttrNum) 10{ 11//wMeMask:mmmmmmmmmmm0m000 12//wInvertMask:00000000000iiiii 13INT8UwInvertMask=(1<< (OMCI_ATTR_MAX_NUM-ucAttrNum)) - 1; 14 return (0 != (wMeMask & wInvertMask)); 15 }
封装后的函数名恰当地起到“自描述”的作用。
3.3 在线调测工程
该产品作为嵌入式终端,需要在Linux系统中编译打包版本,然后将其下载到目标单板上运行。这种交叉编译方式对于单个模块的调试而言,效率无疑比较低下。
为提高调测效率,在Linux服务器搭建在线调测工程。即提取OMCI模块代码,稍作改造后直接在服务器上编译和运行。这样就可避免每次修改代码都要重启单板升级大版本,调测效率极高。
为使模块可独立运行,需要编写interwetten与威廉的赔率体系 接口以屏蔽底层调用,并裁减暂不必要的特性(如线程和通信)等。
3.4 模拟数据库
OMCI模块使用某内存数据库来管理需要持久化的实体信息,但该数据库代码内调用了大量平台相关的接口,不利于实现模块的在线调测。因此,作者研读源代码后编写了一个模拟数据库。该库仿照模块使用的几个原库接口及行为,模拟接口内部校验均增加错误信息打印,以便于排障。
此外,在数据库接口原语的基础上二次封装统一接口,一举消除模块内数据库操作代码的凌乱和重复。
3.5 自动化测试
没有测试保护网的重构,无异于没有血源的外科手术。
首先,公共接口和函数均提供有相应的测试函数,兼做示例和用例。如:
1//StartofByteArray2StrSeqTest// 2VOIDByteArray2StrSeqTest(VOID) 3{ 4 //ByteArray2StrSeq函数算法不甚优美和严谨,应多加测试验证,如有可能尽量优化。 5INT8UucTestIndex=1; 6INT8UpucByteArray[]={0xD7,0x8F,0xF5,0x73,0xB7,0xF0,0x00,0xE8,0x2C,0x3B}; 7CHARpStrSeq[50]={0}; 8 9//TimeConsumed(x86_gcc3.2.3_glibc2.2.5):72us 10memset(pStrSeq,0,sizeof(pStrSeq)); 11ByteArray2StrSeq(pucByteArray,4,1,pStrSeq); 12printf("[%s]Result:%s,pStrSeq=%s! ",__FUNCTION__,ucTestIndex++, 13strcmp(pStrSeq,"1-2,4,6-9,13-20,22,24,26-28,31-32")?"ERROR":"OK",pStrSeq); 14 15//TimeConsumed(x86_gcc3.2.3_glibc2.2.5):7us 16memset(pStrSeq,0,sizeof(pStrSeq)); 17ByteArray2StrSeq(pucByteArray,4,0,pStrSeq); 18printf("[%s] Result:%s,pStrSeq=%s!!! ",__FUNCTION__,ucTestIndex++, 19strcmp(pStrSeq,"0-1,3,5-8,12-19,21,23,25-27,30-31")?"ERROR":"OK",pStrSeq); 20 21//TimeConsumed(x86_gcc3.2.3_glibc2.2.5):4us 22memset(pStrSeq,0,sizeof(pStrSeq)); 23ByteArray2StrSeq(&pucByteArray[4],2,1,pStrSeq); 24printf("[%s] Result:%s,pStrSeq=%s! ",__FUNCTION__,ucTestIndex++, 25strcmp(pStrSeq,"1,3-4,6-12")?"ERROR":"OK",pStrSeq); 26 27//TimeConsumed(x86_gcc3.2.3_glibc2.2.5):4us 28memset(pStrSeq,0,sizeof(pStrSeq)); 29ByteArray2StrSeq(&pucByteArray[6],2,1,pStrSeq); 30printf("[%s] Result:%s,pStrSeq=%s! ",__FUNCTION__,ucTestIndex++, 31strcmp(pStrSeq,"9-11,13")?"ERROR":"OK",pStrSeq); 32 33//TimeConsumed(x86_gcc3.2.3_glibc2.2.5):5us 34memset(pStrSeq,0,sizeof(pStrSeq)); 35ByteArray2StrSeq(&pucByteArray[8],2,1,pStrSeq); 36printf("[%s] Result:%s,pStrSeq=%s! ",__FUNCTION__,ucTestIndex++, 37strcmp(pStrSeq,"3,5-6,11-13,15-16")?"ERROR":"OK",pStrSeq); 38} 39//EndofByteArray2StrSeqTest//
此外,模块内还增加自动化测试功能(TestSuite),可用来验证批量或单个实体的配置和查询操作。批量测试结果统计如下(省略各实体的具体测试结果):
在上述测试结果中,Failed TestCase(s)最为关键,表示失败的用例数目。此外,UnCompared TestCase(s)表示未做比较的条目数,如获取时间等易变属性的实体,无法预置恰当的期望结果,因此未做比较。测试过程中的打印信息可保存为日志文件,然后在打印日志中搜索Failure关键字,即可获知哪些配置失败。
当大量修改当前代码时,借助上述自动化测试功能,可迅速获知修改结果的影响。在开发新功能时,可先设计好测试用例和期望结果,然后按照“测试驱动开发”的模式来编码,提高编码效率和正确率。
3.6 直捣核心
传统的重构步骤是先容易后困难,先外围后核心。而作者反其道而行之,首先重构核心公共的代码。这样做的好处是:
1) 便于梳理头文件包含关系
在线调测工程中最初只保留最为公共的代码文件(如日志功能),重构并调测通过后再逐步添加其他单一功能的目标代码。该过程中会按需拆分和/或组合文件,减少头文件的嵌套和交叉引用。
2) 避免重复工作甚至返工
公共代码重构后并封装后,对较外围的应用代码重构时会更容易消除冗余。若先重构好外围代码,很可能发现某些逻辑可以统一到公共代码内,从而导致大面积返工;而若先着手重构公共代码,则通过研读外围代码对其的使用方式,很容易及早甄别这些冗余性。
3) 迭代验证
在重构后的公共代码基础上逐步叠加外围代码时,也在反复测试公共代码的正确性和易用性。
4) 增强信心
先核心后外围、逐步叠加验证的过程可控,可增强大规模重构时的信心,缓解压力。反之,若先重构好外围代码,等触及核心时牵一发而动全身,压力极大。
四 效果
在某产品代码基础上,进行OMCI模块DB/LOG/实体存取/消息处理/性能统计等重构。经过三个多月的重构后,模块代码复杂度大幅下降(某核心源文件平均复杂度降为原先1/4),代码显著精简(据不完全统计已精简万余行),同时更具可读性。新增代码的过程中,编写大量工具类宏和函数,并增加OMCI自动化测试、内存检测等实用功能。
通过LineCount和Source Monitor度量某功能代码重构效果,如下表所示:
注:为便于统计比较,合并SNdbplat.c与SNdbplatSpecial.c为SNdbplat&Special.c。
此外,重构过程中积累的通用框架、代码及经验,可进一步应用到新的项目中。
审核编辑:刘清
-
Linux系统
+关注
关注
4文章
593浏览量
27396 -
PON
+关注
关注
1文章
132浏览量
43601 -
svn
+关注
关注
0文章
29浏览量
8649
原文标题:我的代码重构经验
文章出处:【微信号:威廉希尔官方网站 让梦想更伟大,微信公众号:威廉希尔官方网站 让梦想更伟大】欢迎添加关注!文章转载请注明出处。
发布评论请先 登录
相关推荐
评论