前言
人们常说:“一千个读者就有一千个哈姆雷特”,对于写代码也是,一千个程序员就有一千种编码风格,每个程序员都习惯用自己舒服的风格编写代码,但是对于一个团队协作的项目来说,如果没有形成一种规约,每个人都按照自己的风格在同一个项目中编写代码,那将会是一场灾难,整个项目会变得混乱不堪,维护成本陡增。为了解决这个问题我们可以将规约沉淀成文档,不断的向团队成员进行灌输,但是这种方式比较低效,毕竟人是最难管控的,最好的办法是通过工具来进行制约,这样能最大程度的保证团队中每个人写出来的代码符合同一套规范。现在业界有一些比较成熟的规范可供我们使用,没必要自己造轮子,下面将会介绍在IDEA中配置Google Java Code Style和阿里巴巴的P3C插件。
Google Code Style配置
Google在Github上有一个专门的仓库用于存放各种代码规范。地址为:https://github.com/google/styleguide 其中 intellij-java-google-style.xml 是用于IDEA的Java代码规范配置,我们可以将其下载到本地。google的规范中默认缩进是2个空格,我们可以根据自己的需要改成4个空格,也可以不改。
打开IDEA的设置页面,将配置文件导入,保存即可。
可以使用快捷键:command+option+l 即可按照Google的代码风格进行格式化。
Save Actions插件安装
代码写好后我们需要手动通过快捷键对代码进行格式化,但是在实际开发过程中往往会忘记进行操作。而Save Actions这个插件则可以自动帮我们进行格式化。当代码进行保存时则会自动执行格式化操作。
可以直接在IDEA的插件安装页直接搜索Save Actions即可进行安装,也可以通过jetbrains的插件下载页进行下载:https://plugins.jetbrains.com/plugin/7642-save-actions/versions
插件下载完后重启IDEA后打开配置页进行配置即可使用:
阿里巴巴P3C插件安装
P3C是阿里巴巴的Java代码规范,通过安装插件帮助我们扫描代码中不符合规范的地方。在IDEA的plugins页面搜索alibaba即可安装。也可以通过jetbrains的插件下载页进行下载:https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions
使用快捷键:shift+option+command+j 即可进行代码扫描。