天天看点

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

有一段时间没去电影院了,上次看的还是战争题材的《八佰》,现在还能记得当时的观影感受:热血沸腾的同时,一种宁死不屈的信念从心底油然而生。战场虽然只有四行仓库那么大点的地方,却显得牢不可破,敌人再凶猛的火力,似乎都无法有所突破。

作为和代码打交道的我们,天敌除了乱改需求的“产品经理”(请老老实实地背锅),还有那无穷无尽永远也修改不完的 bug。为了抵御 bug 的侵扰,我们想尽了各种办法,不停地修缮工地,努力让我们的代码变得牢不可破。

这些努力当中,有 3 款优秀的 IDE 插件功不可没。是哪 3 个呢?请腰杆挺直,眼睛睁大,大声呼喊出它们的名字。

01、CheckStyle

Checkstyle 是一个静态代码分析工具,用来检查 Java 源代码是否符合编码规则。

那编码规则由谁定义才能比较被认可呢?

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

除了 Sun,还有谷歌,可以吧?感兴趣的小伙伴可以通过下面的地址阅读一下谷歌的 Java 代码规范。

https://google.github.io/styleguide/javaguide.html

可以在 Intellij IDEA 的插件市场里直接安装 CheckStyle 这个插件。

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

点击 OK 后,就可以在 Intellij IDEA 的底部看到「CheckStyle」面板,默认支持 Sun 和谷歌的代码规范。

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

选择一种规则后,可以点击左侧的 2 个小图标对项目或者模块进行检查(也可以使用右键「Check Current File」 检查当前类文件),然后就可以看到修改建议了。

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

不过,输出的信息里有大量对代码缩进的建议,是因为 CheckStyle 默认的缩进规则是使用 2 个空格,但我更习惯使用 4 个空格,能不能自定义一下呢?

当然可以。

第一步,按照下面的路径把 CheckStyle 的 GitHub 仓库导入到码云(可以提高克隆速度)。

https://github.com/itwanger/checkstyle

第二步,使用 GitHub 桌面版把导入后的仓库 clone 到本地。

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

PS:我已经克隆过了,所以会有警告提示。

第三步,找到 src/main/resources/google_checks.xml 文件,修改 Indentation(缩进)元素后保存。

<module name="Indentation">

 <property name="basicOffset" value="4"/>

 <property name="braceAdjustment" value="0"/>

 <property name="caseIndent" value="4"/>

 <property name="throwsIndent" value="4"/>

 <property name="lineWrappingIndentation" value="4"/>

 <property name="arrayInitIndent" value="4"/>

</module>

第四步,打开 Intellij IDEA 的首选项,找到「Tools」→「Checkstyle」。

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

点击「Configuration File」 栏目底部的「+」号,自定义 Checkstyle 规则。填写「Description」,并将之前复制的路径粘贴到「URL」中,点击「Next」。

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

第五步,配置成功后,在「CheckStyle」面板看到我们自定义的检查规则了。选中后,再次扫描,就可以看到缩进的警告信息消失了。

硬核,这 3 款 IDE 插件让你的代码牢不可破(1)

如果团队内部使用的话,也可以在谷歌和 sun 的代码规约基础上进行一些调整,从而更符合团队开发的习惯,同时还能起到统一代码规范的作用,美哉美哉。