手把手使用SonarQube分析、改善项目代码质量

最新推荐文章于 2024-09-22 11:07:17 发布
最新推荐文章于 2024-09-22 11:07:17 发布
阅读量1.6k 收藏 2
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lilizhou2008/article/details/100179533
版权

点击上方"IT牧场"，选择"设为星标"技术干货每日送达！

TIPS

本文基于SonarQube 7.9.1，理论支持6.0及更高版本。

SonarQube是一个开源的代码质量管理系统，可用来快速定位代码中的Bug、漏洞以及不优雅的代码。它支持几乎所有的常见编程语言，例如Java、JavaScript、TypeScript、Kotlin、Ruby、Go, Scala等。并且还有插件机制，利用插件，可以让SonarQube更加强大，例如可以整合Findbugs、PMD、Checkstyle等。可以说，SonarQube是一款提升项目代码质量必备的根据。

本文手把手搭建、使用SonarQube。

下载

前往 https://www.sonarqube.org/downloads/ ，按照如图说明下载即可。建议下载 LTS 版本，以便获得长期的维护与支持。

640?wx_fmt=jpeg

系统需求

•X64的操作系统•JDK（对于7.9.x，那么需要JDK 11或更高版；对于6.x - 7.8.x，需要JDK 8或更高版本）•2G内存

其他需求详见：https://docs.sonarqube.org/7.9/requirements/requirements/[1]

TIPS

•《其他需求》建议大家参照一下，里面探讨如何修改Linux文件描述符限制等说明；•上面贴的是是7.9版的链接，如果你使用的是其他版本，只需将版本名称改掉即可，例如改为7.8即可查看7.8.x的需求。

安装与启动

1 解压压缩包

2 将目录切换到SonarQube的 /bin 目录，可看到类似如下的目录结构：

├── bin	
│   ├── jsw-license	
│   ├── linux-x86-64	
│   ├── macosx-universal-64	
│   └── windows-x86-64

3 根据你的操作系统，切换到响应目录。例如，您的机器是macOS ，则可切换到 macosx-universal-64 目录。

4 执行如下命令即可启动SonarQube。

./sonar.sh start

当然，该shell还有其他命令，可输入 ./sonar.sh --help 或者 ./sonar.sh 查阅。

5 稍等片刻，访问 http://localhost:9000/ 即可看到类似如下的界面，说明安装成功。

640?wx_fmt=png

6 停止SonarQube，只需执行 ./sonar.sh stop 即可。

7 如需重启，只需执行 ./sonar.sh restart 即可。

管理员登录

访问：http://localhost:9000

账号：admin

密码：admin

生产环境可用

默认情况下，SonarQube使用的是H2数据库，这是一款非常流行的嵌入式数据库。但生产环境中，SonarQube并不建议使用H2。SonarQube支持多种数据库，例如Qracle、PostgreSQL、SQL Server等。下面，我们以PostgreSQL为例，让SonarQube使用PostgreSQL存储数据。

TIPS

支持的数据库及数据库版本请前往这篇文档查看，避免SonarQube不支持你的数据库版本以及注意点。

https://docs.sonarqube.org/7.9/requirements/requirements/[2]

举个例子：SonarQube 7.9要求使用PostgreSQL 9.3-9.6或者PostgreSQL 10，并且必须配置使用UTF-8

搭建PostgreSQL

简单起见，我用Docker搭建PostgreSQL。

version: '3.1'	

	
services:	
  postgres:	
    image: postgres:10	
    restart: always	
    environment:	
      - POSTGRES_USER=itmuch	
      - POSTGRES_PASSWORD=itmuch	
      - POSTGRES_DB=sonar	
    ports:	
      - "5432:5432"

修改SonarQube配置

1 修改配置文件：$SONARQUBE_HOME/conf/sonar.properties 。

2 找到类似如下的内容：

#----- PostgreSQL 9.3 or greater	
# By default the schema named "public" is used. It can be overridden with the parameter "currentSchema".	
#sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube?currentSchema=my_schema

在这行下面，添加如下内容：

sonar.jdbc.url=jdbc:postgresql://localhost/sonar?currentSchema=public	
sonar.jdbc.username=itmuch	
sonar.jdbc.password=itmuch

这里，数据库地址、账号、密码根据你的需求修改。

