写点什么

开发质量提升系列:checklist 投产检查列表(上)

用户头像
罗小龙
关注
发布于: 2021 年 01 月 24 日
开发质量提升系列:checklist投产检查列表(上)

为了把关及提升代码开发质量,在技术需求开发的过程中,有几个关键点的质量需要把关:

  • 需求分析

  • 代码编写

  • 测试覆盖面

  • 投产前检查

  • 投产后校验

一般情况下,由于开发/测试环境的东西可以随意变更,所以代码开发及测试这两个阶段比较容易过关。但是易过关不等于保证质量,相反更容易把问题给隐藏掉,而这些隐藏的问题都会在投产时全部暴露出来,形成生产问题。这些问题轻则被领导批评,重则丢失工作,无论结果的轻重,肯定会对自己的工作生涯造成一定的污点。所以,投产前的检查是把关代码质量的最后一道防线,必须要引起重视。

之前分享的内容《一个系统小BUG修复投产居然花了3个小时来处理(上)》与《一个系统小BUG修复投产居然花了3个小时来处理(下)》,记录了一次投产因为一个配置文件的信息错误导致耗费了 3 小时来“填坑”。究其原因,就是因为缺少相应的 checklist(投产检查列表)检查,引发了如此血与泪的教训。

那么,该如何编写适合自身项目的 checklist 呢?

在编写前,首先要了解 checklist 检查项的特点:

  • 易错性:检查代码中的易错项是 checklist 最主要的目标。比如最容易出错的配置文件,由于软件代码会在开发、测试、准生产、生产环境中流转,每个环境的配置信息(这里的配置信息涉及数据库、中间件、服务器等)都不一致,导致开发人员在打包投产包时一不留神就把非生产环境的配置信息打到投产包内,导致上线报错。既然这样,我们可以把生产的配置文件信息作为检查项,让开发人员在打包前进行比对,或者让开发团队做交叉验证,这样就可以尽可能降低配置文件信息错误的发生。

  • 漏缺性:开发人员在打包投产包的过程中,很容易会“丢”文件。比如投产内容涉及数据库物理表的增删改查,很容易就把相应的 SQL 文件漏缺掉,导致上线报错。当然,仅依靠检查项还是很难发现投产文件漏缺的问题,因为一般情况下开发人员会遗忘所有的投产变更内容,所以这个问题还需搭配准生产模拟上线,才能从根本上解决。

  • 环境不对称性。开发、测试、准生产环境,由于一般都缺少专职人员进行代码或服务器信息维护,所以每个环境的版本可能存在一定差异。若差异较小时,运气好一点可能不会暴露问题。若差异较大时,很容易就会“踩雷”了。所以还须加上环境信息的检查项,使投产内容万无一失。

了解 checklist 的检查项特点之后,就基本知道该如何编写了,这部分内容且听下回分解。


发布于: 2021 年 01 月 24 日阅读数: 23
用户头像

罗小龙

关注

镜花水月 2020.08.18 加入

数据工作者,目前就职于商业银行数据部门,擅长数据架构、数据建模、数据开发及数据分析

评论

发布
暂无评论
开发质量提升系列:checklist投产检查列表(上)