使用Sonar管控代码质量

Posted 2021-05-02 微尚联HaveOne

1.Sonar介绍

Sonar是一个用于代码质量管理的开源平台，用于管理Java源代码的质量。通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具，比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。

同时 Sonar 还对大量的持续集成工具提供了接口支持，可以很方便地在持续集成中使用 Sonar。

此外，Sonar 的插件还可以对 Java 以外的其他编程语言提供支持，对国际化以及报告文档化也有良好的支持。

2.安装配置

2.1下载sonar

https://www.sonarqube.org/downloads/

2.2配置数据库（mysql）

1）创建数据库

在mysql中执行如下脚本创建数据库及mysql用户

CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;

CREATE USER 'sonar' IDENTIFIED BY 'sonar';

GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';

GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';

FLUSH PRIVILEGES;

2）编辑${SONAR_HOME}/conf/sonar.properties配置数据库:

sonar.jdbc.username:                       sonar

sonar.jdbc.password:                       sonar

sonar.jdbc.url:                            jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true

# Optional properties

sonar.jdbc.driverClassName:                com.mysql.jdbc.Driver

2.3汉化

汉化包插件下载：

https://github.com/SonarQubeCommunity/sonar-l10n-zh

注意下载对应版本的汉化包

2.4配置插件

Sonar支持多种插件，

https://docs.sonarqube.org/display/PLUG/Plugin+Library

将下载后的插件上传到

${SONAR_HOME}extensions\plugins目录下，重新启动sonar。

3.启动sonar(window7环境)

${SONAR_HOME}/bin/windows-x86-64/StartSonar.bat

根据教程方法，进行分析项目如下：

mvn sonar:sonar \

-Dsonar.host.url=http://localhost:9000 \

-Dsonar.login=cab124768a4bfb6880f565787d3f67488f2a235d

4.与jenkins集成

4.1通过maven进行集成

同样，为了避免内存溢出，推荐增加内存堆栈的大小。设置MAVEN_OPTS环境变量：

set MAVEN_OPTS=”-Xmx512m -XX:MaxPermSize=256m”

使用sonar

a. 运行Sonar服务器;

b. 通过 mvn sonar:sonar 将代码注入到Sonar中进行分析处理,并将处理结果以XML的形式保存在数据库中;

mvn clean install sonar:sonar

c. 通过浏览器访问,显示分析结果;

d. 持续运行Maven构建,会迭代显示分析结果;

e. 可以显式指定sonar插件的版本,如下:

<project>

<build>

<plugins>

<plugin>

<groupId>org.codehaus.sonar</groupId>

<artifactId>sonar-maven-plugin</artifactId>

<version>3.5.1</version>

</plugin>

</plugins>

</build>

</project>

f. 可以显式的将sonar绑定到Maven生命周期中,如下: 

<plugin>

<groupId>org.codehaus.sonar</groupId>

<artifactId>sonar-maven-plugin</artifactId>

<version>3.5.1</version>

<executions>

<execution>

<id>sonar</id>

<phase>site</phase>

<goals>

<goal>sonar</goal>

</goals>

</execution>

</executions>

　　</plugin>

此时,指定Maven的site声明周期时,则会自动调用sonar.sonar 命令.

扫码关注，接受更多的IT技能，高薪距离你更近了哟