pmd java规则_PMD - 用 Java 开发代码规则

待我称王封你为后i 2022-11-03 11:21 185阅读 0赞

在 PMD 的使用过程中，可以用 Java 或 XPath 来开发代码规则。

本文讲述如何使用 Java 来开发。

AST 对应的 Java 类库

PMD 使用抽象语法树(AST)来分析代码。它本身已经创建了一系列的 Java 类库来操作不同的语法元素。

在使用 Java 开发规则时，我们主要就是利用这些类来分析代码，从而找出违反规则的情况。

比如：

ASTAnnotation：对应的是注解，比如 @IsTest

ASTBreakStatement：对应的是 break 语句

ASTWhileLoopStatement：对应的是 while 循环

ASTLiteralExpression：对应的是字符串赋值语句

实现步骤

建立新的 Java 类

重写 visit() 函数，在函数中分析代码，找到违反规则的部分

将规则注册到规则集文件中

在 GitHub 中可以参考现有规则的 Java 实现。

举例

规则：代码中不能出现 System.debug() 函数。

建立新的 Java 类

建立一个新的类，名叫 SystemDebugShouldBeAvoidedRule，并且扩展 AbstractApexRule 类。

import java.util.List;

import net.sourceforge.pmd.lang.apex.ast.\*;

import net.sourceforge.pmd.lang.apex.rule.\*;

public class SystemDebugShouldBeAvoidedRule extends AbstractApexRule \{

\}

重写 visit() 函数

在新的类中重写 visit() 函数。

因为规则检测的入口是函数，所以参数是 ASTMethod 类型。

AST 类库中定义了很多方法，比如 findDescendantsOfType() 可以得到某个代码块下面的所有特定类型的元素。

import java.util.List;

import net.sourceforge.pmd.lang.apex.ast.\*;

import net.sourceforge.pmd.lang.apex.rule.\*;

public class SystemDebugShouldBeAvoidedRule extends AbstractApexRule \{

@Override

public Object visit(ASTMethod node, Object data) \{

boolean hasSystemDebug = false;

// 得到所有的调用函数的代码

List methodCallList = node.findDescendantsOfType(ASTMethodCallExpression.class);

for (ASTMethodCallExpression methodCall : methodCallList) \{

// 得到函数名

String assertMethodName = methodCall.getFullMethodName();

// 和 "system.debug" 比较

if ("system.debug".equalsIgnoreCase(assertMethodName)) \{

hasSystemDebug = true;

break;

\}

\}

if (hasSystemDebug) \{

// addViolationWithMessage() 函数会生成警告

addViolationWithMessage(data, node, "''\{0\}'' method should not have System.Debug function.", new Object\[\] \{ node.getImage() \});

\}

// 返回 data，其中会包含警告信息

return data;

\}

\}

将规则注册到规则集文件中

每个规则集都是以 XML 形式出现的。我们将新的规则注册进去：

since="6.23.0"

language="apex"

message="System Debug should be avoided"

class=".SystemDebugShouldBeAvoidedRule">

System Debug should be avoided

4

public void doSomething() \{

System.debug('test');

\}

\]\]>

这样，这条规则就可以使用了。

发表评论取消回复

表情：

评论列表（有 0 条评论，185人围观）

还没有评论，来说两句吧...

相关阅读

相关 pmd规则中文解释

· ShortVariable: Detects when a field, local, or parameter has a very short name. 翻译短变

墨蓝/ 2023年10月15日 17:45/ 0 赞/ 19 阅读

相关【DevOps】SVN集成PMD实现代码自动静态检查

> 在实现[SVN集成Checkstyle实现代码自动静态检查][SVN_Checkstyle]之后，除了循序渐进地推动相应规范的落地外，我们当然也不能仅仅将目光局限在偏隅一角

太过爱你忘了你带给我的痛/ 2023年06月30日 01:34/ 0 赞/ 132 阅读

相关 Maven – PMD示例

![format_png][]![format_png 1][] 在本文中，我们将向您展示如何使用[Maven PMD插件][Maven PMD]来分析Java代码。 PS

快来打我*/ 2023年02月15日 05:05/ 0 赞/ 8 阅读

相关 PMD【 Java 代码检查工具】入门使用教程（超详细）

PMD【 Java 代码检查工具】介绍使用方式 1、使用插件的方式 2、maven项目引入依赖的方式 3、pmd

红太狼/ 2022年11月12日 02:38/ 0 赞/ 657 阅读

相关 pmd java规则_PMD - 用 Java 开发代码规则

在 PMD 的使用过程中，可以用 Java 或 XPath 来开发代码规则。本文讲述如何使用 Java 来开发。 AST 对应的 Java 类库 PMD 使用抽象语法树

待我称王封你为后i/ 2022年11月03日 11:21/ 0 赞/ 186 阅读

相关 JAVA开发命名规则

阿里巴巴Java开发手册-命名规约 1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反例： \_name / \_\_nam

r囧r小猫/ 2022年09月28日 11:58/ 0 赞/ 201 阅读

相关代码走查工具FindBugs, PMD,CheckStyle

Eclipse安装findBugs插件在Eclipse中点击Help-Install New SoftWare，输入下面网址添加： [http://findbugs.cs

左手的ㄟ右手/ 2022年06月11日 00:19/ 0 赞/ 221 阅读

相关代码分析工具PMD

参考 [https://blog.csdn.net/dieyong/article/details/46911797][https_blog.csdn.net_dieyon

小鱼儿/ 2022年05月17日 03:52/ 0 赞/ 252 阅读

相关 Java-idea-FindBugs、PMD和CheckStyle对比

一、对比 <table> <tbody> <tr> <td> <p><strong>工具</strong></p> </td> <td> <p>

梦里梦外;/ 2022年03月30日 11:47/ 0 赞/ 211 阅读

相关全面剖析PMD静态代码扫描工具

PMD是使用JavaCC生成解析器来解析源代码并生成AST(抽象语法树)的，这两天对PMD及自定义规则做了调研及实验，部分说明来自官方说明文档，做了大部分参数的详细描述及测试，

红太狼/ 2022年02月23日 15:12/ 0 赞/ 797 阅读