介绍
代码质量管理的开源平台,用于管理源代码的质量 通过插件形式,可以支持包括 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
url 为:http://localhost:9000
使用 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。