写点什么

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

作者:Java高工P7
  • 2021 年 11 月 12 日
  • 本文字数:1632 字

    阅读完需:约 5 分钟

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


https://github.com/itwanger/checkstyle


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



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」。



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



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



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

02、Alibaba Java 代码规范

《阿里巴巴 Java 开发手册》自从第一个版本起,就倍受业界关注,毕竟是阿里出品啊。最新版是嵩山版,离线下载地址我贴一下:


https://pan.baidu.com/s/1iBVFWUPuJNFEBfG8cmd-aA 密码:pplh


我看了很多遍,有些规约已经深深地刻在脑海里,在写代码的时候就会特别注意。甚至有时候写完代码,都要对照一遍规约,看看有哪些细节需要调整。


为了让开发者更加方便、快速的将规范推动并执行起来,阿里巴巴基于这本手册的内容,研发了一套自动化的 IDE 插件(有 Intellij IDEA 和 Eclipse 两个版本)。


Intellij IDEA 可以直接在插件市场进行下载安装。



目前插件检测有两种模式:实时检测和手动触发。


1)实时检测


《阿里巴巴 Java 开发手册》的第一条规约如下:


![](https://img-blog.csdnimg.cn/img_convert/319f0016283083d820695c529


【一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义】
浏览器打开:qq.cn.hn/FTf 免费领取
复制代码


ff09b81.png)


实时检测是默认开启的,我们来“明知故犯”一下:



在编码的时候,插件就会及时的给出提示建议,说【_name】命名不能以_或$开始


如果不喜欢实时检测的话,可以通过「Tools」→「阿里编码规约」→「关闭实时检测功能」来进行关闭。


2)手动触发


在代码编辑区域右键菜单选择「编码规约扫描」就可以对当前文件进行扫描,也可以选择整个项目或者某个目录进行扫描。



插件扫描后,会将一些不合手册上面的代码按照 Blocker/Critical/Major 三个等级显示出来,点击某个修改建议可以直接跳转到对应的代码处,这样的话,修改起来就非常便捷了。

03、SonarLint

SonarLint 可让我们在编写代码的时候就对错误和漏洞进行修复,像拼写检查器一样,可以即时突出地显示出编码中的一些问题,并提供清晰的补救指导,方便我们在提交代码之前就解决它们。


SonarLint 支持很多种语言,包括 Java、Kotlin、JavaScript、Ruby、Python、PHP 等等。也支持很多种 IDE,包括 Eclipse、Intellij IDEA、Visual Studio、VS Code 等等。


Intellij IDEA 可以在插件市场直接安装。



SonarLint 默认也是开启实时检查的,当我们在声明 List 的时候没有使用泛型,它不仅指出了问题,还给出了修改建议,甚至示例都写好了,真贴心。


04、总结

好的编程规范有助于写出易于阅读、质量更高、错误更少、更易于维护的程序。CheckStyle、Alibaba Java 代码规范、SonarLint 这 3 款 Intellij IDEA 插件能在很大程度上帮助我们达到这个目的。


另外,如果你在 Intellij IDEA 插件市场中下载这 3 款插件的时候速度比较慢的话,可以通过下面的方式进行下载,我已经贴心地替你打包好了。


链接:https://pan.baidu.com/s/1W9AsoLrBJTEtE9JTJlqNXw 密码:pa92

用户头像

Java高工P7

关注

还未添加个人签名 2021.11.08 加入

还未添加个人简介

评论

发布
暂无评论
硬核,这 3 款 IDE 插件让你的代码牢不可破