SonarQube之安装和maven项目使用配置(一)

前言:

SonarQube是一个开源的代码质量管理平台,能很好的帮我们检测代码质量,也经常被结合使用在持续交付的流程中,所以今天我们就来了解一下。

一,SonarQube的安装

1,访问SonarQube的官网,点击下载好sonarqube.zip文件后,解压至本地,本文演示使用的是win10的64位系统,所以点击D:\sonarqube-7.5\sonarqube-7.5\bin\windows-x86-64\StartSonar.bat启动sonarqube。(此处根据自己所处的系统选择不同文件夹下的启动文件启动)

image.png

启动成功后如下图:
image.png

2,打开浏览器访问http://localhost:9000,如出现sonarqube页面则表示安装成功;

二,SonarQube的配置

1,打开数据库,新建一个sonar数据库
2,打开sonarqube安装目录下的D:\sonarqube-7.5\sonarqube-7.5\conf\sonar.properties文件,编辑文件
3,在MySQL >=5.6 && <8.0后面加入数据库配置;

#----- MySQL >=5.6 && <8.0
# Support of MySQL is dropped in Data Center Editions and deprecated in all other editions
# Only InnoDB storage engine is supported (not myISAM).
# Only the bundled driver is supported. It can not be changed.
#sonar.jdbc.url=jdbc:mysql://数据库ip:3306/db_sonar?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&serverTimezone=PRC&useSSL=false
#sonar.jdbc.username=数据库用户名
#sonar.jdbc.password=数据库密码
#sonar.sorceEncoding=UTF-8
#sonar.scm.disabled=true


配置好数据库信息后,重启SonarQube,再次访问http://localhost:9000,SonarQube到这里基础数据库配置就配置成功啦

三,SonarQube的扫描

从官网可以看到,SonarQube支持以下方式来进行项目的扫描;
1,直接使用SonarQube scanner即扫描仪来进行分析
2,使用SonarQube扫描仪分析Maven
3,使用SonarQube扫描仪分析Gradle
4,使用SonarQube扫描仪分析ant
5,使用SonarQube扫描仪分析Jenkins
6,使用SonarQube扫描仪分析MSBuild(比较少见)
7,使用SonarQube扫描仪分析VSTS-TFS(比较少见)
扫描方式具体选择,请根据实际扫描项目所使用的构建工具进行选择:常见的有maven,ant,gradle;如果本地未搭建开发环境,此时使用SonarQube scanner就很方便了;SonarQube同时也提供了对jenkins的插件支持;因为楼主要扫描的项目是使用maven来管理项目的,下面介绍maven项目的扫描过程:

(1)maven项目的扫描配置

1, 找到位置 $MAVEN_HOME/conf 或者是 ~/.m2 下的settings.xml
2,添加如下配置:


    
        org.sonarsource.scanner.maven
    
    
        
            sonar
            
                true
            
            
                
                
                  http://loaclhost:9000 
                
            
        
     

是指sonar 服务器地址
**注意:直接加进去会报语法错误,因为标签冲突了,将org.sonarsource.scanner.maven添加到文件原有的中,将上文配置中的的内容添加到文件原有的中,就不会报错了
3,运行编辑器的命令窗口,执行mvn org.sonarsource.scanner.maven:sonar-maven-plugin:3.2:sonar
遇到报错:SCM provider autodetection failed. Both svn and git claim to support this project. Please use sonar.scm.provider to define SCM of your project.
在命令中添加参数 -Dsonar.scm.provider=git就好啦~

mvn org.sonarsource.scanner.maven:sonar-maven-plugin:3.2:sonar -Dsonar.scm.provider=git

4,执行成功的话,访问http://localhost:9000 ,就能查看项目扫描结果啦~ 如下图:

image.png

根据扫描结果优化代码后,只要再执行命令就能更新扫描结果啦~ 如果需要使用别的技术栈扫描的话,请参考上面官方文档链接去尝试把~ fighting~

以上~对你有帮助的话,点个喜欢❤️吧~~

欢迎关注我的同名,博客,Github~~~

你可能感兴趣的:(SonarQube之安装和maven项目使用配置(一))