Android项目SonarQube分析如何纳入依赖库生成全量代码报告
SonarQube纳入Android项目依赖库代码分析的配置方案
问题根因
当前配置下SonarQube仅扫描开发者自定义代码的核心原因有两个:
- 原有
sonar.sources参数仅单独指向src/main/java目录,没有覆盖本地依赖模块、远程依赖源码的存放路径 - 排除规则设置过于宽泛,加上没有配置Java依赖关联参数,导致SonarQube自动过滤了外部依赖的源码内容
具体配置修改
直接替换原有sonarqube代码块中的对应参数即可:
1. 扩展源码扫描范围
将原有的单一路径源码配置,调整为包含项目自身代码、所有本地依赖模块源码的多路径集合,同时关联Gradle缓存中的远程依赖源码:
sonarqube { properties { property "sonar.projectName", "yassine" property "sonar.projectKey", "yassine" property "sonar.tests", ["src/test/java"] property "sonar.java.coveragePlugin", "jacoco" property "sonar.test.inclusions", "**/*Test*/**" property "sonar.sourceEncoding", "UTF-8" // 替换原有单一的sonar.sources配置 property "sonar.sources", [ "src/main/java", // 按实际项目补充所有本地依赖模块的源码路径,例如: "../lib_common/src/main/java", "../lib_network/src/main/java" ] // 新增编译产物、依赖关联配置,让SonarQube自动匹配远程依赖的源码 property "sonar.java.binaries", "build/intermediates/javac/debug/classes" property "sonar.java.libraries", [ "build/intermediates/compile_and_runtime_not_namespaced_r_class_jar/debug/R.jar", fileTree("$buildDir/intermediates/") { include "**/*.jar" }, fileTree("$System.getProperty("user.home")/.gradle/caches/modules-2/files-2.1/") { include "**/*-sources.jar" } ] // 调整原有排除规则,避免误过滤依赖源码 property "sonar.exclusions", [ "**/*Test*/**", "*.json", "**/*test*/**", "**/.gradle/**", "**/build/**/R.jar", "**/sources/**/com/google/**/R.java", "**/sources/**/androidx/**/R.java" ] } }
2. 分析前的前置操作
执行SonarQube分析命令前,先在项目根目录执行源码拉取指令,确保Gradle自动下载所有远程依赖的源码包到本地缓存:
gradle dependencies --configuration debugRuntimeClasspath --resolve-sources
实操优化提示
- 若不需要扫描所有公开开源第三方库(如AndroidX、Google Firebase相关依赖),可以新增
sonar.inclusions参数精准指定需要扫描的代码范围,避免全量拉取公开开源库源码导致分析耗时过长 - 现有配置中jacoco插件版本为0.1.4,版本过低会和新版SonarQube的覆盖率解析逻辑不兼容,建议升级到当前稳定版本,避免覆盖率数据统计异常
- 不要将编译后的class、jar产物作为
sonar.sources的扫描路径,这类内容仅需通过sonar.java.libraries参数关联即可,重复指定会导致扫描结果重复统计
内容的提问来源于stack exchange,提问作者Yassine
相关产品推荐
相关产品推荐

