告别CV大法！用PMD-CPD揪出Java项目里的"复制粘贴"代码（附完整命令行实战）

在Java项目开发中，代码重复（俗称CV大法）是影响代码质量和维护性的常见问题。重复代码不仅增加了维护成本，还容易引入bug。本文将详细介绍如何使用PMD-CPD工具检测Java项目中的重复代码，并提供完整的命令行实战指南，帮助开发者和技术负责人快速定位并重构重复代码。

1. 为什么需要检测重复代码？

代码重复是软件开发中的常见问题，尤其是在多人协作的大型项目中。重复代码带来的问题包括：

• 维护困难：当需要修改重复代码时，必须在多个地方进行相同的修改，容易遗漏。
• bug扩散：如果重复代码中存在bug，修复时需要确保所有重复的地方都得到修复。
• 代码膨胀：重复代码会增加代码库的体积，影响编译和运行效率。

PMD-CPD是一款专门用于检测重复代码的工具，支持多种编程语言，包括Java。它通过分析代码的token序列来识别重复模式，能够有效发现项目中的重复代码块。

2. PMD-CPD工具安装与配置

2.1 下载与安装

PMD-CPD是PMD工具集的一部分，可以从官网下载最新版本：

bash复制wget https://github.com/pmd/pmd/releases/download/pmd_releases%2F6.39.0/pmd-bin-6.39.0.zip
unzip pmd-bin-6.39.0.zip
cd pmd-bin-6.39.0/bin

2.2 基本命令结构

PMD-CPD的基本命令结构如下：

bash复制./run.sh cpd \
    --minimum-tokens <最小token数> \
    --files <要扫描的目录或文件> \
    --format <报告格式> \
    --language <编程语言>

常用参数说明：

3. 实战：检测Java项目中的重复代码

3.1 基本扫描示例

假设我们要扫描一个Java项目的src目录，可以使用以下命令：

bash复制./run.sh cpd \
    --minimum-tokens 100 \
    --files /path/to/your/project/src \
    --format text \
    --language java

3.2 解析扫描结果

CPD的输出结果会显示发现的重复代码块，例如：

code复制Found a 26 line (141 tokens) duplication in the following files:
Starting at line 128 of /path/to/file1.java
Starting at line 172 of /path/to/file2.java

重复代码内容...
=====================================================================
Found a 35 line (128 tokens) duplication in the following files:
Starting at line 136 of /path/to/file3.java
Starting at line 103 of /path/to/file4.java

重复代码内容...

报告中的=======分隔符用于区分不同的重复代码块。每个重复块会显示：

• 重复代码的行数和token数
• 重复代码所在的文件和起始行号
• 重复的代码内容

3.3 高级用法

3.3.1 排除特定目录

可以使用--exclude参数排除不需要扫描的目录：

bash复制./run.sh cpd \
    --files /path/to/project/src \
    --exclude /path/to/project/src/test

3.3.2 生成XML报告

XML格式的报告更适合自动化处理：

bash复制./run.sh cpd \
    --files /path/to/project/src \
    --format xml \
    --language java \
    > cpd-report.xml

3.3.3 设置更严格的检测阈值

通过调整--minimum-tokens参数可以控制检测的严格程度：

bash复制# 更严格的检测（检测更小的重复块）
./run.sh cpd --minimum-tokens 50 --files /path/to/src

# 更宽松的检测（只检测较大的重复块）
./run.sh cpd --minimum-tokens 200 --files /path/to/src

4. 重构重复代码的实用策略

检测到重复代码后，下一步是进行重构。根据重复代码的不同情况，可以采用以下策略：

4.1 同一类中的重复代码

如果重复代码出现在同一个类中，可以考虑：

1. 提取私有方法：

   java复制// 重构前
   public void methodA() {
       // 重复代码块
       doSomething();
       // 重复代码块
   }
   
   public void methodB() {
       // 重复代码块
       doSomethingElse();
       // 重复代码块
   }
   
   // 重构后
   public void methodA() {
       commonCode();
       doSomething();
       commonCode();
   }
   
   public void methodB() {
       commonCode();
       doSomethingElse();
       commonCode();
   }
   
   private void commonCode() {
       // 提取的重复代码
   }
   

