编写XPATH表达式实现PMD规则：捕获仅用于日志的方法参数

核心判断逻辑 #

要精准捕获目标场景，需同时满足三个条件：

• 参数存在至少一次使用（排除完全未使用的情况）
• 参数的所有使用位置均属于Slf4j日志方法调用
• 日志方法限定为log.info/log.error/log.warn/log.debug（可按需扩展）

正确XPATH表达式 #

//MethodDeclaration
//FormalParameter[@ParameterName 
    and count(../../../../Reference[@Image = current()/@ParameterName]) > 0
    and count(../../../../Reference[
        @Image = current()/@ParameterName
        and not(ancestor::MethodCall[
            @MethodName = ('info','error','warn','debug')
            and ancestor::VariableAccess[@Image='log']
        ])
    ]) = 0
]

表达式拆解 #

1. //MethodDeclaration//FormalParameter[@ParameterName]：定位到方法的所有参数节点
2. count(../../../../Reference[@Image = current()/@ParameterName]) > 0：确保参数至少被使用过，排除完全未使用的场景
3. count(../../../../Reference[...]) = 0：确保参数的所有引用都在指定的日志方法调用中，没有出现在其他业务逻辑代码里
   • ancestor::MethodCall[@MethodName = ('info','error','warn','debug')]：匹配日志级别方法
   • ancestor::VariableAccess[@Image='log']：匹配@Slf4j生成的默认日志变量

示例验证 #

应被捕获的代码（参数仅用于日志） #

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class LogOnlyParamExample {
    public void handleRequest(String requestId) {
        // requestId仅出现在日志调用中
        log.debug("Received request with ID: {}", requestId);
    }
}

不应被捕获的代码 #

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ValidUsageExample {
    // 参数完全未使用，排除
    public void emptyMethod(String unusedParam) {
        log.info("Method executed");
    }

    // 参数用于业务逻辑，排除
    public void processData(String data) {
        log.info("Processing data: {}", data);
        String processed = data.trim();
    }
}

自定义扩展提示 #

• 若项目中日志变量名不是log（如logger），需将@Image='log'替换为对应变量名
• 如需覆盖更多日志级别，可在@MethodName的取值中添加trace等方法名

内容的提问来源于stack exchange，提问作者Matheus Ferreira de Araujo