3 执行 ./sonar.sh restart ，重启SonarQube。观察PostgreSQL，可以发现，此时SonarQube会自动在PostgreSQL数据库中建表并插入初始化数据。

4 类似的方式，你也可以为你的SonarQube配置其他数据库。

整合Maven

方法一：全局配置

1 在Maven的全局配置文件： $MAVEN_PATH/conf/settings.xml （也可能是.m2/settings.xml 看你是怎么配置Maven的）中添加如下内容：

<profile>	
  <id>sonar</id>	
  <activation>	
    <activeByDefault>true</activeByDefault>	
  </activation>	
  <properties>	
    <sonar.jdbc.url>jdbc:postgresql://localhost/sonar?currentSchema=public</sonar.jdbc.url>	
    <sonar.jdbc.driver>org.postgresql.Driver</sonar.jdbc.driver>	
    <sonar.jdbc.username>itmuch</sonar.jdbc.username>	
    <sonar.jdbc.password>itmuch</sonar.jdbc.password>	
    <sonar.host.url>http://127.0.0.1:9000</sonar.host.url>	
  </properties>	
</profile>

2 到Maven项目的根目录执行如下命令，即可使用SonarQube分析项目：

mvn sonar:sonar -Dsonar.java.binaries=target/sonar

等待片刻后，项目构建成功：

[INFO] Spring Cloud YES ................................... SUCCESS [ 12.431 s]	
[INFO] turbine-stream-server .............................. SKIPPED	
[INFO] zuul-server ........................................ SKIPPED	
[INFO] hystrix-dashboard .................................. SKIPPED	
[INFO] commons ............................................ SKIPPED	
[INFO] ms-content-sample-mybatis .......................... SKIPPED	
[INFO] ms-consumer-sample ................................. SKIPPED

3 此时，再次访问 http://localhost:9000 ，即可看到类似如下的界面：

640?wx_fmt=png

如右上角所示，此时可以看到SonarQube已经为我们分析了一个项目，该项目有1个Bug、2个脆弱点、31个代码味道问题。点击项目名称（图中的 Spring Cloud YES）即可看到详情，可以根据SonarQube给我们的提示进行修正、重构。

方法二：直接命令行控制

1 右上角头像 - My Account - Security页中，在 Generate New Token 中填入你的Token名称，并点击Generate 按钮。

2 点击按钮后，将会看到生成的Token，例如 62b615f477557f98bc60b396c2b4ca2793afbdea

3 使用如下命令，即可使用Sonar分析项目。

mvn sonar:sonar \	
    -Dsonar.host.url=http://localhost:9000 \	
    -Dsonar.login=62b615f477557f98bc60b396c2b4ca2793afbdea \	
    -Dsonar.java.binaries=target/sonar

插件安装

SonarQube有一个强大的插件机制。以安装汉化插件为例——

1 按照图示进行操作：

640?wx_fmt=png

2 点击 Install 按钮后，将会弹出重启SonarQube的提示，点击即可重启。重启后，可看到类似如下的界面

640?wx_fmt=png

3 类似的方式，也可为SonarQube安装其他插件。

干货分享

最近将个人学习笔记整理成册，使用PDF分享。关注我，回复如下代码，即可获得百度盘地址，无套路领取！

•001：《Java并发与高并发解决方案》学习笔记；•002：《深入JVM内核——原理、诊断与优化》学习笔记；•003：《Java面试宝典》•004：《Docker开源书》•005：《Kubernetes开源书》•006：《DDD速成（领域驱动设计速成）》•007：全部•008：加技术讨论群

近期热文

•使用 Spring Framework 时常犯的十大错误•分享：手把手生成漂亮的静态文档说明页•4次版本迭代，我们将项目性能提升了360倍！•分享 | 阿里巴巴如何管理代码分支？•干货 | 这次我们看看阿里的人是如何蹂躏CPU的•深度解析 Spring Bean 的加载

References

[1]: https://docs.sonarqube.org/7.9/requirements/requirements/[2]: https://docs.sonarqube.org/7.9/requirements/requirements/

想知道更多？长按/扫码关注我吧↓↓↓640?wx_fmt=jpeg>>>技术讨论群<<<喜欢就点个"在看"呗^_^

