244 华为软件编程规范培训案例和练习(68页)

软件编程规范培训实例与练习第一版深圳市华为技术有限公司说明本文分为两部分，第一部分为中研《关于规范开发人员设计编码行为、提高软件质量的通知》文件，其中包含来自测试人员总结的大量的包括逻辑类、接口类、维护类和可测试类四个方面的生动实例，是典型的软件编程规范培训实例，亦可供我司员工自学；第二部分是一个练习，作为软件编程规范教学使用。案例与练习第一部分深圳市华为技术有限公司研发管理办公室文件关于规范开发人员设计编码行为、提高软件质量的通知为更有效地贯彻执行《软件编码规范总则》，强化开发人员规范意识，进一步规范开发人员的设计、编码习惯（至少“犯过的错误，不能再犯”），为流程下游部门（如测试部）提供高质量的输出，使下游部门避免低效、重复劳动，特此通知，请各开发部门遵照执行。以下问题由测试部的问题单、案例分类汇总而成，将常见设计、编码问题分为四类：逻辑类、接口类、维护类和可测试性，问题级别为：逻辑类接口类维护类可测试性。本通知中罗列问题如再次出现，将进行通报批评并记入干部部关键事件库。问题分类逻辑类问题（A类）－指设计、编码中出现的计算正确性和一致性、程序逻辑控制等方面出现的问题，在系统中起关键作用，将导致软件死机、功能正常实现等严重问题；接口类问题（B类）－指设计、编码中出现的函数和环境、其他函数、全局/局部变量或数据变量之间的数据/控制传输不匹配的问题，在系统中起重要作用，将导致模块间配合失效等严重问题；维护类问题（C类）－指设计、编码中出现的对软件系统的维护方便程度造成影响的问题，在系统中不起关键作用，但对系统后期维护造成不便或导致维护费用上升；可测试性问题（D类）－指设计、编码中因考虑不周而导致后期系统可测试性差的问题。处罚办法问题发生率：P=D/SD=DA+0.5DB+0.25DC其中：P－问题发生率D－1个季度内错误总数DA－1个季度内A类错误总数DB－1个季度内B类错误总数DC－1个季度内C类错误总数S－1个季度内收到问题报告单总数1）当D≥3时，如果P≥3％，将进行警告处理，并予以公告；2）当D≥5时，如果P≥5％，将进行罚款处理，并予以公告。目录一、逻辑类代码问题第5页1、变量/指针在使用前就必须初始化第5页【案例1.1.1】第5页2、防止指针/数组操作越界第5页【案例1.2.1】第5页【案例1.2.2】第6页【案例1.2.3】第7页【案例1.2.4】第8页3、避免指针的非法引用第9页【案例1.3.1】第9页4、变量类型定义错误第10页【案例1.4.1】第10页5、正确使用逻辑与&&、屏蔽&操作符第17页【案例1.5.1】第17页6、注意数据类型的匹配第18页【案例1.6.1】第18页【案例1.6.2】第18页7、用于控制条件转移的表达式及取值范围是否书写正确第20页【案例1.7.1】第20页【案例1.7.2】第21页【案例1.7.3】第22页8、条件分支处理是否有遗漏第24页【案例1.8.1】第24页9、引用已释放的资源第26页【案例1.9.1】第26页10、分配资源是否已正确释放第28页【案例1.10.1】第28页【案例1.10.2】第29页【案例1.10.3】第30页【案例1.10.4】第32页【案例1.10.5】第33页【案例1.10.6】第35页【案例1.10.7】第38页11、防止资源的重复释放第39页【案例1.11.1】第39页12、公共资源的互斥性和竞用性第40页【案例1.12.1】第40页【案例1.12.2】第40页二、接口类代码问题第43页1、对函数参数进行有效性检查第43页【案例2.1.1】第43页【案例2.1.2】第43页【案例2.1.3】第44页【案例2.1.4】第46页【案例2.1.5】第47页【案例2.1.6】第48页2、注意多出口函数的处理第49页【案例2.2.1】第49页三、维护类代码问题第51页1、统一枚举类型的使用第51页【案例3.1.1】第51页2、注释量至少占代码总量的20％第51页【案例3.2.1】对XXX产品BAM某版本部分代码注释量的统计第51页四、产品兼容性问题第52页1、系统配置、命令方式第52页【案例4.1.1】第52页【案例4.1.2】第53页2、设备对接第54页【案例4.2.1】第54页3、其他第55页【案例4.3.1】第55页五、版本控制问题第58页1、新老代码中同一全局变量不一致第58页【案例5.1.1】第58页六、可测试性代码问题第59页1、调试信息/打印信息的正确性第59页【案例6.1.1】第59页一、逻辑类代码问题1、变量/指针在使用前就必须初始化【案例1.1.1】C语言中最大的特色就是指针。指针的使用具有很强的技巧性和灵活性，但同时也带来了很大的危险性。在XXX的代码中有如下一端对指针的灵活使用：......_UC*puc_card_config_tab;......Get_Config_Table(AMP_CPM_CARD_CONFIG_TABLE,&ul_card_config_num,&puc_card_config_tab,use_which_data_area);......b_middle_data_ok=generate_trans_middle_data_from_original_data(puc_card_config_tab,Ul_card_config_num).......其中红色部分巧妙的利用指向指针的指针为指针puc_card_config_tab赋值,而在兰色部分使用该指针。但在Get_Config_Table函数中有可能失败返回而不给该指针赋值。因此，以后使用的可能是一个非法指针。指针的使用是非常灵活的，同时也存在危险性，必须小心使用。指针使用的危险性举世共知。在新的编程思想中，指针基本上被禁止使用（JAVA中就是这样），至少也是被限制使用。而在我们交换机的程序中大量使用指针，并且有增无减。2、防止指针/数组操作越界【案例1.2.1】1在香港项目测试中，发现ISDN话机拨新业务号码时，若一位一位的拨至18位，不会有问题。但若先拨完号码再成组发送，会导致MPU死机。处理过程：查错过程很简单，按呼叫处理的过程检查代码，发现某一处的判断有误，本应为小于18的判断，写成了小于等于18。结论：代码编写有误。思考与启示：1、极限测试必须注意，测试前应对某项设计的极限做好充分测试规划。2、测试极限时还要注意多种业务接入点，本例为ISDN。对于交换机来说，任何一种业务都要分别在模拟话机、ISDN话机、V5话机、多种形式的话务台上做测试。对于中继的业务，则要充分考虑各种信令：TUP、ISUP、PRA、NO1、V5等等。【案例1.2.2】对某交换类进行计费测试，字冠011对应1号路由、1号子路由，有4个中继群11,12,13,14(都属于1#模块)，前后两个群分别构成自环。其中11,13群向为出中继,12,14群向为入中继，对这四个群分别进行计费设置，对出入中继都计费。电话60640001拨打01160010001两次，使四个群都有机会被计费，取话单后浏览话单发现对11群计费计次表话单出中继群号不正确，其它群的计次表中出中继群号正常。处理过程：与开发人员在测试组环境多次重复以上步骤，发现11群的计次表话单有时正常，有时其出中继群号就为一个随机值，发生异常的频率比较高。为什么其它群的话单正常，唯独11群不正常呢？11群是四个群中最小的群，其中继计次表位于缓冲区的首位，打完电话后查询内存发现出中继群号在内存中是正确的，取完话单后再查就不正确了。结论：话单池的一个备份指针Pool_head_1和中继计次表的头指针重合，影响到第一个中继计次表的计费。思考与启示：随机值的背后往往隐藏着指针问题，两块内存缓冲区的交界处比较容易出现问题，在编程时是应该注意的地方。【案例1.2.3】【正文】在接入网产品A测试中，在内存数据库正常的情况下的各种数据库方面的操作都是正常的。为了进行数据库异常测试，于是将数据库内容人为地破坏了。发现在对数据库进行比较操作时，出现程序跑死了现象。经过跟踪调试发现问题出现在如下一段代码中:1for(i=0;ipSysHead-dbf_count;i++)2{3pDBFat=(_NM_DBFAT_STRUC*)(NVDB_BASE+DBFAT_OFFSET+i*DBFAT_LEN);4if(fat_check(pDBFat)!=0)5{6pSysHead-system_flag=0;7head_sum();8continue;9}10if(strlen(dbf-dbf_name)!=0&&strncmp(dbf-dbf_name,pDBFat-dbf_name,strlen(dbf-dbf_name))==0)11{12dbf_ptr1=(_UC*)pDBFat-dbf_head;13filesize=pDBFat-dbf_fsize;14break;15}16}在测试时发现程序死在循环之中，得到的错误记录是BusError（总线出错），由此可以说明出现了内存操作异常。经过跟踪变量值发现循环变量i的阀值pSysHead-dbf_count的数值为0xFFFFFFFF，该值是从被破坏的内存数据库中获取的，正常情况下该值小于127。而pDBFat是数据库的起始地址，如果pSysHead-dbf_count值异常过大，将导致pDBFat值超过最大内存地址值，随后进行的内存操作将导致内存操作越界错误，因而在测试过程中数据库破坏后就出现了主机死机的现象。上面的问题解决起来很容易，只需在第一行代码中增加一个判断条件即可，如下：for(i=0;ipSysHead-dbf_coun&&iMAX_DB_NUM;i++)//MAX_DB_NUM=127这样就保证了循环变量i的值在正常范围内，从而避免了对指针pDBFat进行内存越界的操作。从上面的测试过程中，我们可以看到：如此严重的问题，仅仅是一个简单的错误引起的。实际上，系统的不稳定往往是由这些看似很简单的小错误导致的。这个问题给我们教训的是：在直接对内存地址进行操作时，一定要保证其值的合法性，否则容易引起内存操作越界，给系统的稳定性带来潜在的威胁。【案例1.2.4】近日在CDB并行测试中发现一个问题：我们需要的小区负荷话统结果总是为零，开始还以为小区负荷太小，于是加大短消息下发数量，但还为零，于是在程序中加入测试代码，把收到的数据在BAM上打印出来,结果打印出来的数据正常,不可能为零,仔细查看相关代码,问题只可能在指针移位上有问题,果然在函数中发现一处比较隐蔽的错误。/*功能:一个BM模块内所有小区CDB侧广播消息忙闲情况*//*************************************************************/voidCell_CBCH_Load_Static(structMsgCBFAR*pMsg){。。。memcpy((_UC*)&tmp_msg,pMsg,sizeof(tmp_msg));pMsg=pMsg+sizeof(tmp_msg);//sizeof(tmp_msg)=10;本意是想移动10个字节,可是实际上指针移动了10*sizeof(structMsgCB)个字节;CellNum=tmp_msg.usCellNum;。。。}所以结构指针传入函数后，如要进行指针移动操作，最好先将其转化为_UC型再说。总之指针操作要小心为上。3、避免指针的非法引用【案例1.3.1】【正文】在一次测试中，并没有记得做了什么操作，发现HONET系统的主机复位了，之后，系统又工作正常了。由于没有打开后台的跟踪窗口，当时查了半天没有眉目。过了半天，现象又出现了，而且这次是主机在反复复位，系统根本无法正常工作了。我凭记忆，判断应该是与当时正在测试的DSL板的端口配置有关。于是将板上所有端口配置为普通2B+D端口，重新加载在主机数据，现象消失。于是初步定位为主机在DSL端口处理过程中有重大错误。我在新的数据上努力恢复原出