SonarQube Scanner：如何在特定文件中禁用重复代码检测

嘿，我完全懂你的难处——同一目录里混着生成文件和手写的非生成文件，又没法重命名或者重构，还要让SonarQube只给非生成文件做重复代码检测，试过官方文档的《Narrowing the Focus》和忽略问题功能都没解决？别慌，试试这几个针对性的方案：

方案1：用专门的重复代码排除参数 sonar.cpd.exclusions #

这个是最直接的解决方案，很多人容易忽略SonarQube有个只针对重复代码检测（CPD）的独立排除配置——它不会把生成文件完全踢出Sonar的扫描范围，只是跳过重复代码的检测，其他规则（比如代码规范、漏洞排查）依然会对这些文件生效，完美匹配你的需求。

配置方式： #

• 如果用本地的sonar-project.properties文件：

  # 要是生成文件有隐藏的路径/文件名规律（比如某几个固定文件、或者子目录），直接写匹配规则
  sonar.cpd.exclusions=src/main/java/com/yourproject/GenFileA.java,src/main/java/com/yourproject/generated/**/*
  
  # 如果生成文件没规律但数量不多，就直接列具体文件名
  sonar.cpd.exclusions=src/main/java/com/yourproject/OrderGen.java,src/main/java/com/yourproject/UserGen.java
  

• 要是在SonarQube后台配置，就进项目的Project Settings > General Settings > Analysis Scope > Duplications，在"Exclusions"输入框里填对应的文件路径就行。

方案2：用路径绑定质量配置的灵活方案 #

如果生成文件和非生成文件完全没法通过文件名/路径模糊匹配，那可以搞个自定义质量配置的组合：

1. 先复制你当前用的质量配置，改名叫「非生成文件专用配置」，确保里面的重复代码检测规则（比如Java的java:DuplicatedBlocks）是启用的。
2. 再复制一份，改名叫「生成文件专用配置」，把里面的重复代码检测规则直接禁用。
3. 最后进项目的Project Settings > Quality Profiles > Path-based，给生成文件的路径绑定「生成文件专用配置」，非生成文件的路径绑定「非生成文件专用配置」。

举个例子：

• 路径填src/main/java/com/yourproject/**/auto-gen/**/*，选「生成文件专用配置」
• 路径填src/main/java/com/yourproject/**/*，选「非生成文件专用配置」

这样就能精准控制不同路径下的文件用不同的规则扫描了。

方案3：极端场景的临时脚本方案 #

如果以上两种都不行（比如生成文件完全没任何规律，只能人工识别），那可以搞个分析前的临时移动脚本：

# 先把生成文件移去临时目录
mkdir -p temp_generated
mv src/main/java/com/yourproject/OrderGen.java src/main/java/com/yourproject/UserGen.java temp_generated/

# 执行Sonar扫描
sonar-scanner

# 扫描完再移回来
mv temp_generated/*.java src/main/java/com/yourproject/
rmdir temp_generated

这个方法有点hack，但胜在灵活，适合完全没规律的极端情况。

内容的提问来源于stack exchange，提问作者Kylon Tyner