介绍
代码质量管理的开源平台,用于管理源代码的质量 通过插件形式,可以支持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测。集成了CheckStyle,PMD,Findbugs等工具校验规则,具有重复代码发现,代码测试覆盖率,代码注释率,及所有的检测率变化追踪的功能特性。
特点
SonarQube:开源的代码质量管控平台,我们使用的http://localhost:9000即为SonarQube。
SonarLint:一个扩展插件,可以安装在idea与eclipse等开发工具中
Eclipse中的使用
1、 安装
help -> eclipse marketplace...,搜索sonarlint, Install。
2、 使用
打开java文件,soanrlint会自动进行检测,对于不规范或有问题的代码会在下方划蓝色波浪线,如图:
鼠标放在蓝色部分会有弹框显示错误信息或建议修改信息
点击“open description of rule”可以查看具体的错误描述,错误示例及修改示例。
在项目或单个java文件上右键 -> sonarlint -> Analyze 进行手动操作分析。这样SonarLint Report面板中查看所有的异常信息
3、Server
连接SonarQube的主要目的是同步分析规则、质量规则与自定义设置。操作如下:
从Window -> show view 中找到SonarLint Bindings打开;
在该面板空白处 右键创建 server连接,选择SonarQube
使用UserName+Password或者token登陆
没有token可以点击右侧按钮创建,或者寻找管理员创建
配置名称
完成服务配置
绑定工程,点击add
输入sonarQube中创建的工程的名称
完成
4、 结果同步SonarQube显示
在maven的settings.xml中配置如下:
配置完成后,使用soanr:sonar命令运行项目,此部分要求JDK为1.8。clean install sonar:sonar
可以打开http://localhost:9000/dashboard?id=com.xxx查看对应的错误信息,也可以在SonarQube点击Issues进行查看
IDEA中使用
1、 安装
File -> settings -> plugins 搜索sonarLint,Install。
2、 使用
在左下角点击隐藏面板,可以看到sonarLint,打开
打开java文件,soanrlint会自动进行检测,对于不规范或有问题的代码会添加暗金色的背景色,鼠标放上去会有如图提示:
也可以通过点击上图的绿色倒三角手动执行分析。
3、 Server
连接SonarQube的主要目的是同步分析规则、质量规则与自定义设置。操作如下:
从File -> settings -> OtherSettings中找到“SonarLint General Settings”打开;
点击加号,输入一个name,如localhost;选择SonarQube,Url为http://localhost9000;
选择Login/Password或者token,输入账号与密码或者token;
finish
勾选“Enable binding to remote SonarQube Server”,选择添加的server,搜索到你需要绑定的项目,然后选择确认。
4、结果同步SonarQube显示
同Eclipse部分,此部分要求JDK为1.8。