代码质量管理工具SonarQube详解

SonarQube的目的是对项目的代码进行分析，发现代码质量问题，并提示开发人员改进。

SonarQube由以下几个部分组成：

1. SonarQube Platform，就是SonarQube服务器，这是SonarQube运行的基础。

首先下载并解压缩SonarQube的发布软件；
必要的情况下配置解压缩目录下的sonarqube/conf/sonar.properties文件；

启动SonarQube Platform：

• Windows下执行StartSonar.bat
• Linux下执行sonarqube/bin/sonar.sh start console

启动成功，可以访问默认主页http://localhost:9000/，登录的用户名/密码为admin/admin。

注意，在实验阶段，SonarQube Platform默认使用H2数据库；但是在生成中，还需要使用MySQL等其他企业级数据库服务器。

2. SonarQube Scanner，即分析项目代码的默认启动器

首先下载并解压缩SonarQube Scanner；
必要情况下，配置文件sonar-scanner/conf/sonar-scanner.properties；建议配置如下：

• 每次提交前的分析，设置参数sonar.analysis.mode=preview
• 每天都要执行的CI分析，设置参数sonar.analysis.mode=publish

启动SonarQube Scanner：

• Windows下执行sonar-scanner.bat
• Linux下执行sonar-scanner/bin/sonar-scanner

3.分析项目
首先根据项目代码在线安装必要的插件，以支持项目使用的编程语言；
然后，cd到要分析的项目目录下，如some/projects/java/myproject/
在项目目录下创建并配置sonar-project.properties

[html] view plain copy

print ?

1. sonar.projectKey=org.sonarqube:it-sonar-examples  
2. sonar.projectName=IT Sonar Examples Quality  
3. sonar.projectVersion=1.0  
4. sonar.sources=.  
5. sonar.sourceEncoding=UTF-8  
6. sonar.language=text  

sonar.projectKey=org.sonarqube:it-sonar-examples
sonar.projectName=IT Sonar Examples Quality
sonar.projectVersion=1.0
sonar.sources=.
sonar.sourceEncoding=UTF-8
sonar.language=text

执行SonarQube Scanner启动分析，就可以完成对项目代码的分析。下面以Maven项目为例，详细介绍用法：

对于Maven项目，除了使用SonarQube Scanner进行分析之外，还可以使用maven-sonar-plugin插件进行分析。使用maven-sonar-plugin插件的步骤如下：

1) 配置Maven的settings.xml

[html] view plain copy

print ?

1. <settings>  
2.     <pluginGroups>  
3.         <pluginGroup>org.sonarsource.scanner.maven</pluginGroup>  
4.     </pluginGroups>  
5.     <profiles>  
6.         <profile>  
7.             <id>sonar</id>  
8.             <activation>  
9.                 <activeByDefault>true</activeByDefault>  
10.             </activation>  
11.             <properties>  
12.                 <!– Optional URL to server. Default value is http://localhost:9000 –>  
13.                 <sonar.host.url>  
14.                   http://myserver:9000  
15.                 </sonar.host.url>  
16.             </properties>  
17.         </profile>  
18.      </profiles>  
19. </settings>  

<settings>
    <pluginGroups>
        <pluginGroup>org.sonarsource.scanner.maven</pluginGroup>
    </pluginGroups>
    <profiles>
        <profile>
            <id>sonar</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <properties>
                <!-- Optional URL to server. Default value is http://localhost:9000 -->
                <sonar.host.url>
                  http://myserver:9000
                </sonar.host.url>
            </properties>
        </profile>
     </profiles>
</settings>

2) 配置Maven项目的pom.xml文件

[html] view plain copy

print ?

1.   <properties>  
2.     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
3.     <sonar.language>java</sonar.language>  
4.   </properties>  
5.   <build>  
6.   <pluginManagement>  
7.     <plugins>  
8.       <plugin>  
9.         <groupId>org.sonarsource.scanner.maven</groupId>  
10.         <artifactId>sonar-maven-plugin</artifactId>  
11.         <version>3.1.1</version>  
12.       </plugin>  
13.     </plugins>  
14.   </pluginManagement>  
15. </build>  

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <sonar.language>java</sonar.language>
  </properties>
  <build>
  <pluginManagement>
    <plugins>
      <plugin>
        <groupId>org.sonarsource.scanner.maven</groupId>
        <artifactId>sonar-maven-plugin</artifactId>
        <version>3.1.1</version>
      </plugin>
    </plugins>
  </pluginManagement>
</build>

3) 使用maven-sonar-plugin插件以进行SonarQube分析

mvn clean verify sonar:sonar

或mvn clean install org.sonarsource.scanner.maven:sonar-maven-plugin:3.1.1:sonar

4) 查看分析结果

打开SonarQube服务器的主页http://localhost:9000/