java sonar教程_SonarQube学习入门指南

最新推荐文章于 2024-05-05 08:42:37 发布
最新推荐文章于 2024-05-05 08:42:37 发布
阅读量401 收藏
点赞数
文章标签： java sonar教程
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_30838923/article/details/114247019
版权

1. 什么是SonarQube?

SonarQube®是一种自动代码审查工具，用于检测代码中的错误，漏洞和代码异味。它可以与您现有的工作流程集成，以便在项目分支和拉取请求之间进行连续的代码检查。

7d51948be54b278db3e60a022c458bde.png

2. 使用前提条件

当前版本 SonarQube 7.4

运行SonarQube的唯一先决条件是在您的计算机上安装Java(Oracle JRE 8或OpenJDK 8)。

注意： 在Mac OS X上，强烈建议安装Oracle JDK 8而不是相应的Oracle JRE，因为JRE安装未正确完全设置Java环境。

2.1 硬件要求

SonarQube服务器的小型(个人或小团队)实例需要至少2GB的RAM才能有效运行，并且1GB的可用RAM用于操作系统。如果要为大型团队或Enterprise安装实例，请考虑以下其他建议。

您需要的磁盘空间量取决于您使用SonarQube分析的代码量。例如，SonarClube的公共实例SonarCloud拥有超过3.5亿行代码，有5年的历史。SonarCloud目前在集群Amazon EC2 m5.large实例上运行，每个节点分配50 Gb的驱动器空间。它处理19,000多个项目，大约有1400万个未解决的问题。SonarCloud在PostgreSQL 9.5上运行，它为数据库使用了大约250Gb的磁盘空间。

SonarQube必须安装在具有出色读写性能的硬盘上。最重要的是，“data”文件夹包含Elasticsearch索引，当服务器启动并运行时，将在其上完成大量I / O.因此，良好的读写硬盘性能将对整个SonarQube服务器性能产生很大影响。

2.2 企业硬件建议

对于SonarQube的大型团队或企业级安装，需要额外的硬件。在企业级别，监控SonarQube实例/实例管理/ java-process-memory是必不可少的，并且应该随着实例的增长引导进一步的硬件升级。起始配置应至少包括：

8个核心，允许主SonarQube平台与多个计算引擎工作者一起运行

16GB RAM有关数据库和ElasticSearch的其他要求和建议，请参阅硬件建议/要求/硬件建议。

2.3 支持的平台

SonarQube Java分析器能够分析任何类型的Java源文件，无论它们遵循的Java版本如何。

但SonarQube分析和SonarQube服务器需要特定版本的JVM。

d901a8c244e0e1e2d4ddac55fe3bbc0a.png

4d852261aca20912cf4abf2bd043cf4e.png

605af145787f5c075cce7e226adbbe40.png

网页浏览器

要获得SonarQube提供的完整体验，您必须在浏览器中启用JavaScript。

4683196f71684e8698ae3012eb9fa6c1.png

3. SonarQube 如何下载安装配置？

收费价格标准如下：

810981d9526ce2b9db46433a328a1254.png

SonarQube 的社区版是免费的，其他版本是收费的

3.1.1 比如我们解压缩到这个目录 C:\Apps\sonar\sonarqube-7.4\bin\windows-x86-64\

3.1.2 以管理员身份按照上图顺序依次运行这三个文件

54991a91ba0ef4084d26f28a6c255907.png

b4e0a4087d8f20c449aa47d6750470eb.png

3.1.4 使用系统默认的管理员凭据(admin / admin)登陆成功。

4.  使用SonarQube扫描仪分析Maven

cf8b2ff1dfb16d2ffd362485961fd58a.png

Tips:

Sonar 版本7.4

Maven 版本不可小于 3.x

能访问之前那个登陆页面并登陆成功,说明SonarQube已经安装好了。

初始设置

全局设置

1. 打开位于$ MAVEN_HOME / conf或〜/ .m2中的settings.xml文件，

2. 找到节点，追加org.sonarsource.scanner.maven 这个插件

3. 找到以设置插件前缀和可选的SonarQube服务器URL。

Settings.xml 内容示例如下：

org.sonarsource.scanner.maven

sonar

true

http://myserver:9000

局部设置

如果只是对单个项目需要配置，也可以采取局部设置服务器地址，即在自己项目的POM.xml 中配置如下：

4.0.0

com.xingyun

SpringStaticFactoryPatternSample

0.0.1-SNAPSHOT

commons-logging

commons-logging

1.2

org.springframework

spring-context

5.1.2.RELEASE

org.springframework

spring-core

5.1.2.RELEASE

org.springframework

spring-beans

5.1.2.RELEASE

sonar

true

