目的
代码评审也叫CodeReview,主要目的是提升代码质量,尽早发现潜在缺陷与BUG,降低修复成本;
同时另一个重要好处是知识转移,促进团队内部知识共享,帮助更多人更好地理解系统。
常见方式
- 代码评审会议,称之为
Code Review Meeting
,就是将团队成员都组织起来开会,让代码Owner上去讲自己代码的实现和思路,其它人发表意见和进行讨论,这种方式的特点之一是需要多个团队成员共同参与。 - 一对一评审,称之为
Single Review
,就是项目owner提交代码之后,让reviewer在空闲的时候帮忙评审代码,并且写出批注,owner收到批注后,进行修改或者回复。这种方式更具备流程化,有对应的日志,能较好的追踪问题。- gitlab的merge request,这里不细讲。
- phabricator,facebook开发的可视化代码评审工具。
- 其它...
Single review需要注意的是当团队成员过多时,并只有一两个reviewer时,会占据reviewer太多时间,所以需要合理安排对应的reviewer很重要。
环境搭建
搭建步骤:
-
安装Navicat Premium(数据库管理工具,可选)
-
安装docker环境
- docker安装portioner(可视化docker管理工具,可选)
- docker安装mysql
- docker安装phabricator
-
phabricator系统配置
- phabricator用户注册
- phabricator关联仓库
- phabricator规则设定
准备一台能访问公司内网的mac作为主机,打开命令行,安装命令如下
brew cask install docker #安装docker
#docker安装成功后,开始安装容器
docker pull mysql # 拉取mysql
docker pull portainer/portainer # 拉取portioner
docker pull redpointgames/phabricator # 拉取最新版的phabricator
运行容器
#运行portainer,运行完成后,可以通过本机ip加端口号 9000来访问
docker run -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer
#运行mysql
docker run -p 3306:3306 --name mysql -v $PWD/mysql/conf:/etc/mysql/conf.d -v $PWD/mysql/logs:/logs -v $PWD/mysql/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 -d mysql:5.6
#运行phabricator,运行完成后,可以通过本机ip加端口号 8891来访问
docker run --name phabricator -p 443:443 -p 332:22 -p 8891:80 -v $PWD/phabricator/backup:/repos -e PHABRICATOR_HOST=http://XX.XX.XX.XX:8891 -e MYSQL_HOST=172.17.0.3 -e MYSQL_USER=root -e MYSQL_PASS=123456 -e PHABRICATOR_REPOSITORY_PATH=/repos -e PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin -it phabricator /bin/bash /app/init.sh
#查看是否运行成功
docker ps -a
命令说明:
PHABRICATOR_HOST:是主机IP地址。
-p 3306:3306:将容器的 3306 端口映射到主机的 3306 端口。
-v -v $PWD/conf:/etc/mysql/conf.d:将主机当前目录下的 conf/my.cnf 挂载到容器的 /etc/mysql/my.cnf。( $PWD/conf:/etc/mysql/conf.d是本地的目录)
-v $PWD/logs:/logs:将主机当前目录下的 logs 目录挂载到容器的 /logs。
-v $PWD/data:/var/lib/mysql :将主机当前目录下的data目录挂载到容器的 /var/lib/mysql 。
-e MYSQL_ROOT_PASSWORD=123456:初始化 root 用户的密码。
tips:
上述操作也可在打开portainer后,直接在界面内配置操作。
挂载目录可根据自己决定。
到目前为此,环境搭建基本完成。
下面是phabricator内部操作,进入phabricator系统:http://XXX.XXX.XXX.XX:8891
phabricator配置
添加用户
1、第一次进入,会提示我们注册账户,这个账户会默认为系统的管理员。
2、然后开始注册其它用户,操作路径如下:
点击右上角账户 >> 下拉菜单 >> logOut >> 回登录页面 >> register New Account
3、这里有验证邮箱功能,这里想直接跳过,所以通过Navicat Premium直接连接本地数据库。
修改phabricator_user-user表,字段isApproved改为1,这样无需邮箱验证,用户也可以正常登录。
编辑菜单
1、主页点击application搜Herald,创建Herald到菜单栏。
2、主页点击application搜Passphrase,创建Passphrase到菜单栏。
添加仓库
1、创建密钥,操作路径如下:
Passphrase >> create Credentail >> SSH Private Key >> Save
click private key >> show Public Key >> 黏贴 Public Key到gitlab里面
2、创建仓库,操作路径如下:
Diffusion >> create Repository >> create a new git repository >> create repository
click repository >> Actions >> manager repository >> URIS >> New URI >> 输入仓库地址,I/O Type设为Observer >> save Changes
3、拷贝仓库,操作路径如下:
click repository >> update Credentail >> choose 密钥,save
click repository ,clone repository,稍等一段时间,看是否拉取成功;未成功,则重新检查上述步骤。
创建规则
规则主要指根据commits message指定对应的reviewer
操作路径如下:
1、click Herald >> create herald >> commits >> global
创建页面中,第一栏是规则名字,第二栏是条件,第三栏是行为动作
2、创建两个条件,条件一选择Repository,就是刚刚拷贝的仓库;
条件二选择Commite Message,第二栏选择contains(包含) 或者 matches regex(正则匹配),后面的填空则是具体的规则,如以模块负责人作为reviewer,所以规则直接填“(模块名):”
3、行为选择add auidtors,选择对应的用户作为reviewer。
具体的例子是:
Commite Message填写“(登录):”add auidtors为“李四”
张三提交信息为:“feat(登录):添加了登录功能”,则李四则成为了这次commits的reviewer
更多rules可以根据实际情况挖掘,并非固定。
For Us
目前我们特性团队开发人数10+,处于新项目快速迭代阶段。采取的是第二种Single Review方式。
做法是将系统分成多个小功能模块,每个模块指定对应的第一负责人和第二负责人。
负责人主要对整个模块统筹把控,例如参与需求讲解、协议对接等,同时也是该模块默认的reviewer。
review时间定在功能提测日,形成固定的review流程,合理分散review的工作量。
不同的开发人员结构,选择reviewer的方式也尽不相同,除了上述说的
如果一个模块只有一个人开发,可以考虑跟另一个模块开发人员组review CP,这样也可以防止一个模块功能只有一个人熟悉的弊端。
如果一个模块是两三个人开发,可以考虑相互之间review,能加深模块成员对该模块的了解。
如果一个app只有一个人开发,这篇文章当作课外阅读~
其它问题
同步时间
进入容器
cd /user/share/zoneinfo/Asia
cp -i Shanghai /etc/localtime
date
参考
汉化phabricator
使用docker安装phabricator的配置和使用方法
第一次登陆后退出提示Authentication Failure
如何做好代码审查?Code Review Meeting还是Single Review
基于GitLab的Code Review教程或指南