# 代码质量检测

# 概述

SonarQube 是一款自动代码审查工具，可以检测代码中的bug、漏洞、低质量代码、容易引发错误的代码。支持多种开发语言，如Java、go、C#、CSS、HTML、JSP等等。
SonarQube 通过插件机制可以集成不同的测试工具，代码分析工具，以及持续集成工具。
SonarQube 提供直观方便的web操作界面，支持任务的指派和跟踪，提供多维度的各种统计和分析，包括像代码注释占比、重复代码分析。
官网地址：https://www.sonarqube.org/ (opens new window)

# 使用步骤

使用SonarQube执行项目代码审查时，需要先进行项目创建，在项目内执行代码审查，生成代码分析结果。

注意事项

使用SonarQube执行项目代码审查时，可以使用账号、密码。如果想强化安全，不想在执行代码扫描时使用真实SonarQube用户的密码，可以使用用户令牌来代替用户登录。这样可以通过避免把分析用户的密码在网络传输，从而提升安全性。

# 新建项目

SonarQube控制台新建项目，有手工创建、配置创建两种方式。

# 手工创建

手工创建：在项目界面，执行新增项目 ---> 手工。

# 配置创建

配置创建：在配置界面，选择左侧项目---> 管理标签，执行右侧创建项目。

# 项目令牌设置

项目创建完成后，选择需要执行代码审查分析的项目，设置令牌信息

# 服务器审查代码

SonarQube上项目创建完成、业务应用程序项目创建完成，即可对业务应用程序执行代码审查分析，审查分析结果会在SonarQube项目上体现。
代码审查分析可以使用maven命令、maven插件两种形式，分析结果会上传到SonarQube服务器上。

# maven命令

在应用程序maven项目根目录中执行如下命令：

mvn sonar:sonar -Dsonar.projectKey=hos-sonar-project -Dsonar.host.url=http://127.0.0.1:9000 -Dsonar.login=dcc44f4ec86b8f11a61e4d2ea340aab3a10011e4

执行过程中，如果提示 Not authorized. Please check the properties sonar.login and sonar.password 错误，则使用用户名、密码，命令如下：

mvn sonar:sonar -Dsonar.projectKey=hos-sonar-project -Dsonar.host.url=http://127.0.0.1:9000 -Dsonar.login=admin -Dsonar.pasword=admin

sonar.projectKey：SonarQube上的项目标识
sonar.host.url：sonarqube服务器地址
sonar.login：用户名
sonar.password：用户密码

# maven插件（推荐）

在maven的setting.xml 文件里加上

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

sonar.host.url：SonarQube服务器地址
sonar.login：用户名
sonar.password：用户密码

在应用程序项目的pom.xml 文件里加上

<build>
	<plugins>
		<plugin>
			<groupId>org.sonarsource.scanner.maven</groupId>
			<artifactId>sonar-maven-plugin</artifactId>
			<version>3.7.0.1746</version>
		</plugin>
	</plugins>
</build>