一.我们为什么要先进行代码的自测
在平常的日常开发中,多数情况下都是利用较短的时间去完成较多的开发任务,只要流程跑通了我们就忙于提交代码,正是因为这样导致我们忽略了细节,甚至写出非常不符合规范的代码,这时我们就需要对代码进行自测。
二.代码自测的流程
- 文件编码统一配置:UTF-8
- Java文件配置注释模板:当前类的版本号、日期、姓名、描述等等
- 安装Save Action插件:保存修改时自动格式化,确保代码格式统一
- 安装FindBugs插件:自动帮开发人员找出潜在BUG
- 代码规范检查:a. 安装CheckStyle插件(可以自配检查样式或者引用Google样式);b. 安装第三方检测工具,如阿里巴巴Java规范(比较严格)
三.插件的集成以及演示(以下演示都是基于Android studio以及Mac系统)
1.文件编码统一配置:
Android studio -> preference -> Editor -> File Encodings
2.Java文件配置注释模板:
Android studio -> preference -> Editor -> File and Code Templates
- 安装Save Action插件:写完代码 command + s 自动格式化
搜索Save Action插件:Android studio -> preference -> Plugins -> 搜索Save Actions -> install -> Restart Android Studio
配置Save Action插件:Android studio -> preference -> Other Setting -> Save Actions
4.安装FindBugs插件
搜索Save Action插件:Android studio -> preference -> Plugins -> 搜索FindBugs -> install -> Restart Android Studio
配置Save Action插件:Android studio -> preference -> Other Setting -> FindBugs
5.代码规范检查-安装阿里巴巴Java规范
阿里巴巴插件:Android studio -> preference -> Plugins -> 搜索alibaba -> install -> Restart Android Studio(如上图的搜索所示)
下面主要介绍如何扫描单个File和如何扫描整个项目
四.代码自测的不足
代码自测既是静态代码检查的第一步,又是静态代码检查中最容易忽视的一步。代码自测可以在一定程度上减少不符合规范的代码,但是自测并没有强制对开发人员进行约束,有时候开发人员会有一定的惰性,假装自测了或者自测后并没有认真对代码进行修改,所以我们需要引入接下来的两步操作。