maven工程使用sonar扫描代码

本文介绍如何通过配置Maven的setting.xml或pom.xml文件来集成SonarQube进行代码质量检查。包括创建项目、配置相关信息、执行扫描任务及查看结果等步骤。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

目录

基础环境

SonarQube 8.2
maven3.3.6
jdk:1.8

配置项目

创建项目
登录后右上角+号创建新项目
在这里插入图片描述填写项目名称及标识

在这里插入图片描述创建token
在这里插入图片描述下一步

在这里插入图片描述选择项目类型
在这里插入图片描述以上就已提供maven插件执行命令(注意’'是换行的意思,部分shell执行前需要删掉并去掉换行)

配置setting.xml(与配置项目pom.xml二选一)

注意:此项非必须
sonar插件在不配置的情况也是可以用的,如果每次不想带url、token等参数,而想简单的执行[mvn sonar:sonar]则需要在setting.xml将sonar信息配置进去

<settings>
	<!-- pluginGroups也可以不配置 -->
    <pluginGroups>
        <pluginGroup>org.sonarsource.scanner.maven</pluginGroup>
    </pluginGroups>
    <profiles>
        <profile>
            <id>sonar</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <properties>
            	<!-- 平台登录的账号的用户名
                   <sonar.login>admin</sonar.login> -->
                   <!-- SonarQube平台登录的账号的密码
                  <sonar.password>admin</sonar.password>-->
                <!-- 全局配置的情况建议使用用户名密码的形式 -->
                <sonar.projectKey>
                  e71f9c0248f4e299abea623f1fa81ff99eb62477
                </sonar.projectKey>
                <!-- Optional URL to server. Default value is http://localhost:9000 -->
                <sonar.host.url>
                  http://myserver:9000
                </sonar.host.url>
            </properties>
        </profile>
     </profiles>
     <!-- 官方未配置activeProfiles 但是个人建议配置上 -->
     <activeProfiles>
     	<!-- 这步配置,sonar的profile配置才能生效 -->
		<activeProfile>sonar</activeProfile>
     </activeProfiles>
</settings>

配置完成后执行如下命令即可扫描

mvn sonar:sonar

配置pom.xml(与配置setting.xml二选一)

如果不想修改setting.xml,可考虑在pom文件里直接引入sonar插件即可
在project->build->plugins 下增加如下插件

	<!-- sonar插件 -->
	<plugin>
		<groupId>org.sonarsource.scanner.maven</groupId>
		<artifactId>sonar-maven-plugin</artifactId>
		<version>3.7.0.1746</version>
	</plugin>

重新编译即可使用sonar,需要注意的是sonar插件未传递token(或者username/password)、host、prokectKey时,需要在执行mvn sonar:sonar时带上(参考:执行扫描任务

执行扫描任务

最新的maven执行以下命令无需配置setting.xml

mvn sonar:sonar -Dsonar.projectKey=n-demo -Dsonar.host.url=http://192.168.1.17:9000 -Dsonar.login=e71f9c0248f4e299abea623f1fa81ff99eb62477

查看结果

登录sonar服务,即可看到项目分析结果
在这里插入图片描述

### 多模块 Maven 工程中集成 Jacoco 和 Sonar 的配置方案 为了在多模块 Maven 工程中实现代码覆盖率分析和静态代码检查,可以通过以下方式完成 Jacoco 和 Sonar 的集成。 #### 1. 配置 `pom.xml` 文件支持 Jacoco 插件 在父项目的 `pom.xml` 中引入 Jacoco 插件并设置其目标路径: ```xml <build> <plugins> <!-- JaCoCo Plugin --> <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <version>0.8.9</version> <executions> <execution> <goals> <goal>prepare-agent</goal> </goals> </execution> <execution> <id>report</id> <phase>test</phase> <goals> <goal>report</goal> </goals> </execution> </executions> </plugin> </plugins> </build> ``` 通过此插件,在运行测试时会自动生成 `.exec` 文件用于记录覆盖率数据[^4]。 --- #### 2. 配置子模块中的测试环境 确保每个子模块都具备独立的测试框架(如 JUnit 或 TestNG)。如果某些子模块不需要单独计算覆盖率,则可以在对应的 `pom.xml` 中禁用 Jacoco 报告生成逻辑。例如: ```xml <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <configuration> <skip>true</skip> </configuration> </plugin> ``` 这样可以减少不必要的资源消耗,并集中关注核心业务模块的覆盖率统计[^5]。 --- #### 3. 安装阶段触发覆盖率收集 在构建过程中,使用如下命令来准备代理并安装依赖项: ```bash mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install -Dmaven.test.failure.ignore=true ``` 该命令会在每次测试执行期间自动注入 JaCoCo Agent 并保存覆盖率数据到指定目录下的 `.exec` 文件中。 --- #### 4. 将覆盖率数据上传至 SonarQube SonarQube 支持解析由 JaCoCo 提供的覆盖率报告文件。因此需要进一步调整参数以便于它能够识别这些信息。以下是完整的扫描命令示例: ```bash mvn sonar:sonar \ -Dsonar.coverage.jacoco.xmlReportPaths=target/site/jacoco/jacoco.xml \ -Dsonar.jacoco.reportPaths=target/jacoco.exec \ -Dsonar.login=your_token_here ``` 其中 `-Dsonar.jacoco.reportPaths` 参数指定了之前生成的 `.exec` 文件位置;而 `-Dsonar.coverage.jacoco.xmlReportPaths` 则指向 HTML/XML 形式的汇总报表。 注意:需提前确认服务器端已启用对应的语言插件以及权限认证机制正常运作[^5]。 --- #### 5. 可选优化措施——动态重用已有报告 为了避免重复劳动,还可以利用现有成果简化流程。具体做法是在第二次调用时加上选项 `-Dsonar.dynamicAnalysis=reuseReports` ,从而跳过重新生成环节直接读取旧版结果即可。 --- ### 总结 以上步骤涵盖了从基础工具链搭建直至最终呈现效果的整体过程。按照上述指导操作后应该能够在任何标准兼容环境下顺利达成预期目的即全面掌握项目健康状况的同时促进团队协作效率提升[^1][^4]. ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值