关于开发流程的建议

关于开发流程的建议

纵观互联网家项目的整个开发流程,可以简单梳理为:设计->需求澄清->开发 ->测试->上线。这个也是普遍的开发流程,但是需要关注的是,互联网家的测试是黑盒测试。黑盒测试也称功能测试,它是通过测试来检测每个功能是否都能正常使用。在测试中,把程序看作一个不能打开的黑盒子,在完全不考虑程序内部结构和内部特性的情况下,在程序接口进行测试,它只检查程序功能是否按照需求规格说明书的规定正常使用,程序是否能适当地接收输入数据而产生正确的输出信息。所以它并不是基于代码的测试。

那么黑盒测试会逐渐暴露出一个什么问题呢?黑盒测试不可能覆盖所有代码,覆盖率较低,大概只能达到总代码量的百分之30,特定的程序代码无法被测试到,举个例子,程序的入库逻辑,更新或者插入某张表,那么入库逻辑是不会被测试的。再举个例子,程序的错误的校验逻辑也可能测试不出来,毕竟黑盒测试只关注输入与输出。

但是进行白盒测试昂贵的,所以为了弥补黑盒测试带来的缺陷,我建议可以在开发流程中增加代码评审环节。

代码评审就是我们所说的Code Review,通常多人协助开发下,为了提高主库代码的质量,保证良好的软件架构,促进团队的知识共享,提高团队整体水平,代码评审这一环节就显得尤为重要。

代码评审的目的

根据Google 工程团队执行代码评审活动后发现,除了捕捉bug外,还对5大无形收益。

· 代码评审促进团队和个人开放度

· 代码评审提升团队交付标准

· 代码评审激励团队协作

· 代码评审保持安全至上

· 代码评审构建社会认可

什么时候进行代码评审

代码评审最重要的一点是非常灵活,无固定形式,随时随地都可以发起的。根据github跟apache的一些开源项目的代码评审实践,往往是将PR合并到主干时进行评审并作为是否合并到master分支的一个准入条件。那么针对互联网家项目组,可以在合并到dev分支之前,也就是转测之前进行一次代码评审,评审作为是否能合并到master分支的一个准入条件。

如何执行评审

前期准备工作:

提前安排好一个小的房间或者会议室,利用投影仪和gitlab,进行Code Review,评审会议的成员为组内的相关同事,组长或者项目模块负责人,产品经理,项目经理等,成员可以灵活安排,最好三个以上。

代码作者:

· 确定待评审代码的范围

根据SamrtBear在思科的一个系统小组的研究,一个开发人员一次评审的代码在200-400之间,审查超过400行代码后效率和发现均呈下降趋势。如下图: [图片上传失败...(image-95a738-1568186532925)]

同时,一个小时审查的代码行数应该少于500行,超过500行后效率呈下降趋势。 [图片上传失败...(image-ce0b9d-1568186532925)]

· 简单描述代码的业务逻辑以及主要的业务流程

· 开放的心态接受评审的问题跟建议

代码评审者:

· 准备一个检查列表(checklist),把检查出来的问题标记出来。

· 了解业务逻辑和主要流程。

· 准备好一些问题,对于不确定或者不明白,尽量以问题形式跟作者沟通,而非质疑。

· 准备一些解决方案。在提出问题时候,同时思考更好的方法或者解决方案是什么?你的方法好在什么地方?

代码评审的关注点:

· 功能性 - 功能完整,是否严格按照产品说明书实现产品的所需的功能点

· 可读性 - 代码易读易懂,其它人能够轻松从代码中读逻辑和设计思想,命名是一个学问。

· 可测性 - 代码能够轻松被单元测试覆盖,一般来说无法被单元测试覆盖的代码不是一个好代码

· 可维护性 - 代码运行期间日志输出完整,运维人员或者其它人员可以从日志中了解应用的运行逻辑和状态。

· 性能 - 天下武功唯快不破,确保代码在可度量的数据量级下面保持一个稳定的性能表现。代码是否存在性能问题,预计峰值流量能到多少。

· 多线程,并发和锁 - 在并发或者多线程情况下,代码执行结果是否有问题。过去几个月中我们有一个应用是以Shell的方式启动任务,每一个作业一个进程。由于这种方式带来的资源利用率较低,打算改成多个作业运行在一个进程中(容器)以节省系统资源, 上线后发在存在多处线程不安全的问题,实例变量被污染导致线上问题。

· 安全性 目前虽然有很多的扫描工具可以帮助发现代码安全的问题,但更专业的开发人员在写代码就已经注意这个问题,避免基本的SQL注入,XSS跨域等问题。有兴趣的同学可以参考OWASP CODE REVIEW GUIDE

代码评审中注意事项:

· 代码评审不仅是技术,也社会学。双方沟通表达能力决定代码评审的效率和有效性。评审者需要注意问题的方式或者语气,就事论事,不上升到精神和思想层面。而作者则需秉承一切问题都可探讨或有更好的方案的想法吸收理解他人的想法,即使评审提出不合适的问题,那么你让队友知道一个正确的方法仍然是团队和组织的收获。

· 代码评审不应太过于关注代码风格,代码风格的检查完全可以通过IDE或者扫描工具SONARCube集成CheckStyle, PMD,FINDBUG实现。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,128评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,316评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,737评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,283评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,384评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,458评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,467评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,251评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,688评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,980评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,155评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,818评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,492评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,142评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,382评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,020评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,044评论 2 352

推荐阅读更多精彩内容

  • 1、问:你在测试中发现了一个bug,但是开发经理认为这不是一个bug,你应该怎样解决? 首先,将问题提交到缺陷管理...
    小灰辉先生阅读 1,333评论 0 3
  • -----转载----- 1、问:你在测试中发现了一个bug,但是开发经理认为这不是一个bug,你应该怎样解决? ...
    花开沉浮阅读 7,362评论 4 88
  • 一、 软件测试基本概念 1 bug的概念 bug类型:defect、fault、problem、error… pr...
    三口一个瓜阅读 3,655评论 0 12
  • 1****、问:你在测试中发现了一个bug****,但是开发经理认为这不是一个bug****,你应该怎样解决?首先...
    一箭阅读 9,070评论 1 205
  • 银行软件测试面试问题 软件测试经典面试题 软件测试面试题汇总 测试技术面试题 1、什么是兼容性测试?兼容性测试侧重...
    天宇逍遥heart阅读 1,441评论 0 20