在开发过程中,我们经常胸有成竹在胸地写了一段代码,结果一跑就报错。找了半天查不出问题,最后让隔壁工位的大神一看,原来是个超低智商的问题。。。又或者,想不想有个虚拟的朋友和你结对编程呢,你每写一些代码,它就能告诉你写的代码有哪些风险或者还有哪些可以优化的点。是的,idea里就有这样的靠谱插件,走过路过不要错过,先来了解一下它,再说说它怎么用!
1.SonarLint
SonarLint是一款强大快速的能帮助开发者发现代码里的bug或是代码质量优化点的扩展工具。支持很多主流的语言:JAVA、js、PHP、Python。也支持主流的IDE们,idea、Eclipse、vs。在idea里更是以插件的形式让人无缝接入,如果不考虑使用第三方的sonarqube服务器直接使用的话直接热插拔了都!下面看看两种模式的优缺点~
- 独立模式:使用插件内置规则进行检查;优点:无须配置,开箱即用,检查速度快;缺点:内置规则与SonarQube服务器规则的不一致,会造成检查结果的不一致。
- 连接模式:需连接SonarQube服务器;优点:简单配置后,即可使用SonarQube服务器的规则和配置项进行检查,检查结果保持最大一致。缺点:项目需先接入SonarQube,不然你连接什么啊是吧。。。
2.接入
我主要使用的语言是JAVA,日常使用的IDE是idea。下面我将以此为例来进行说明。其它的语言或IDE请找(谷哥||度娘)
2.1 安装插件
preferences->plugins->最底下browse repositories->输入sonarlint->点击install
我已经安装了所以install按钮不见了
2.2独立模式直插直用
由于刚安装完插件之后设置是默认打开自动检测的,所以现在你的最底层工具栏里应该会多一项sonarlint,你打开不同的Java文件,检测会自动进行 ,检测结果也会直接展示在哪里
2.3分析结果说明(两种模式下通用)
可以看到检测结果将检查出来的问题分级列举在左侧,图中展示的是一个minor级别的小问题。还有红色的major的大问题。。。
没见过其它的了,希望大家也不要见到更高级别的警告了。对于每个具体的问题,右侧会列出该问题的描述和为什么它是不好的。
而且还会把代码的正反两个范例做一个展示,以让开发者真正理解问题所在。对提升代码质量、保持好的代码风格、防范错误非常有帮助有木有。
2.4连接模式
对于企业级的开发,很多企业可能对代码风格和检查项有自己的要求。这就可以为公司的开发者提供sonarqube服务器,在其上进行配置,然后
开发者连接以后就可以让sonarlint按照公司的定义来进行检查了。
ps:如果不想它自动检查把下图1处的对勾取消勾选就可以了
选择sonarlint general settings->点击左下角加号->进行相应的配置 一步步往下填直到finish就好了
另外公司里一般对不同的项目有不同的检查配置,你需要配置项目绑定,将自己本地项目与对应的sonarqube服务器上的项目绑定,并勾选“enable binding to remote sonarqube sever”
还是刚才的菜单栏,选择sonarlint project settings进行配置,图中有涉及公司业务的东西就上码了~
3.总结
按照上述的说明配置完连接模式后,使用方式和独立方式并没有什么区别。至此你就可以和sonarlint结对编程了,不论是哪种方式可以看到sonarlint确实是代码质量的有力保证,是优秀的开发辅助工具!