http://localhost:9000

org.apache.maven.plugins

maven-compiler-plugin

3.8.0

1.8

1.8

分析Maven项目

方法一：

使用Sonar 最新插件

配置好后就可以开始分析Maven项目了，在pom.xml文件所在的目录中运行Maven命令

mvn clean verify sonar:sonar

# In some situation you may want to run sonar:sonar goal as a dedicated step. Be sure to use install as first step for multi-module projects

mvn clean install

mvn sonar:sonar

这样当命令执行完毕后就可以在刚才的web 控制台看到刚才测试的项目了

2ae58a42a93898998a84a9b43176912e.png

方法二：

指定Sonar 插件版本

如果需要指定sonar-maven-plugin的版本而不是使用最新版本

那么需要在项目的POM.xml 中指定版本如下：

4.0.0

com.xingyun

TestSample

0.0.1-SNAPSHOT

sonar

true

http://localhost:9000

org.apache.maven.plugins

maven-compiler-plugin

3.8.0

1.8

1.8

org.sonarsource.scanner.maven

sonar-maven-plugin

3.5.0.1254

然后执行如下命令：

# Specify the version of sonar-maven-plugin instead of using the latest. See also 'How to Fix Version of Maven Plugin' below.

mvn org.sonarsource.scanner.maven:sonar-maven-plugin:3.5.0.1254:sonar

这样当命令执行完毕后就可以在刚才的web 控制台看到刚才测试的项目了

2ae58a42a93898998a84a9b43176912e.png

方法三：

要将JaCoCo作为Maven构建的一部分执行以生成JaCoCo 的二进制格式，即在target 目录下生成jacoco.exec 文件

3298f386343eac6f458bfb4eca25419b.png

请使用以下命令：

mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install sonar:sonar

如果需要忽略测试失败

mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install -Dmaven.test.failure.ignore=false sonar:sonar

然后执行如下命令：

# Specify the version of sonar-maven-plugin instead of using the latest. See also 'How to Fix Version of Maven Plugin' below.

mvn org.sonarsource.scanner.maven:sonar-maven-plugin:3.5.0.1254:sonar

这样当命令执行完毕后就可以在刚才的web 控制台看到刚才测试的项目了

2ae58a42a93898998a84a9b43176912e.png

开启身份认证

不知道你有没有发现，我们直接执行命令后便将分析报告提交到web控制台了，没有加任何权限验证，这样是非常不安全的。

默认管理员凭据

安装SonarQube时，会自动创建具有“管理系统”权限的默认用户：

登录：admin

密码：admin

我们可以在项目中通过配置账号和密码方式来实现身份认证，但是这样仍然不是很安全，登陆密码容易泄露。

开启Token 身份认证

1. 打开身份认证开关

Administration > Configuration > General Settings > Security, 然后设置 Force user authentication 属性为true

6d354048c123edb39e89916f3df3eb46.png

2. 创建一个用户

b9f7b39c0eaab2240a2b1613a4bcd18e.png

点击创建后输入账号和密码,输入Email , 然后点击create 即可

92b6f459bbc396008791cec39aed3a19.png

3. 点击下图位置

171c39216f2a9e2d66ff5b88660c876d.png

弹出如下对话框

d7ecbed094ecdc3845dbb00d1872d50f.png

执行成功后如下所示：

62dae91d00db0e52f51530ff665eeb41.png

点击sonar-users 下的图标，弹出如下图所示

1300bea5a0aac18b322812c8d743ae6c.png

勾选后点击done 完成

a0545e6c778b036c83538f0b6fdf41e0.png

将Execute Analysis 下对勾勾选，即可为该用户组添加分析执行权限

0ed6c17bd4c081fd6f3c3d1427051eb2.png

由于我们创建的用户属于这两个用户组，所以给这个组赋予权限，那么我们的用户便也有权限了。

恢复管理员访问权限

如果您更改了admin密码然后丢失了密码，则可以使用以下查询重置密码：

update users set crypted_password = '$2a$12$uCkkXmhW5ThVK8mpBvnXOOJRLd64LJeHTeCkSuB3lfaR2N0AYBaSi', salt=null, hash_method='BCRYPT' where login = 'admin'

如果您已删除admin并随后锁定具有全局管理权限的其他用户，则需要admin使用以下查询重新授予用户：

INSERT INTO user_roles(user_id, role) VALUES ((select id from users where login='mylogin'), 'admin');

参考模板示例一：

pom.xml

sonar

true

jdbc:mysql://******:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance

com.mysql.jdbc.Driver

sonar

sonar

http://172.*.*.*:9000

ce57e****************4a8969

UTF-8

.

