Jenkins基础教程（132）Jenkins代码质量之PMD/CPD：Jenkins代码质检：PMD/CPD“捉妖记”-优快云博客

一、为什么你的代码需要“体检”？

记得我刚接触编程时，导师review我的代码后叹了口气：“这代码像是从战场上抬下来的，伤痕累累。”那时我还不服气，心想**“能跑起来不就是好代码吗？”** 结果第二天测试就发现了十几个bug，其中一个是简单的空指针异常，却导致整个服务宕机两小时。

代码质量，就像人的健康状况，平时不注意，等到发作时就晚了。在软件开发中，bug发现的越晚，修复成本越高。据业界研究，在生产环境中修复一个bug的成本，是在编码阶段发现的100倍！

而Jenkins作为最流行的自动化服务器，就像是代码的“全职体检医生”。它能够在每次代码提交后自动进行检查，及时发现潜在问题。今天我们要讨论的PMD和CPD，就是这位医生手中最犀利的“检测仪器”。

二、PMD和CPD：代码中的“侦探二人组”

1. 什么是PMD？

PMD是一款可扩展的静态代码分析器，它可以在不运行程序的前提下对源代码进行分析检查。把它想象成一位经验丰富的代码审查员，能够一眼看出你代码中的各种问题：代码风格不一致、可能出现的空指针、过长的代码块等等。

PMD通过定义一系列规则来工作，比如：

代码风格规则：大括号是否换行、命名规范等
潜在缺陷规则：可能的空指针异常、资源未关闭等
设计相关规则：过度复杂的类、方法过长等
最佳实践规则：使用更高效的API、避免使用过时方法等

2. 什么是CPD？

CPD是PMD的姐妹工具，专注于检查重复代码（Copy/Paste Detector）。它就像是学术查重系统，但针对的是你的代码库。

CPD的价值在于发现那些通过复制粘贴得到的代码。这些代码不仅使代码库臃肿，更重要的是，当需要修改时，你不得不修改多个地方，极易遗漏，是维护的噩梦。

3. 为什么选择PMD/CPD？

市面上静态代码分析工具不少，如Checkstyle、FindBugs等，为什么选择PMD/CPD呢？

多语言支持：不仅支持Java，还支持JavaScript、Apex等多种语言
深度分析：不仅能检查表面问题，还能发现潜在的设计缺陷
可扩展性：可以根据团队需要自定义规则
与生态集成： easily与Jenkins、Maven等工具集成

特别是对于Java项目，PMD可以与阿里巴巴的p3c规则集结合，让团队更容易就代码规范达成共识。

三、Jenkins与PMD/CPD的完美结合

1. 环境准备

在开始之前，我们需要在Jenkins中安装必要的插件：

进入Jenkins管理页面，点击“Manage Jenkins” > “Manage Plugins”
在“Available”标签页中搜索“PMD Plugin”并安装
安装完成后重启Jenkins

除了Jenkins插件，我们还需要在项目中配置PMD。对于Maven项目，在pom.xml中加入PMD插件：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.15.0</version>
      <configuration>
        <rulesets>
          <ruleset>/rulesets/java/ali-p3c.xml</ruleset>
        </rulesets>
        <failOnViolation>true</failOnViolation>
      </configuration>
    </plugin>
  </plugins>
</build>

这个配置使用了阿里巴巴的p3c规则集，并且设置当发现违规时构建失败，确保代码质量问题不会被忽略。