如何在IDEA中安装、配置、使用SonarLint插件?

一、安装SonarLint

可以分为在线安装和离线安装。

1.在线安装

在IDEA菜单栏选择File->Settings,左边栏选择Plugins

在线安装选择Browse repositories,搜索Sonar,选择SonarLint进行安装,之后重启IDEA即可

2.离线安装

2.1下载离线安装包:

官方地址

http://plugins.jetbrains.com/plugin/7973-sonarlint/versions

如果官方地址打不开,或者太慢,可以使用这个百度云下载地址

链接:https://pan.baidu.com/s/19daJr27OCjzSRFqAbHzJUg
提取码:oous

2.2下载对应版本的插件压缩包:

可以看到已经有最新的2020版本的了

2.3将插件导入idea。

File->Settings,左边栏选择Plugins,离线安装选择 Install Plugin from disk…,选择下载包所在的位置,导入即可。

2.4导入后重启IDEA。

二、配置 SonarLint

Ctrl+Alt+S呼叫出设置菜单,过滤窗口可以输入sonar,找到下图菜单。
SonarLint General Settings :针对IDEA所有打开项目之后的SonarLint通用配置。
SonarLint Project Settings :针对当前这一个项目配置生效。

配置SonarLint General Settings

点击右侧红框里的+号

配置SonarQube

SonarQube是一个用于管理代码质量的开放平台,可以快速的定位代码中潜在的或者明显的错误。目前支持java,C#,C/C++,Python,PL/SQL,Cobol,JavaScrip,Groovy等二十几种编程语言的代码质量管理与检测。

填写配置的名称,这边使用的是本地sonarQube,选择的右边配置,输入sonarQube的URL,然后点击Next

设置认证方式

有Token和用户名密码两种方式,大家可以根据自己的情况选择对应方式进行配置。

这边我使用用户名密码方式

配置是否开启自动分析

SonarLint安装完后,默认情况下是自动检测项目代码的。若觉得影响效率,可通过菜单Settings->Other Settings->SonarLint General Settings进行设置。

就是这里红框Automatically trigger analysis。

配置更新获取远程SonarQube

当远程SonarQube有更新,可以点击下面的按钮Update Binding进行更新。

配置SonarLint Project Settings

  1. 选择下图中SonarLint Project Settings的菜单
  2. 勾选Enable binding to remote SonarQube server
  3. 在Bind to server 右边下拉选择刚才配置的 sonar配置名称
  4. 配置SonarQube project,可以点击Search in List,再弹出框里找到想使用的某个规则选择想使用的即可.
  5. 点击Apply使得配置生效保存

二、在IDEA中使用SonarLint

安装SonarLint插件重启后,IDEA Tool Windows部分会出现SonarLint View。如果没有出现,选择菜单View->Tool Windows->SonarLint会显示

在项目目录结构中选择要分析的文件夹或是代码文件,右键菜单 Anaylyze->Analyze with SonarLint Https…,或者选中后使用快捷键 Ctrl+Shift+S

如果快捷键冲突参考下图
还是Ctrl+Alt+S打开IDEA设置页面,搜索keyMap,再在右侧搜索sonar,找到SonarLint的快捷键设置,修改为想使用的快捷键

检测完毕后,会在SonarLint Tool View中显示出检测的问题,以类名称进行分类。各类的issue,分为阻断、严重、主要、提示和次要,问题严重性依次降低。点击issue,在右侧会出现对应的Rule,可参照进行修改。

0

关闭SonarLint自动运行检查变为手动

关闭SonarLint自动检查代码

如果敲一行代码SonarLint插件就会自动检查,会太频繁,还会使电脑卡顿。

按如下步骤可以关闭自动检查,依次点击:File -> Settings 或直接Ctrl+Alt+S,搜索”SonarLint”,在Other Settings这一栏,如下图操作:

以后敲代码SonarLint就不会自动运行了。

手动运行SonarLint代码检查

停止SonarLint自动检测代码之后,可以使用Ctrl+Shift+S手动运行SonarLint检查代码。

0