ITMuch.com
关注
sonar-golang:用于Golang语言的Sonarqube插件
05-18
Go语言社区SonarQube插件 这是SonarQube的社区插件，用于支持Artois大学于2017年4月开始的Go语言。 自2018年5月起，SonarSource和正式支持Go。 它将报表集成在SonarQube仪表板中。 用户必须使用checkstyle格式为代码生成GoMetaLinter报告。 因此，该报告使用 集成到SonarQube中。 版本1.0仅提供golint支持。 版本1.1提供了测试覆盖率支持。 即将发布的版本将带来对其他短毛绒的支持。 作者 蒂博尔·法尔克（Thibault Falque） 丹尼尔·勒·贝雷（Daniel Le Berre） 安装 下载最新版本的工件 停止声纳服务器 将jar文件放在$SONAR_PATH/extensions/plugins 启动声纳服务器 启用所有最新规则 如果您已经安装了插件，并且想要启用新版本插件提供的新规则
使用SonarQube改善代码质量
qq_36688928的博客
06-14 997
转自：http://baijiahao.baidu.com/s?id=1585863522304110977&amp;wfr=spider&amp;for=pc在当今不断变化的开发环境下，保持较高的代码质量和较好的代码可读性对于项目的成功开发是极为重要的，尤其当多个团队在同一套代码上进行开发时，代码经常会被改变。这样的开发环境要求开发人员遵守一定的代码风格，使项目中的每位成员都能较好地理解项目中的...
【高手切磋】SonarQube 详述
最新发布
2403_86762465的博客
09-22 1221
SonarQube 是一个开源的代码质量管理平台，它可以帮助开发者和团队持续检查和改进代码质量。SonarQube 支持多种编程语言，包括 Java、C#、JavaScript、Python 等，并提供了丰富的功能来检测代码中的潜在问题、编码规范、复杂度、重复代码等。代码质量分析：持续集成支持：多语言支持：自定义规则：可视化报告：权限管理：插件生态系统：社区版与企业版：假设你是一名 Java 开发者，正在开发一个企业级应用，并希望持续检查和改进代码质量。示例：安装 SonarQube：安装 SonarSca
使用sonarqube对本地代码扫描
xiao_ying_bo_ke的博客
05-30 1215
扫描成功后登录sonarqube，根据自己创建标识搜寻扫描好的项目，点击项目，产看质量分析。选择某个bug，查看相关信息，点击为何是问题，会描述问题原因以及解决方案。可以点击查看bug，以及一些安全热点。
sonar安装使用及项目分析
技术交流，共同进步
03-27 2539
一、Centos7环境安装SonarQube SonarQube简SonarQube简介 Sonar 是一个用于代码质量管理的开放平台。通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具。比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种...
搭建sonarqube分析golang代码
weixin_45788869的博客
07-18 780
docker启动postgres Copy docker run -d –name sonar-postgres -e POSTGRES_PASSWORD=postgres -e PGDATA=/var/lib/postgresql/data/pgdata -v /custom/mount:/var/lib/postgresql/data postgres 安装客户端psql，通过yum安装postgresql-server会附带安装psql。也可以安装pgAdmin。 Copy yum inst
手把手教你使用SHAP（数据+代码+注释）
05-09
1. 同名博客：手把手教你使用SHAP 2. 实例讲解，包括（数据+代码+注释） 3. 可自定义图的标签、字体大小等设置 4. 基于jupyter，python代码，可直接运行 5. 若有疑问，可在同名博客...
量化经济学：手把手教你如何使用EXCEL分析股票历史数据
weixin_43996337的博客
04-14 9115
1.数据来源获取 数据集的下载来源为Yahoo Finance。Yahoo Finance是雅虎公司金融媒体领域的一个相关网站。它提供财经新闻、数据和评论，包括股票报价、新闻稿、财务报告和原创内容。它还提供了一些用于个人财务管理的在线工具。除了发布来自其他网站的合作伙伴内容外，它还发布其员工记者团队的原创故事。在最大的新闻和媒体网站列表中，它被 SimilarWeb 排名第 21 位。其上能便捷的查阅各大公司的历史股价变化数据，兼具权威性与方便性，因此我们将其作为我们数据获取的来源。网站的具体使用如下图所
【代码分享】手把手教你：基于深度学习的滚动轴承故障诊断
09-18
2. **深度学习模型**：项目中可能使用了"n_model.py"来定义和构建深度学习模型。考虑到标签中的“卷积神经网络”（CNN），我们可能会用CNN来捕获滚动轴承振动信号中的时空模式。CNN因其在图像识别领域的成功应用，也...
《时序分析、时序约束和时序收敛》专栏的说明与导航
热门推荐
孤独的单刀
02-05 13万+
《时序分析、时序约束和时序收敛》专栏的说明与导航（建议阅读）。
使用sonarqube进行代码分析
zhaixing
10-24 1251
使用sonarqube进行代码分析 在安装好sonarqube后，使用sonarqube对代码进行分析。 前提准备 1.准备项目 在GitHub上拉取了一个java项目，进行测试。 [root@localhost test]# git clone git@github.com:SquareSquash/java.git [root@localhost test]# ls java [root@lo...
项目工程代码质量检测——SonarQube
柳明哲的博客
04-13 3683
SonarQube是什么 SonarQube 是一个用于代码质量管理的开源平台，用于管理源代码的质量。 通过插件形式，可以支持包括 java, C#, C/C++, PL/SQL, Cobol, JavaScrip, Groovy 等等二十几种编程语言的代码质量管理与检测。Sonar 不仅提供了对 IDE 的支持，可以在 Eclipse和 IntelliJ IDEA 这些工具里联机查看结果；同时 ...
使用 SonarQube 分析 Maven 项目
epyingxue的专栏
01-08 847
step 1 : 需要在 Maven的 setting.xml 增加 sonarQuer： &lt;profiles&gt; &lt;profile&gt; &lt;id&gt;sonar&lt;/id&gt; &lt;properties&gt; &lt;sonar.jdbc.url&gt;jdbc:mysql://localh...
代码质量难评估？一文带你用 SonarQube 分析代码质量！
2301_78526383的博客
06-11 695
无论是架构师还是研发经理，代码质量都是必须要关注的重点。Sonar（没错，是 Sonar，不是 SonarQube）是一个用于代码质量管理的开源平台，用于管理代码的质量。它通过插件形式可以支持二十几种语言的代码质量检测，通过多个维度的检查了快速定位代码中潜在的或者明显的错误。千里之行始于足下，今天就让我带大家用一个简单的例子，看看怎么使用 SonarQube 进行代码质量管理。
Sonarqube+maven 分析代码
Gblfy_Blog
06-06 1099
文章目录1. 配置2. 编译项目执行命令2.1.编译项目2.2.代码分析3. 分析结果4. 解决bug5. 项目名称 Sonar是一个用于代码质量管理的开源平台，用于管理Java源代码的质量。通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具，比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。同时 Sonar 还对大量的持续集
SonarQube使用教程及案例
qq_41929970的博客
08-19 5134
SonarQube代码质量分析工具使用
SonarQube扫描的Bug、漏洞以及异味的修复（持续更新）
小菜鸟的HelloWorld
10-26 3万+
1、Use try-with-resources or close this "XSSFWorkbook" in a "finally" clause. 问题分析： 连接、流、文件和其他类在使用后需要关闭。此外，必须在finally块中进行关闭调用，否则异常可能会阻止调用。最好是，当类实现自动关闭时，应该使用“try with resources”模式创建资源，并将自动关闭。 未能正确关闭资源将导致资源泄漏，这可能首先导致应用程序崩溃，然后可能导致应用程序崩溃。 解决： 在final...
SonarQube与PostgreSQL的安装与配置
小曾同学的博客
09-01 7143
见字如面，已入初秋。岁月逐渐放缓了脚步，不忍带走零散的夏意。天气渐凉，草木摇落，转眼间，2021年仅剩下三分之一。再见了，8月，你好啊，9月。 SonarQube为静态检查工具，PostgreSQL为关系型数据库。本篇主要给大家分享SonarQube和PostgreSQL的安装与配置。 前言 环境： MacBook Pro（11.5.1） PostgreSQL（13） SonarQube （8.9.2） JDK11 因为 SonarQube 8.0以上版本不支持 MySQL，所以改用PostgreS.
中秋特辑：手把手实现YOLOv5月饼检测器项目
手把手教你制作月饼检测器项目代码" 本项目实战教程中介绍了如何使用YOLOv5深度学习框架来创建一个月饼检测器。YOLOv5是一种常用于目标检测的算法，它能够实现实时的物体检测和定位。本教程面向初学者，通过一个...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值