过程瞭望 实践萃取——记应用平台研发部代码质量管控

Posted 2021-05-02 我们的开心

文/李霞 孟岱

为更好地发挥项目管理优秀实践对中心项目的借鉴作用，促进不同项目团队间研发和管理工作经验的分享及复制，项目管理办公室以“过程管理员视角主动发现”和“项目组视角积极总结”的方式，持续总结和萃取项目实践。实践领域可涵盖但不限于项目管理、研发过程管理、质量管理、工具应用、配置管理等。

本期在这里和大家分享一下应用平台研发部是如何进行项目代码质量管控的探索和实践。

提升代码质量，夯实应用基础

众所周知，代码质量是研发团队技术水平和管理水平的直接体现，通常包括代码的健壮性、安全性、可用性、可维护性，以及代码性能和风格等要求。代码质量管控对于任何软件项目来说，都是不可或缺的一部分。而应用平台作为总、分行相关应用的基础支撑，其性能、可靠性、稳定性对上层应用影响巨大。平台代码质量好比是上层应用的基石，直接决定了上层应用的运行质量和维护成本。唯有不断提高平台代码质量，才能降低上层应用的使用成本。那如何提高代码质量呢？如何进行代码质量管控？相信这不仅是平台项目苦恼的事情，也是所有软件项目苦恼的事情。经过不断探索与实践，应用平台研发部通过实施“集成测试前开展Code Review”和“代码框架搭建后开展每日构建”，有效提高了平台代码质量，降低了项目整体成本。下面我们以应用平台二组的项目实践为例，来介绍一下平台研发部的项目代码质量管控。

01

开展Code Review，发现潜在缺陷

新手加入、人员变动、代码编写不规范等问题在任何软件项目研发过程中都不可避免。由于新手技术不娴熟，编写代码通常质量问题较多。发生人员变动，接手工作的员工通常会对原有代码设计思路存在理解偏差，写出问题代码。而研发人员在编码过程中更是时常忽视代码规范，降低代码的可读性和可维护性。那么，我们应当采用什么样的管理措施提高平台代码质量，保证代码符合规范呢？通过不断摸索和积累，应用平台研发部给出了他们的解决之道，即在代码稳定后，集成测试前开展Code Review，发现潜在缺陷。Code Review通常是进行代码逻辑检查，检查包括是否有代码重复、处理逻辑是否合理、是否有性能问题、是否易读、是否可维护等。

在集成测试前，应用平台二组会要求项目经理通过评审会方式组织开展Code Review，评审范围是该项目新编写的全部代码，评审成员不少于本模块所有成员。在开展Code Review的过程中，源码作者讲述自己设计思路，评审人员根据自身的经验和评审检查点随时指出其代码中存在的缺陷，以及不符合标准、规范之处，交流编码经验。若发现问题，源码作者自己记录下存在的问题，后续整理到《代码评审问题列表及报告》中，并逐个进行完善。

在问题修改过程中，若遇到共性问题、痛点问题，则会记录在本职能组的《QA列表》中供全组人员借鉴，内容主要包括应用场景、解决步骤方案、解决问题中的心得、解决问题耗时等内容。

应用平台研发部从成立以来，各职能组一直坚持开展Code Review。通过长期持续开展，一方面在实施测试前即发现并修改缺陷，有效提高了代码质量，降低了项目整体成本；另一方面，也鞭策了全处开发人员自觉形成良好编码习惯，促进开发人员间的经验交流。通过多人一起Code Review，不仅提高平台项目代码质量，还让每个人的代码成果得到了其他视角的审视，同时也加快了新老员工研发技能的良好传承。

02

开展每日构建，增加缺陷过滤网

开展Code Review可较早发现问题代码，但是代码评审也会有一些痛点，比如在发现一些低级错误上浪费了较多时间。那有没有什么方法可以在Review之前就能消灭掉一些低级的代码违规呢？应用平台研发部各项目组通过使用TFS，在研发阶段开展每日构建执行单元测试，同时使用代码合规检查工具扫描代码违例，为开展Code Review和测试增加了缺陷过滤网。

应用平台研发部项目组开发人员在每天下班前，提交当天完成的项目代码及单元测试代码。每日构建执行时，通过TFS工具调用测试案例，自动完成方法、接口、交易的单元测试，同时通过代码合规检查工具自动扫描编码规范性。每日构建结束后，开发人员通过查看测试覆盖率报告、代码合规检查报告等，及时掌握代码行覆盖、分支覆盖、代码违例等情况。根据测试覆盖率报告、合规检查报告，开发人员及时修改代码违例、修正代码缺陷。对于确认的缺陷，项目组约定开发人员尽可能当日解决；对于争议缺陷，项目组通过讨论会方式商讨解决。通过执行自动化测试、工具自动扫描违例，反向驱动项目组开发人员主动修复代码缺陷，并快速完成回归验证。

如今，应用平台研发部开发人员已然熟练运用Code Review和项目实施阶段的每日构建机制，软件质量意识也深深地融入到了每个人的日常工作中。为实现“平台让应用开发更简单、更高效、更可靠”的愿景，应用平台研发部将继续实践良好开发机制，持续做好代码质量提升。

轮值总编：张纪峰

责任编辑：王晨阳

美编：杨超

技术支持：刘津津

我们的开心 · 总编辑部

（e 语）

-  

快 乐 生 活 

开 心 工 作 

   

我 们 的 开 心

微信号：abc_kx

■ 本文为“我们的开心”第1192期文章  

■ 转载本号文章请联系我们

■欢迎来稿：请按“作品名-作者-部门”命名，发送到[e-mail]