为eclipse-pmd插件开发自定义规则时，能否通过XPATH查询获取变量类型？

核心结论 #

开发适配Eclipse环境的PMD自定义规则时，完全可以通过XPath查询获取变量类型，无需完全基于Java编码实现规则逻辑。PMD的Java模块在生成抽象语法树（AST）时内置了语义分析流程，会自动为语法节点绑定对应的类型信息，这些信息可直接被XPath表达式访问。

具体实现方式 #

PMD为XPath引擎内置了类型访问的扩展属性与函数，针对变量相关节点的取值方式如下：

• 定位变量对应的AST节点：常规局部变量、类成员变量都会对应VariableId类型的AST节点，可通过XPath路径直接定位
• 读取变量的全限定类型名：通过节点内置的@TypeFullName属性直接获取，例如匹配java.util.HashMap类型的成员变量，可编写XPath表达式：//FieldDeclaration//VariableId[@TypeFullName = 'java.util.HashMap']
• 跨继承层级判断类型：使用内置的@IsA('目标类型全限定名')函数，可自动匹配子类、实现类场景，无需手动遍历类的继承链

常见实现注意事项 #

• Eclipse环境下的PMD插件自带独立的类型解析逻辑，不强制依赖Eclipse JDT环境即可获取基础类型信息；但如果需要解析工程依赖的第三方类的类型，需要为PMD配置匹配的工程类路径，否则会出现类型解析失败、返回空值的问题
• 当前PMD的类型属性仅能获取泛型擦除后的原生类型，无法直接通过XPath获取泛型参数的具体类型，例如List<String>类型的变量仅能解析出java.util.List的原生类型
• 如果PMD的解析配置关闭了语义绑定分析，所有类型相关属性都会返回空值，需要在规则解析配置中确认开启属性处理选项
• 对于lambda表达式、增强for循环中的隐式声明变量，需要先定位到对应隐式变量的参数节点，再读取类型属性，无法通过普通变量声明的路径直接定位

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