静态分析代码质量开发工具【免费下载链接】error-proneCatch common Java mistakes as compile-time errors项目地址https://gitcode.com/gh_mirrors/er/error-prone点击查看免费下载Error Prone 的PreconditionsInvalidPlaceholder检查器BugChecker专门拦截 GuavaPreconditions与Verify系列方法中的错误消息模板串确保其只使用%s占位符并保证占位符数量与传入参数一一对应。读完本文你将掌握该检查的完整触发条件、错误示例、自动修复SuggestedFix的生成逻辑、源码级实现细节以及如何在自己的构建中启用或关闭它。背景Guava Preconditions 的消息模板并非标准格式串Guava 的Preconditions以及Verify方法在断言失败时用来构造异常消息的模板串看起来很像printf格式串但实际只接受%s一种占位符。例如import static com.google.common.base.Preconditions.checkArgument; checkArgument(x 0, %d 0, x);这里模板中的%d并不会像String.format那样被解释为十进制整数格式而会被当作字面文本输出或引发运行时异常导致错误消息中显示原始的%d甚至抛出IllegalFormatException。由于这类错误在测试时往往不易暴露开发人员很容易写出“看起来对、跑起来错”的模板串。该文档对应的 BugChecker 正是针对这一陷阱设计的它标记出模板串中出现了非%s格式符或%s数量与实际传入的参数数量不匹配的情况。检查规则详解根据 PreconditionsInvalidPlaceholder.java 的实现检查在编译期对方法调用MethodInvocationTree进行匹配命中后报出严重级别为ERROR的诊断并带有LIKELY_ERROR标准标签1. 匹配目标Preconditions 与 Verify 的“消息模板在第二个参数”的方法private static final MatcherExpressionTree PRECONDITIONS_CHECK allOf( anyOf( staticMethod().onClass(com.google.common.base.Preconditions), staticMethod().onClass(com.google.common.base.Verify)), PreconditionsInvalidPlaceholder::secondParameterIsString);只匹配com.google.common.base.Preconditions和com.google.common.base.Verify两个类上的静态方法要求方法签名中第二个参数是String类型通过methodSymbol.getParameters().get(1).type与stringType做子类型判断从而只覆盖checkArgument(boolean, String, Object...)、checkState(boolean, String, Object...)、checkNotNull(Object, String, Object...)、Verify.verify(boolean, String, Object...)这类“第二个参数是模板串”的重载自动跳过checkNotNull(obj, message)这类第一个参数才是模板串的方法。2. 模板串必须是编译期字符串字面量tree.getArguments().get(1) instanceof LiteralTree formatStringTree第二个参数必须是**字符串字面量LiteralTree**才会继续分析——变量或非常量表达式不在检查范围内。3. 非 %s 占位符的识别正则private static final Pattern BAD_PLACEHOLDER_REGEX Pattern.compile(\\$s|%(?:\\d\\$)??[dbBhHScCoxXeEfgGaAtTn]|\\{\\d});该正则覆盖三类“坏占位符”模式含义示例\$s显式索引的%1$s形式含$分隔符%1$s%(?:\d\$)??[dbBhHScCoxXeEfgGaAtTn]大部分java.util.Formatter转换符d、b、B、h、H、S、c、C、o、x、X、e、E、f、g、G、a、A、t、T、n可选前置参数索引%2$d%d、%f、%tY、%2$s\{\d\}java.text.MessageFormat风格的占位符{0}、{1}源码注释特别说明该正则不必完全穷举因为它只用于触发诊断与生成修复建议%s本身被刻意排除在外。4. 触发条件坏占位符 参数数量不匹配int expectedArgs expectedArguments(formatString); if (expectedArgs tree.getArguments().size() - 2 BAD_PLACEHOLDER_REGEX.matcher(formatString).find()) { return describe(tree, state); }注意这里并非任何坏占位符都会报警还要求expectedArguments 实参个数 - 2即模板中%s的数量小于调用实际传入的格式化参数个数总参数数减去两个固定参数条件表达式与模板串。也就是说当同时存在非%s占位符、且%s数量不足以消耗全部参数时才判定为可疑并报告。expectedArguments通过简单扫描%s出现次数实现private static int expectedArguments(String formatString) { int count 0; for (int i formatString.indexOf(%s); i ! -1; i formatString.indexOf(%s, i 1)) { count; } return count; }诊断与自动修复SuggestedFix逻辑命中后检查器不仅报错还会尝试给出可直接落地的自动修复逻辑位于describe方法先读取源码中模板串的原文state.getSourceForNode(formatTree)把正则匹配到的坏占位符全部替换为%s得到fixedFormatString若替换后%s数量恰好等于实参个数减 2则生成SuggestedFix.replace(formatTree, fixedFormatString)直接把模板串替换为新串若替换后仍有缺口missing 实参个数 - 2 - expectedArguments(fixedFormatString)则在该串末尾追加 [%s, %s, ...]形式的补充占位符先删除末尾的引号再追加[%s...]并补回引号例如// 修复前 checkArgument(x 0, %d 0, x); // 修复后 checkArgument(x 0, [%s 0] ...); // 具体按描述算法生成由于describe方法为public可被其他检查器复用例如文档站生成或重构工具链。从测试用例看行为边界PreconditionsInvalidPlaceholderTest.java 使用CompilationTestHelper验证正反两类场景正例应报错——PreconditionsInvalidPlaceholderPositiveCase1checkArgument(x 0, %d 0, x); // %d 是非法占位符 Preconditions.checkState(foo 0, foo must be equal to 0 but was {0}, foo); // MessageFormat 风格 {0} Verify.verify(x 0, %d 0, x); // Verify 同样受检查三个用例分别验证Formatter风格的%d、MessageFormat风格的{0}以及Verify类方法同样被覆盖。反例不应报错——PreconditionsInvalidPlaceholderNegativeCase1checkArgument(x 0, %s 0, x); // 正确用法无坏占位符 checkArgument(x 0, %s %s, x); // 占位符多于实参不触发 checkState(foo.intValue() 0, foo must be equal to 0 but was %s, foo); // 纯 %s checkNotNull(foo, Foo, this); // 自写的 checkNotNull模板位置不符合匹配条件关键边界占位符比实参多%s %s只有 1 个参数时不会触发第二个参数为字符串但该调用本身并非 Guava 方法自定义checkNotNull时也不会触发。这印证了该检查聚焦“坏占位符 参数无法被 %s 消化”的组合场景与专门校验 printf 风格格式串的 FormatString基于FormatStringValidation做严格%d、%s匹配校验形成互补分工。启用与关闭方式该检查器是 Error Prone 内置检查器之一已注册在 BuiltInCheckerSuppliers.java 的默认启用列表中PreconditionsInvalidPlaceholder.class因此只要在你的构建中接入 Error Prone 插件即默认生效无需额外配置。Error Prone 支持 Maven。接入后如需临时关闭可通过标准命令行参数控制# 将错误降级为警告或彻底关闭 javac -Xep:PreconditionsInvalidPlaceholder:OFF ... javac -Xep:PreconditionsInvalidPlaceholder:WARN ...对应 Maven 编译器插件中可配置为compilerArgs arg-Xep:PreconditionsInvalidPlaceholder:OFF/arg /compilerArgs注意以-Xep:...:OFF关闭后即使代码里写%d、{0}这类模板串编译期也不会再收到该检查的诊断建议仅在迁移存量代码、暂无法修复时使用新代码应始终遵循%s规范。小结PreconditionsInvalidPlaceholder通过“限定方法集Preconditions/Verify的字符串模板重载→ 识别非%s占位符 → 校验%s数量与实参匹配”三步完成编译期拦截并附带把坏占位符统一改写为%s的自动修复。它把“错误消息模板写错”这类运行时才暴露的隐患提前到编译阶段是与FormatString检查互为补充的格式串安全防线。在日常使用中只需牢记一条铁律Guava Preconditions / Verify 的消息模板里只用%s并且让%s的个数与实参个数保持一致。赞分享静态分析代码质量开发工具【免费下载链接】error-proneCatch common Java mistakes as compile-time errors项目地址https://gitcode.com/gh_mirrors/er/error-prone点击查看免费下载相关推荐Error Prone 检查器 ExpensiveLenientFormatString消除 Guava Preconditions 等宽松格式化方法中的昂贵急切字符串构造Error Prone 检查器 ExpensiveLenientFormatString消除 Guava Preconditions 等宽松格式化方法中的昂贵静态分析代码质量开发工具Error Prone AnnotationPosition 检查器让注解与 Javadoc 的位置符合 Google Java StyleError Prone AnnotationPosition 检查器让注解与 Javadoc 的位置符合 Google Java Style 导读 Annot静态分析代码质量开发工具Error Prone 的 LiteProtoToString 检查器阻止 Lite Protobuf 的 toString() 混入生产错误信息Error Prone 的 LiteProtoToString 检查器阻止 Lite Protobuf 的 toString 混入生产错误信息 导读 本文介绍静态分析代码质量开发工具上一篇2025年Q1重要讨论汇总下一篇Xberg PHP 冒烟测试实战用 ExtractInput 与 extract() 从纯文本文件提取内容创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考