实验四---代码评审

Posted 2020-12-20 wyscl

 实验4      代码评审

一、实验目的

1） 了解代码审查的含义；

2） 掌握相关编程规范检查工具的安装与使用；

二、实验内容及要求

Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量，通过代码评审可以达到如下目的：

●在项目早期就能够发现代码中的BUG

●帮助初级开发人员学习高级开发人员的经验，达到知识共享

●避免开发人员犯一些很常见，很普通的错误

●保证项目组人员的良好沟通

●项目或产品的代码更容易维护

     代码评审主要内容是编程规范，重构方法，架构设计，性能安全，日志，可读性，扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误，提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识，可是很多时候并未被有效执行，甚至被认为是一项费时费力的工作。借助一些工具可以更容易，更有效率地来进行Code Review。

1、以小组形式，针对前面“实验一”中所完成的代码，进行代码评审(走查)，重点检查以下情况。你也可有查询相关材料，建立更细化的检查清单（check list）

- 程序是否能正常工作，代码是否实现预期的功能，逻辑是否正确。

- 代码是否遵循的编程规范

- 代码是否尽可能的模块化

- 所有的数据输入是否都进行了检查

- 是否有注释，并且描述了代码的意图

- 代码的可理解性和可测试性

2、按“实验二”的分组方式，两人一组，随机分配另一组的代码作为本组评审和分析的对象

一些编码规范的检查工具如下，也可自行查找工具使用。

java语言      

- 采用使用eclipse Checkstyle插件 

- CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名，方法体的最大行数，重复代码检查等等。

如果你使用idea ，可以使用Alibaba Java Code Guidelines插件，参考链接如下：https://github.com/alibaba/p3c/wiki/IDEA%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3

 

C++语言

- 可使用Google代码规范工具Cpplint。

- Cpplint是一个python脚本，Google使用它作为自己的C++代码规范检查工具，VSCcode可配置Cpplint对C++代码进行规范检查。

python

- 可采用pylint

- Pylint 是一个 Python 代码分析工具，它分析 Python 代码中的错误，查找不符合代码风格标准（Pylint 默认使用的代码风格是 PEP 8，具体信息，请参阅参考资料）和有潜在问题的代码。目前在 eclipse 的 pydev 插件中也集成了 Pylint，VSCcode可安装pylint插件

    当发现了项目存在的问题后，可通过Bug跟踪系统向项目维护者反馈问题（issue）,管理Issue的系统称为BTS（Bug Tracking System，Bug跟踪系统）。当今具有代表性的BTS有Redmine、Trac、BugZilla等。GitHub自身也加入了BTS的功能。在GitHub上，可以将它作为软件开发者之间的交流工具。通过github的issues功能开发者可以便捷的发现软件的BUG并报告，想向项目所有人询问或用来追踪各种想法探讨准备实施的任务。

三、实验内容及要求

1.clone待审查对象的仓库

首先在git上把需要进行代码审核的仓库clone到本地

 

2.给代码开发环境配置插件

  打开本地文件后发现待审查对象采用的是java语言，于是选择用eclipse进行代码审查，采用的插件是Ali-CodeAnalysis代码审查工具。

配置过程：在eclipse主界面工具栏中选择Help->Install New Software,再弹出的窗口中选择Add,之后会弹出一个新窗口如下图，然后name可以任意命名如check，在下方的Location中输入Update Site地址：https://p3c.alibaba.com/plugin/eclipse/update 回车，再根据提示直到安装完毕，安装配置是否成功可通过在工具栏Windows->Preferences->General中是否有Alibaba Code Analysis看出如下图。注：插件配置安装后eclipse会重启。

 

 

 

 3.进行代码审查

由于该小组和我组课题一致，因此对于代码能否满足课题要求的审查会比较熟练。

（1）首先运行程序，发现程序是可运行的，且满足了课题要求

（2）开始代码审查：右击项目，然后找到阿里编码规约扫描并点击，即可开始扫描代码如图

 

（3）分析代码扫描结果

如果代码有问题，则会在出问题的代码行前端出现和等符号，说明扫描出该行代码有问题，将鼠标放到行端的符号处便能显示出该行代码出问题的原因。如图

 

 

 代码审查结束后，发现大致问题有3种Blocker、Criticals和Majors，分别对应问题的严重性从重到轻。

Blocker问题有：if ，else的括号问题，这两种语句中必须要有大括号

Criticals问题有：Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象调用equals。

 Major问题有： ①

 

                         ②

 

                         ③

                         ④

 

                         ⑤

 

                         ⑥

 

综合同组队友审查的结果可以归纳为下表

 4.在github上给被审查的小组提交issue

 

 

 

 

 

 

 

 

 实验小结：通过本次代码审查实验，我学到了很多，例如如何进行代码审查以及代码审查的规范，还有了解到了代码审查这个东西，以前以为代码只要不报错能运行就好了，现在知道了原来代码既要能流畅运行，也要简介规范，这才是一个好的程序员追求的目标。比较直接的收获就是知道了如何给eclipse配置插件和插件的用法，这对我以后的学习帮助很大，此次实验受益匪浅。