1、sonarqube介绍:一款代码质量管理的开源平台,用于管理代码的质量,通过插件形式可以对java,javascript,pl/sql等二十几种编程语言代码质量管理与检测。检测维度:1、不遵循代码标准 2、潜在缺陷 3. 糟糕的复杂度分布 4. 重复 5. 注释不足或者过多 6. 缺乏单元测试 7. 糟糕的设计。为什么要在项目中使用SonarQube,从上面的描述已经可以略知一二了,最主要的原因就是提高代码质量,了解自己在编码过程中犯过的错误,让自己的代码更具有可读性和维护性。
2、sonarqube安装部署
1) windows下面的安装:
环境要求
- JDK: 版本最好在1.6及以上,不建议使用太低的版本
- 数据库: 目前主流的数据库SonarQube基本都支持,这里用MySQL来进行配置,版本5.6及以上
下载地址:SonarQube官网下载链接:https://www.sonarqube.org/dow...
其中STL的为稳定版本
2)安装,找个目录直接解压就可以。
进入目录后 conf为配置文件目录,bin为启动目录. 解压后就可以直接启动,启动bat文件在如下图的相关目录下面
现在就可以访问:http://localhost:9000/ 主界面,默认的登录账户密码为:admin/admin
3)配置数据库访问访问地址
conf下的conar.propertise
这个配置的相关参数就不多解释,相信大家应该都知道,也可以配置想关的访问端口,这里就不展示了
4)、汉化包的安装 首先需要先管理员登录
然后搜索: chinese pack, 然后install即可
2、linux下的安装部署也是一样的,下载zip包,然后上传到服务器上就可以,然后使用使用unzip解压即可
2、然后介绍sonar-scanner安装部署
sonarqube相当于一个服务端,这个scanner就是具体的代码分析执行者。
下载地址:https://docs.sonarqube.org/di...,根据系统选择对应的版本
2、下载后解压
3、配置文件conf ,sonar-scanner.properties
sonar.host.url=http://localhost:9000
#----- Default source code encoding
sonar.sourceEncoding=UTF-8
sonar.jdbc.username=root
sonar.jdbc.password=
sonar.jdbc.url=jdbc:mysql://127.0.0.1:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
useConfigs=maxPerformance
sonar.login=admin
sonar.password=admin
4、sonnar-scanner环境变量设置
然后通过dos窗口验证是否配置成功
恭喜如果完成了上述配置就可以进行代码审核了。
5、进入项目的根目录下面,创建 sonar-project.properties,实例文件如下
sonar.projectKey=Test //项目key
sonar.projectName=Test //项目名字
sonar.projectVersion=1.0 //项目版本
sonar.sources=src //要分析的源码的目录 多个目录用英文逗号隔开
sonar.java.binaries=WebRoot/WEB-INF/classes
//新版的需要加上binaries这个属性,否则无法解析,我这里是Java项目,所以部署后有对应的classes文件夹
sonar.language=java //语言 js为javascript代码
sonar.sourceEncoding=UTF-8 //编码
6、然后在改目录下运行: sonar-scanner,如果出现如下结果就成功了
这样在sonarqube界面就可以看到相关相面的分析情况了。
注: linux下面也是同样的配置即可。
总结: sonarqube在安装过程只要配置好了,其中还是比较的顺利,但是我发生过sonarqube启动失败的现象。