1.前言
工作中难免会遇到维护别人代码的情况，那么首先就得看懂别人写的代码。如果对方写的代码混乱臃肿，维护成本必然很高，如果对方写的代码优雅清晰，那维护的人看起来必然心情愉悦。正所谓“前人栽树,后人乘凉;前人埋坑，后人骂娘”。
代码首先是给人看的，其次才是给机器看到，如何编写出任何人都看到懂的代码？答案是制定规范！
每个公司都会有自己的编码规范，但是往往的情况是赶项目进度或者懒惰或者个人水平习惯等原因，加上没有code review，最后代码就写的千奇百怪了。原因就在于规范是有了，但是没人遵守。所以，编码规范需要强制执行，交给工具来强制执行。
本文将通过介绍java静态代码检查工具PMD、阿里巴巴p3c开源项目到最后编写自定义编码规约来学习如何规范代码的编写。
2.PMD静态代码扫描
2.1.PMD官网
2.2.概述
PMD是一种开源分析Java代码错误的工具。它通过静态分析获知代码错误。也就是说，在不运行Java程序的情况下报告错误。PMD附带了许多可以直接使用的规则，利用这些规则可以找出Java源程序的许多问题，例如：
- 潜在的bug：空的try/catch/finally/switch语句
- 未使用的代码：未使用的局部变量、参数、私有方法等
- 可选的代码：String/StringBuffer的滥用
- 复杂的表达式：不必须的if语句、可以使用while循环完成的for循环
- 重复的代码：拷贝/粘贴代码意味着拷贝/粘贴bugs
- 循环体创建新对象：尽量不要再for或while循环体内实例化一个新对象
- 资源关闭：Connect，Result，Statement等使用之后确保关闭掉
此外，用户还可以自己定义规则，检查Java代码是否符合某些特定的编码规范。例如，你可以编写一个规则，要求PMD找出所有创建Thread和Socket对象的操作。
2.3.工作原理
PMD的核心是JavaCC解析器生成器。PMD结合运用JavaCC和EBNF（扩展巴科斯-诺尔范式，Extended Backus-Naur Formal）语法，再加上JJTree，把Java源代码解析成抽象语法树（AST，Abstract Syntax Tree）
从根本上看，Java源代码只是一些普通的文本。不过，为了让解析器承认 这些普通的文本是合法的Java代码，它们必须符合某种特定的结构要求。这种结构可以用一种称为EBNF的句法元语言表示，通常称为“语法” （Grammar）。JavaCC根据语法要求生成解析器，这个解析器就可以用于解析用Java编程语言编写的程序。
2.4.规则分类
- 最佳实践：公认的最佳实践的规则。
- 代码风格：这些规则强制执行特定的编码风格。
- 设计：帮助您发现设计问题的规则。
- 文档：这些规则与代码文档有关。
- 容易出错的规则：用于检测被破坏的、非常混乱的或容易发生运行时错误的结构的规则。
- 多线程：这些规则在处理多个执行线程时标记问题。
- 性能：标记存在性能问题的代码的规则。
- 安全：显示潜在安全缺陷的规则。
2.5.编写PMD自定义规则
https://pmd.github.io/pmd-5.4.1/customizing/howtowritearule.html
https://testerhome.com/topics/4918
http://www.w3school.com.cn/xpath/index.asp
3.阿里巴巴Java开发规约插件p3c
3.1.GITHUB地址
https://github.com/alibaba/p3c
3.2.概述
阿里巴巴p3c项目包含三个部分：
- p3c-pmd，提供大部分规则实现，基于PMD框架开发，如果想实现自己的规则，可以基于该模块开发（该模块基于maven编译打包）
- IntelliJ IDEA插件，即idea-plugin模块（该模块基于gradle编译打包）
- Eclipse插件，即eclipse-plugin，本文不介绍
3.3.阿里编码规约IDEA插件使用
传送门:https://github.com/alibaba/p3c/wiki/IDEA%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3
4.基于p3c编写自定义编码规则
4.1.自定义规则
假设现在需要开发这么一个规则：方法请求参数列表不允许超过(含)5个
4.2.开发步骤
4.2.1.找出问题代码，使用pmd图形化工具解析成抽象语法树
代码示例：
package org.p3c.demo; public class Demo { public void methodA(int a) { } public void methodB(int a, int b, int c, int d, int e) { } }
将源码放入Source Code框，点击Go按钮，解析结果显示在左下框
4.2.2.分析抽象语法树
可以看到，整棵树的根节点是CompilationUnit，即编译单元，代表每个java源文件。我们首先要找到所有的方法声明，根据树节点名称大概也能看出来是MethodDeclaration，点击相应的节点，看看光标是否定位到源码方法声明位置。
仔细分析MethodDeclaration节点，可以看到他有以下几个直接子节点：ResultType、MethodDeclarator、Block，即返回类型、方法声明、方法体
MethodDeclarator是我们想找的节点XPATH表达式可以这么写：
//CompilationUnit//MethodDeclarator
验证表达式是否正确，将它写到PMD图形界面XPATH Query框中，点击Go按钮
接下来，我们需要找到每个方法对应的参数列表，参数列表节点是方法节点的直接子节点，完整XPATH表达式为：
//CompilationUnit//MethodDeclarator/FormalParameters
获取到参数列表节点后，我们查看该节点的属性，找出参数个数的属性，观察可以发现是ParameterCount属性。
到现在为止，抽象语法树已经分析完，我们知道这么找出代码中参数列表大于等于5个的方法了。
