Sonar 配置及部署(windows系统)

时间:2023-03-08 17:28:17

Sonar 是一个用于代码质量管理的开放平台。通过插件机制,Sonar 可以集成不同的测试工具,代码分析工具,以及持续集成工具。

与持续集成工具(例如 Hudson/Jenkins 等)不同,Sonar 并不是简单地把不同的代码检查工具结果(例如 FindBugs,PMD 等)直接显示在 Web 页面上,而是通过不同的插件对这些结果进行再加工处理,通过量化的方式度量代码质量的变化,从而可以方便地对不同规模和种类的工程进行代码质量管理。

进入主题,安装Sonar:

前提条件:安装好Mysql、Jdk,本次采用的是Mysql5.7和Jdk1.8版本,关于mysql和jdk的配置不在赘述,记得启动mysql。(数据库安装

数据库配置

mysql中需要创建对应的sonar账号,创建如下:

#新增用户,由于这个是变化的,建议导出数据库mysql表中的语句,将root的insert语句更新下进行插入操作。
insert into user(Host,User,authentication_string) values("%","sonar",("123456"));
#用户授权-可以远程访问数据库
grant all privileges on *.* to sonar@"%" identified by "123456" ;
#本地用户授权-可以访问本地的所有数据库
grant all privileges on *.* to sonar@localhost identified by "123456" ;#设置完成后,需要执行以下命令生效flush privileges ;

Sonar 配置及部署(windows系统)

sonnar配置

Sonarqube(本次使用版本sonarqube-6.7.6)

下载地址:https://www.sonarqube.org/downloads/

Sonar-Scanner(针对不同的操作系统下载对应的版本)

下载地址:https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner

下载后,开始对配置文件进行修改,如下

A、Sonarqube,修改conf—>sonar.properties修改:

 sonar.jdbc.username=sonar     #连接数据库用户名
 sonar.jdbc.password=123456    #连接数据库密码
 sonar.jdbc.url=jdbc:mysql://10.10.126.234:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false  #连接数据库地址及表名
 sonar.web.host=10.10.126.234   #服务器/本机的ip
 sonar.web.port=9100            #服务器/本机的端口
 sonar.ce.javaOpts=-Xmx512m -Xms128m -XX:+HeapDumpOnOutOfMemoryError      #设置内存占用最大值

host、port就是sonar服务启动的url,服务启动后,可直接访问   http://10.10.126.234:9100。

启动sonarQube:Sonarqube,运行bin—>windows-x86-32—>StartSonar.bat:

Sonar 配置及部署(windows系统)

访问Url链接,界面如下:(默认登录密码账号密码是admin      admin)

Sonar 配置及部署(windows系统)

B、Sonar-Scanner,修改conf—>sonar-scanner.properties修改:

 sonar.host.url=http://10.10.126.234:9100     #----- Default SonarQube server
 sonar.sourceEncoding=UTF-8    #----- Default source code encoding
 sonar.jdbc.username=sonar     #数据库用户名
 sonar.jdbc.password=123456    #数据库密码
 sonar.jdbc.url=jdbc:mysql://10.10.126.234:3306/sonar?useUnicode=true&characterEncoding=utf8 #----- MySQL

sonar-scanner需要配置环境变量,设置方式如下图:

Sonar 配置及部署(windows系统)

查看配置是否正确,使用命令:

sonar-scanner --verson 

Sonar 配置及部署(windows系统)

进入需要执行审查的代码下,启动命令:

sonar-scanner -X

一段时间后,即可在sonarqube的链接下看到审查结果。

项目中调用sonar扫描配置如下:

在单个模块中的sonar-project.properties配置(这里以其中一个为例):

# projectKey项目的唯一标识,不能重复,projectName在sonar服务端显示的项目名称。
sonar.projectKey=20190322-test1
sonar.projectName=-test1
sonar.projectVersion=1.0
sonar.sourceEncoding=UTF-
sonar.sources=src                            #当前文件中需要分析的源码文件名,一般是src
sonar.java.binaries=target/classes           #二进制文件所在位置(windows系统中,用“/”代替“\”)
sonar.java.source=1.8                        #标注使用的jdk的版本。

如在一个项目中有多个文件,可在最外层调用,对应sonar-project.properties配置如下(这里的模块中有4个不同的子模块):

#required metadata
#projectKey项目的唯一标识,不能重复
sonar.projectKey=v1.2-test
sonar.projectName=v1.2-test
sonar.projectVersion=1.1
sonar.sourceEncoding=UTF-8
sonar.java.source=1.8
sonar.modules=moopo-server,moopo-manage,moopo-h5,moopo-collect

# moopo-server
moopo-server.sonar.projectName=20190322-test1
moopo-server.sonar.sources=moopo-server/src
moopo-server.sonar.java.binaries=moopo-server/target/classes 

# moopo-collect
moopo-collect.sonar.projectName=20190322-test2
moopo-collect.sonar.sources=moopo-collect/src
moopo-collect.sonar.java.binaries=moopo-collect/target/classes 

# moopo-manage
moopo-manage.sonar.projectName=20190322-test3
moopo-manage.sonar.sources=moopo-manage/src
moopo-manage.sonar.java.binaries=moopo-manage/bin

# moopo-h5
moopo-h5.sonar.projectName=20190322-test4
moopo-h5.sonar.sources=moopo-h5/src
moopo-h5.sonar.java.binaries=moopo-h5/bin

执行结果:

Sonar 配置及部署(windows系统)

Sonar 配置及部署(windows系统)Sonar 配置及部署(windows系统)

异常解决:

1、sonarqube插件异常(需要更新或替换或增加),将提示的插件下载后,放到sonarqube—>extensions—>downloads中,重新运行sonarqube,该插件会自动加载到plugins文件中。

Sonar 配置及部署(windows系统)

Sonar 配置及部署(windows系统)

2、部分异常时,尝试将SCM的状态重置下,如下图:

Sonar 配置及部署(windows系统)

更多参考网址:

https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Jenkins

http://www.cnblogs.com/dengshihuang/p/8066914.html

https://kefeng.wang/2017/01/10/jenkins-sonar/

https://my.oschina.net/u/237688/blog/1588495

https://www.jianshu.com/p/3b1c7eb17cdc

其他(maven项目中改配置及举例):https://github.com/limiaogithub/test_case_sonar_jacoco