src/test/java/**

sonar-coverage

true

org.jacoco

jacoco-maven-plugin

0.7.9

org.jacoco

jacoco-maven-plugin

true

agent-for-ut

prepare-agent

jacoco-site

verify

report

参考模板示例二:

pom.xml

4.0.0

com.xingyun

SpringStaticFactoryPatternSample

0.0.1-SNAPSHOT

commons-logging

commons-logging

1.2

org.springframework

spring-context

5.1.2.RELEASE

org.springframework

spring-core

5.1.2.RELEASE

org.springframework

spring-beans

5.1.2.RELEASE

sonar

true

http://localhost:9000

UTF-8

:

Custom Project

V0.0.1

target/site/jacoco/jacoco.xml

org.apache.maven.plugins

maven-compiler-plugin

3.8.0

1.8

1.8

形象顧問Christine
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
sonar java_JAVA开发必知工具-Sonar简介及使用
weixin_28729205的博客
02-12 2395
Sonar简介Sonar是一个用于代码质量管理的开源平台，用于管理源代码的质量，可以从七个维度检测代码质量通过插件形式，可以支持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测sonarQube能带来什么？Developers' Seven Deadly Sins1.糟糕的复杂度分布文件、类、方法等，如果复杂度过高将...
java代码集成sonar接口，实现sonar操作的demo
04-01
利用java代码，调用sonar接口，实现在sonar里面创建，更改，用户，组，权限等一系列操作
Java代码质量分析Sonar
赵广陆
06-18 4531
目录 1. sonar安装 1.1 简介 1.1.1 客户端 1.1.2 sonar 版本区分 1.1.2.1 社区版 1.1.2.2 开发者版 1.1.2.3 企业版 1.2 安装部署 1.2.1 修改文件句柄数 1.2.2 创建挂载目录 1.2.3 创建docker-compose.yml 1.2.4 启动 1.2.4.1 访问测试 1.2.5 安装插件 1.2.5.1 汉化插件 1.3 静态分析插件介绍 1.3.1 什么是静态代码分析 1.3.1.1 静态代码分析优势
2024年Java最全sonar入门：使用sonar-scanner检测代码(1)，字节跳动两轮面试让等hr
最新发布
2401_84689860的博客
05-05 632
这份清华大牛整理的进大厂必备的redis视频、面试题和技术文档祝大家早日进入大厂，拿到满意的薪资和职级~~~加油！！！本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录需要这份系统化的资料的朋友，可以点击这里获取本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录需要这份系统化的资料的朋友，可以点击这里获取。
java sonar教程_Sonar 插件
weixin_39974882的博客
02-24 645
Sonar 插件你可能会想使用新的 Sonar Runner 插件来代替现在这个插件。尤其是因为只有 Sonar Runner 插件支持 Sonar 3.4 及更高的版本。Sonar 插件提供了对 Sonar，一个基于 web 的代码质量监测平台的集成。该插件添加了sonarAnalyze task ，用来分析一个 project 及子 project 都应用了哪个插件。分析结果存储于 Sonar...
【Java】 sonar | java | sonar生成扫描token | 扫描示例 | 常见问题处理
hgSuper的博客
11-29 2525
1、sonar已经安装OK2、springboot项目3、maven项目。
jenkins_sonarqube进行代码质量检查.zip
11-24
里面包含了搭建教程，有jenkins+sonarqube全部资源，包括jenkins核心，sonarqube核心、sonarqube scanner、发送邮件的python脚本、table.html模板、发送到钉钉群的脚本、全部都有。
sonar-findbugs:SonarQube的SpotBugs插件
05-04
SonarQube Spotbugs插件说明/功能该插件需要，并使用 ， 和提供编码规则。用法在质量配置文件中，从Spotbugs，fb-contrib或Find Security Bugs规则存储库中激活一些规则，然后对项目进行分析。配置可以使用声纳Web...
sonar-JAVA检查规则指南.docx
03-20
SonarQube JAVA检查规则指南 SonarQube 是一个广泛使用的静态代码分析工具，用于检查 Java 项目中的 bug、漏洞和坏味道。 SonarQube 提供了许多内置规则，用于检查 Java 代码的质量和安全性。下面是 SonarQube 中的...
sonar-golang:用于Golang语言的Sonarqube插件
05-18
作者蒂博尔·法尔克（Thibault Falque） 丹尼尔·勒·贝雷（Daniel Le Berre）安装下载最新版本的工件停止声纳服务器将jar文件放在$SONAR_PATH/extensions/plugins 启动声纳服务器启用所有最新规则如果您已经安装了...
sonar_fisher.zip_fisher_fisher sonar_sonar_sonar_fisher_sonar数据f
07-15
这个压缩包"sonar_fisher.zip"包含了与模式识别相关的资源，特别是使用Fisher线性判别分析（Fisher's Linear Discriminant Analysis, FDA）对Sonar数据进行分类的研究。 **Fisher线性判别分析（FDA）**： Fisher...
jacoco和sonar集成
码农崛起
11-04 3803
sonar集成jacoco展示单元测试覆盖率 （一）sonar-scanner结合jacoco 这里还是要用到maven生成jacoco的统计结果，所以推荐直接使用maven的方式检查项目 1.在要检测的项目的pom文件中加入如下配置： [root@rhc jacoco]# cat pom.xml <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-in
Java单元测试实践-理论-＞实践-＞Sonar集成
IccBoY_超越
01-24 2070
本文说明了单元测试与集成测试的区别，并从单元测试命名规范，编写(Given-When-Then)，单元测试工具（mock工具及断言工具），以及maven插件实现单元测试和集成测试的分开执行方面,和与sonar集成进行了实践。
jacoco 和 maven 集成
ting2909的博客
05-07 5665
2.1 mvn 命令增加参数 在执行 mvn 命令时，加上 “org.jacoco:jacoco-maven-plugin:prepare-agent” 参数即可。示例： mvn clean test org.jacoco:jacoco-maven-plugin:0.8.5:prepare-agent install -Dmaven.test.failure.ignore=true 其中，jaco...
全网最详细jenkins+sonarqube+SonarQube Scanner+jacoco 部署流程说明
qq_42292373的博客
06-30 7838
文章目录一:Sonarqube的配置1.下载资源2: 修改配置文件3: 授权普通用户4:启动程序5: 汉化 (可选,不推荐)6:进行初始化的设置7:创建项目二:Jenkins的配置1: 下载插件2: 全局设置3: 全局工具配置4: 项目配置三:jacoco的配置1: 添加依赖2: jinkens配置jacoco四:使用的方法1:查看覆盖率 一:Sonarqube的配置 1.下载资源 1:下载 SonarQube 资源包,这里选择7.6版本 https://www.sonarqube.org/ 2:注意:8
Mac本地搭建Sonar系统（代码自动检查）
Sugarhiy的博客
02-10 1957
Sonar简介： Sonar是一个用于代码质量管理的开源平台，用于管理Java源代码的质量，能够支持包括C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测。html 一、系统环境依赖 1.1 java 环境 jdk 1.8下载传送门java jdk安装完后，须要进行环境变量的配置 mac打开环境配置文件的命令 cd ~ touch .bash_profile open -e .bash_profile #jdk export JAVA_8_H
Java项目集成SonarQube代码审查
m0_74530944的博客
04-15 841
又是一年求职季，在这里，我为各位准备了一套Java程序员精选高频面试笔试真题，来帮助大家攻下BAT的offer，题目范围从初级的Java基础到高级的分布式架构等等一系列的面试题和答案，用于给大家作为参考以下是部分内容截图《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
sonarqube10.2使用详细教程
m0_64683024的博客
09-23 1211
快速学会使用sonarqube
jacoco单测报告怎么同步到sonarqube
tushuping的博客
11-24 1820
这里我们看看配置的两个关键点，当生命周期test-compile，即单测编译时触发jacoco的初始化，当生命周期verify时就对jacoco报告进行生成。sonarqube支持多种代码覆盖率的报告展示，最常用的当属jacoco报告，那么jacoco的报告怎么同步到我们的sonarqube中呢？使用上就是这么简单，当然在集成上也会有一些坑，比如springboot运行junit5会出现无法触发的问题等。此命令会触发单测，verify命令会触发报告，然后通过。
SonarQube 安装如何设置SONAR_JAVA_PATH
05-26
如果你在安装SonarQube时遇到了需要设置`SONAR_JAVA_PATH`的问题，可以按照以下步骤进行设置： 1. 打开SonarQube的安装目录，找到`conf`文件夹，然后打开`wrapper.conf`文件。 2. 在`wrapper.conf`文件中找到以下行： ``` # Java Application wrapper.java.command=java ``` 3. 将`wrapper.java.command`行改为以下内容： ``` # Java Application wrapper.java.command=/path/to/java/bin/java ``` 其中`/path/to/java`应该替换为你Java安装的路径。例如，如果你的Java安装在`/usr/lib/jvm/java-8-openjdk-amd64`，则可以将上面的行更改为： ``` # Java Application wrapper.java.command=/usr/lib/jvm/java-8-openjdk-amd64/bin/java ``` 4. 保存并关闭`wrapper.conf`文件。 5. 重新启动SonarQube。 这样就设置了`SONAR_JAVA_PATH`。如果你还有其他问题，可以在评论中提出。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值