SonarQube 接入方式
SonarQube包含多种接入方式,这里提供常用的几种接入方式说明:
- Jenkins集成方式
- Maven集成方式
- 直接扫描方式
无论采用哪种集成方式,首先需要在sonar服务中生成授权token:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xn3oDQjd-1646623613508)(./images/generate_token.png)]
Jenkins集成方式
Jenkins集成具体实现方式包含两种:
- 通过Jenkins的Job触发Maven命令执行,这种方式实际上是通过Maven集成方式来进行扫描的;
- 通过Jenkins的Sonar插件执行,此方式实际是触发直接扫描方式来进行扫描的,Jenkins插件的安装方式详见安装
Maven集成方式
全局配置
在settings.xml文件中配置以下内容:
<settings>
<pluginGroups>
<pluginGroup>org.sonarsource.scanner.maven</pluginGroup>
</pluginGroups>
<profiles>
<profile>
<id>sonar</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<!-- sonar 服务地址 -->
<sonar.host.url>
http://10.2.0.171:9000/
</sonar.host.url>
</properties>
</profile>
</profiles>
</settings>
添加插件
在pom.xml中添加sonar插件:
<build>
<plugins>
<plugin>
<groupId>org.sonarsource.scanner.maven</groupId>
<artifactId>sonar-maven-plugin</artifactId>
<version>3.7.0.1746</version>
</plugin>
</plugins>
</build>
执行分析
mvn clean verify sonar:sonar -Dsonar.login=myAuthenticationToken #myAuthenticationToken 为sonar服务中生成的token
如果是多module项目,在执行扫描前需要先对项目进行install操作,即:
mvn clean install
mvn sonar:sonar -Dsonar.login=myAuthenticationToken
分析配置
如果需要修改sonar扫描参数的默认值,在pom.xml的properties中修改即可,支持的参数较多,具体信息查看官方说明。链接
<properties>
<sonar.buildString> [...] </sonar.buildString>
</properties>
直接扫描方式
安装SonarScanner
修改$install_directory/conf/sonar-scanner.properties配置:
#----- Default SonarQube server
#sonar.host.url=http://localhost:9000
配置
在项目根目录中创建sonar-project.properties配置文件,配置文件中包含以下内容:
# 项目名称
sonar.projectKey=MyProject
# --- 可选配置(建议不要缺少) ---
# 项目名称
#sonar.projectName=MyProject
# 项目版本号
#sonar.projectVersion=1.0
# 相对于当前配置文件的相对路径,用于配置需要扫描的源码路径
#sonar.sources=.
# 源码字符集
#sonar.sourceEncoding=UTF-8
扫描
执行以下命令进行扫描:
sonar-scanner -Dsonar.login=myAuthenticationToken