学习SonarQube记录

第一章 如何在windows上安装SonarQube及安装中文语言包

---

---

前言

公司近期有代码完整性检测的需求，于是来学习相关工具SonarQube

---

一、SonarQube是什么？

SonarQube 是一个用于管理源代码质量的开源平台。它提供了一系列工具和功能，可用于静态代码分析、代码检查、代码质量管理和代码审查。

SonarQube 旨在帮助开发团队识别和解决代码中的缺陷、漏洞和技术债务，从而提高整体代码质量。它可以检测代码中的常见问题，例如漏洞、安全漏洞、代码重复、复杂度等，并提供有用的反馈和建议来改进代码。

主要特点包括：

1. 静态代码分析： SonarQube 通过静态分析扫描代码，并根据一组预定义的规则和标准来检查代码。
2. 代码质量度量： 提供有关代码质量、可维护性、可读性和安全性的度量和报告。
3. 集成多种编程语言： SonarQube 支持多种编程语言，如 Java、JavaScript、C#、Python、C/C++等。
4. 持续集成和持续交付（CI/CD）： 可与 CI/CD 工具集成，如 Jenkins、GitLab CI/CD，以便在代码提交、构建或部署过程中自动运行代码检查。
5. 仪表板和报告： 提供直观的仪表板和报告，以便团队了解项目的整体代码质量状况。

SonarQube 可以作为一个独立的服务部署，也可以通过集成到开发环境中，为开发团队提供代码质量管理和改进方面的支持。

二、安装步骤

1.准备工作

1、 准备jdk1.8(这里不再讲怎么安装jdk)
2、 准备maven-3.6.0(这里也不讲怎么安装maven)
3、 SonarQube下载地址:https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-7.6.zip
4、 准备MySQL数据库5.7版本(这里也不讲怎么安装MySQL)

2.安装SonarQube

1、 下载完SonarQube后，解压到自己准备好的目录中，然后去conf目录下设置sonar.properties文件，相关参数如下：

# 数据库账号密码
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
# MySQL链接
sonar.jdbc.url=jdbc:mysql://数据库IP地址:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
# sonar端口号
sonar.web.port=9000
# sonar登录账号密码
sonar.login=admin
sonar.password=admin

2、 设置完后，在数据库中创建对应的账号信息，本文章中的mysql部署在linux系统中

# 登录MySQL
mysql -uroot -p
# MySQL创建用户并设置访问权限
mysql> CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci; 
mysql> CREATE USER 'sonar' IDENTIFIED BY 'sonar';
mysql> GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
mysql> GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';
mysql> FLUSH PRIVILEGES;

3、 上述工作完成后，启动SonarQube，windows64位系统下找到安装目录的bin/windows-x86-64目录下，双击StartSonar.bat启动，首次启动比较耗时，如果弹窗闪退则是启动失败，需要查明原因并解决

4、 启动成功后，访问localhost:9000地址，出现如下页面就算启动成功：

注意，我这张图是中文的因为我安装了中文包，未安装应该是纯英文页面，后续我会介绍如何安装中文包。
5、 登录SonarQube，用我们刚才在sonar.properties文件里设置的登录账号密码来登录，登陆后如图：

6、 紧接着我们去安装中文包，按图片记录的步骤点击：

点击首页后来到汉化插件对应的github页面，在Release中找到与7.6版本对应的jar包，下载下来后放到安装目录的extensions\downloads目录下。

7、 都完成后，重启SonarQube，重启该软件需要打开任务管理器，将所有java相关的进程都结束掉，再重新点击StartSonar.bat启动即可，重启成功后，再次访问页面就是中文的了。

总结

至此，SonarQube在windows上的安装及汉化都已介绍完，后续还会记录学习SonarQube的过程。