2. 提取局部变量：如果重复的是表达式或计算逻辑，可以提取为局部变量。

4.2 不同类中的重复代码

如果重复代码出现在不同的类中，可以考虑：

1. 创建工具类：

   java复制// 重构前
   class ClassA {
       public void method() {
           // 重复代码
       }
   }
   
   class ClassB {
       public void method() {
           // 重复代码
       }
   }
   
   // 重构后
   class Utility {
       public static void commonMethod() {
           // 提取的重复代码
       }
   }
   
   class ClassA {
       public void method() {
           Utility.commonMethod();
       }
   }
   
   class ClassB {
       public void method() {
           Utility.commonMethod();
       }
   }
   

2. 使用模板方法模式：如果重复代码是算法的一部分，可以考虑使用模板方法模式。

4.3 继承体系中的重复代码

如果重复代码出现在继承体系中，可以考虑：

1. 将公共代码提升到父类：

   java复制// 重构前
   class ChildA extends Parent {
       public void method() {
           // 重复代码
       }
   }
   
   class ChildB extends Parent {
       public void method() {
           // 重复代码
       }
   }
   
   // 重构后
   class Parent {
       protected void commonCode() {
           // 提取的重复代码
       }
   }
   
   class ChildA extends Parent {
       public void method() {
           commonCode();
       }
   }
   
   class ChildB extends Parent {
       public void method() {
           commonCode();
       }
   }
   

2. 使用策略模式：如果重复代码是可变的行为，可以考虑使用策略模式。

5. 将CPD集成到开发流程中

为了持续保持代码质量，建议将CPD集成到开发流程中：

5.1 集成到构建工具

5.1.1 Maven集成

在pom.xml中添加PMD插件配置：

xml复制<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-pmd-plugin</artifactId>
            <version>3.14.0</version>
            <configuration>
                <rulesets>
                    <ruleset>/rulesets/java/quickstart.xml</ruleset>
                </rulesets>
                <targetDirectory>target/pmd</targetDirectory>
                <cpdMinimumTokenCount>100</cpdMinimumTokenCount>
            </configuration>
        </plugin>
    </plugins>
</build>

运行CPD检查：

bash复制mvn pmd:cpd

5.1.2 Gradle集成

在build.gradle中添加配置：

groovy复制plugins {
    id 'pmd'
}

pmd {
    toolVersion = '6.39.0'
    ruleSets = []
    ruleSetFiles = files("config/pmd/ruleset.xml")
}

task cpd(type: Pmd) {
    ruleSetFiles = files()
    ruleSets = []
    consoleOutput = true
    source = sourceSets.main.allJava
    ignoreFailures = true
    pmdClasspath = configurations.pmd
    rulesMinimumPriority = 5
    doLast {
        def report = file("${buildDir}/reports/pmd/cpd.xml")
        if (report.exists()) {
            ant.xslt(in: report,
                    style: new File('config/pmd/pmd-nicerhtml.xsl'),
                    out: new File("${buildDir}/reports/pmd/cpd.html"))
        }
    }
}

运行CPD检查：

bash复制gradle cpd

5.2 集成到CI/CD流程

在Jenkins等CI工具中，可以添加CPD检查作为构建步骤的一部分：

bash复制#!/bin/bash

# 运行CPD检查
./pmd-bin-6.39.0/bin/run.sh cpd \
    --minimum-tokens 100 \
    --files src \
    --format xml \
    --language java \
    > cpd-report.xml

# 检查重复代码是否超过阈值
DUPLICATION_COUNT=$(grep -c "<duplication" cpd-report.xml)
if [ "$DUPLICATION_COUNT" -gt 10 ]; then
    echo "发现过多重复代码：$DUPLICATION_COUNT 处"
    exit 1
fi

5.3 设置合理的阈值

根据项目规模和质量要求，可以设置不同的重复代码阈值：

在实际项目中，可以根据团队的质量标准逐步调整这些阈值。