一,简介
Sonar是一个代码质量管理的开源工具,它通过插件的形式能够识别常见的多种编程语言(例如Java, C#, PHP, Python等)代码质量问题。Sonar可以帮你分析出以下代码质量问题: 1.不遵循代码标准; 2.潜在的缺陷,比如空指针、bug;3.代码重复;4.注释率不足或过高;5.糟糕的复杂度,比如if循环嵌套太多、类/方法太大;6.缺乏单元测试。在公司中,一般是把SonarQube部署在服务器端,当开发人员提交代码时,Jenkins触发SonarQube进行代码检查,开发人员根据代码检查结果进行问题修复。但是这样,开发人员往往只会关注被阻断的代码问题,对于Sonar提示的设计、性能方面的问题往往视而不见。所幸现在SonarSource开发了SonarLint插件,可以在IDE(Intellij Idea、Eclipse、PhpStorm等)中嵌入,这样开发人员不仅能使用SonarLint中内置的代码检查规则进行代码检查,也可以连接到远端服务器拉取远端规则。有了它,我们就可以在编写代码的过程中根据SonarLint的提示编写高质量代码了。下面以在PhpStorm安装SonarLint为例,其他IDE基本相同。
二,安装:
步骤1: 打开settings面板,点击Plugins界面;
步骤2: 搜索“SonarLint”,在检索结果列表页找到对应的SonarLint,
步骤3: 点击“Install”按钮,安装完毕重启PhpStorm后即可完成插件的安装.
三,配置同步SonarQube规则:
步骤1: 打开settings面板下,点击Other Setings下的SonarLint General Settings;
步骤2: 点击SonarLint General Settings界面右侧的'+'号添加配置;
步骤3: 在新弹出界面的Configuration Name中输入任意文字(给配置取名), 例:patozon
步骤4: 勾选SonarQube
步骤5: 在SonarQube Url栏中输入SonarQube服务器的url地址: http://sonar.patozon.net
步骤6: 点击next,进行token的配置
步骤7: 在Token栏目输入: 6fae1e5e26b62c2d7af212fe9e33f50486c75b2f 点击next,点击 Finish
步骤8: 点击Other Setings下的SonarLint Project Settings;
步骤9: 勾选Bind Project to SonarQube / SonarCloud
步骤10: 点击Connection下拉框选择sonar服务器配置
步骤11: 点击SEARCH IN LIST...
步骤12: 选择你的项目然后点击OK, 最后点击APPLY完成配置