★ FEATURED ARTICLE 静态分析代码质量开发工具【免费下载链接】error-proneCatch common Java mistakes as compile-time errors项目地址https://gitcode.com/gh_mirrors/er/error-prone点击查看免费下载JUnit 3 依靠方法名以test开头 public void无参签名 继承TestCase的约定来发现测试。只要前缀拼错、漏加test前缀、或签名不合规测试就会被 JUnit 3 静默跳过——不报错、不失败只在构建报告中少了几条用例。Error Prone 内置的JUnit3TestNotRun检查器专治此类问题它能在编译期把这类永远不会被执行的方法标为 ERROR并自动给出改名、提权、去static的修复建议。阅读本文你将掌握该检查器的完整触发规则、防误报机制以及如何利用它和它的自动修复让你的 JUnit 3 测试真正跑起来。一、问题背景JUnit 3 的按命名约定发现测试机制JUnit 3junit.framework.TestCase时代没有任何注解测试框架通过反射扫描来发现用例约定的匹配规则非常严格测试方法必须满足方法名以test开头大小写敏感public可见性无参数返回void。这条约定在 JUnitMatchers.java 中被直接建模为isJunit3TestCasematcherpublic static final MatcherMethodTree isJunit3TestCase allOf( methodNameStartsWith(test), methodHasNoParameters(), Matchers.MethodTreehasModifier(Modifier.PUBLIC), methodReturns(VOID_TYPE));任何一个条件不满足方法都会被 JUnit 3 的反射扫描忽略。最糟糕的是这种忽略是静默的编译不失败、运行不报错测试就这样悄悄消失了。这正是 docs/bugpattern/JUnit3TestNotRun.md 想要解决的问题——它把触发该错误的方法归纳为三类拼错test前缀如把testXxx写成tesXxx有Test注解但没有test前缀JUnit 3 不认注解只认名字签名错误非public、带参数、返回非void、是static等。以上任何情况都会导致 JUnit 3 忽略该方法。二、检查器如何判定这是一个本该执行的测试JUnit3TestNotRun的实现位于 core/src/main/java/com/google/errorprone/bugpatterns/JUnit3TestNotRun.java它实现的是CompilationUnitTreeMatcher在整个编译单元上扫描而非单个方法因为部分判定需要全文件视角例如要知道某方法是否在别处被调用。2.1 逐层过滤的checkMethod判定流程核心逻辑在checkMethodJUnit3TestNotRun.java#L130-L154它按顺序执行以下检查全部通过才报告问题所在类必须是 JUnit 3 测试类enclosingClass(isJUnit3TestClass)。isJUnit3TestClass见 JUnitMatchers.java#L144-L145要求继承自junit.framework.TestCase、没有RunWith注解、没有任何Test注解方法、非 abstract、且是顶层类。该方法本身不是一个合规的 JUnit 3 测试isJunit3TestCase命中则直接放过说明它是正常测试。方法长得像测试LOOKS_LIKE_TEST_CASEJUnit3TestNotRun.java#L85-L89无参数或为public、返回void、且所在类名不以Base结尾。方法没有被调用过通过预先扫描整个编译单元收集的calledMethods集合排除——如果该方法是工具方法且被其他代码调用说明它本来就不是测试不应误报。方法不是 overridefindSuperMethods非空则放过例如实现接口Foo { void testDoesStuff(boolean); }的方法会被排除。名字命中可疑模式方法名不以test开头但满足以下任一条件才继续命中MISSPELLED_NAME拼写错误正则或wouldRunInJUnit4有Test注解且无Ignore——即注解了但名字不对的情况。2.2 拼写错误正则MISSPELLED_NAME源码中精心设计了一个正则来捕获test的各种常见拼写错误JUnit3TestNotRun.java#L72-L83private static final Pattern MISSPELLED_NAME Pattern.compile( t.est|te.st| // 多插了一个字母 tst|tet|tes| // 少了一个字母 etst|tset|tets| // 字母顺序颠倒 t.st|te.t| // 换了一个字母 [tT][eE][sS][tT]); // 大小写混乱注释中还专门解释了为什么不匹配.est、est、.testrestore、destroy、best、establish等真实单词会因此被排除避免误报有人刻意用.test如disableThisTest来禁用测试test后面的内容属于合法命名因此.test也不在正则内。测试用例 JUnit3TestNotRunTest.java#L355-L416 中的negativeCase1验证了这一点bestNameEver()、destroy()、restore()、establish()、estimate()这些真实单词都不会被报告。三、触发示例哪些方法会被报告从测试文件 JUnit3TestNotRunTest.java 的positiveCases与misspelledTest可以归纳出典型触发样例import junit.framework.TestCase; public class ExampleTest extends TestCase { // 拼写错误tes 开头缺字母 public void tesName() {} // 拼写错误tets 开头字母颠倒 public void tetsName() {} // 拼写错误teat 开头换字母 public void teatName() {} // 大小写混乱Test 开头 public void TestName() {} // 有 Test 注解但名字没有 test 前缀 → 仍会被 JUnit 3 忽略 Test public void doesStuff() {} // 签名错误privateJUnit 3 需要 public private void testDoesStuff() {} // 签名错误staticJUnit 3 需要实例方法 public static void testParseSomething() {} // 签名错误带参数JUnit 3 测试方法必须无参 public void testDoesStuff(boolean param) {} }对照修复后的正确形态public void testName()、public void testDoesStuff()。注意测试privateNamedTest、privateMisspelledTest、hasParameters_butOtherwiseLooksLikeATestMethod均在测试中被标注了BUG: Diagnostic contains:证明这些情况都会被报告。四、防误报设计哪些情况会被刻意放过这个检查器在准确性上做了大量收敛以下情况不会被报告均有测试佐证场景理由测试用例方法名正确拼写test前缀是正常测试negativeCase1名字以真实单词开头best/destroy/restore等正则刻意排除negativeCase1非void返回类型 / 带参数的方法不像测试negativeCase1所在类是 JUnit 4 类RunWith(JUnit4.class)JUnit 4 靠注解发现测试negativeCase2混合 JUnit34类上有RunWith无法确定运行方式negativeCase3、negativeCase5abstract测试类无法确定运行方式negativeCase4方法在类内被其他方法调用是工具方法而非测试hasParameters_calledElsewhere_noFinding方法是 override不归 JUnit 3 负责hasParameters_isOverride_noFinding基类类名以Base结尾中的方法可能是模板方法hasParameters_butInABaseClasssetUp()生命周期方法JUnit 3 特殊处理setupMethod_shouldBeIgnored这种宁可放过、不可误报的取向也体现在源码注释中JUnit3TestNotRun.java#L63-L71作者明确表示有意排除了.est与est等模式因为会命中真实单词对于tets → tests这类纠正结果不够优雅的拼写也选择宁要简单正则、保留误报风险可控的方案。五、修复方案自动修复与手动重命名5.1 Error Prone 的自动修复describeFixes当方法被命中时检查器会构建一条SuggestedFixJUnit3TestNotRun.java#L156-L173自动执行三步修复重命名若方法名不以test开头——命中MISSPELLED_NAME正则的把拼错的部分直接替换为test如tesName→testName否则把方法名改造为test 首字母大写的驼峰形式如doesStuff→testDoesStuff。提升可见性通过SuggestedFixes.Visibility.PUBLIC.refactor把方法改为publicprivate void testDoesStuff()→public void testDoesStuff()。移除static修饰符removeModifiers(..., Modifier.STATIC)。这段修复逻辑被BugCheckerRefactoringTestHelper的测试完整验证过。例如misspelledTest测试JUnit3TestNotRunTest.java#L75-L136展示了tesName1、ttestName2、teestName3、tstName4、etstName6、TEST_NAME_10、tesname11等分别被自动纠正为testName1、testName2、testName3、testName4、testName6、test_NAME_10、testname11hasModifiersAndThrows测试则验证了private static void tsetDoesStuff() throws Exception被一键修复为public void testDoesStuff() throws Exceptionthrows子句保留。5.2 手动修复遵循原文档建议原文档 docs/bugpattern/JUnit3TestNotRun.md 给出的手动修复建议是若本意是禁用该测试或这是辅助方法改成一个更有描述性的名字例如disabledTestSomething()不需要Test注解如果确实想保留注解请同时加上Ignore明确表达我有意停用。TestIgnore的组合在negativeCase1测试中有对应的负例验证——Test Ignore public void ignoredTest() {}与Ignore Test public void ignoredTest2() {}都不会被报告。其底层依据是wouldRunInJUnit4matcher 要求有Test且无IgnoreJUnitMatchers.java#L238-L241。5.3 抑制Suppress如果某个方法确实需要保留原样例如带参数的testDoesStuff(boolean)且不想改名可以在方法上添加SuppressWarnings(JUnit3TestNotRun)这在测试suppressionWorksJUnit3TestNotRunTest.java#L259-L272中已得到验证。六、严重级别与默认启用状态JUnit3TestNotRun的BugPattern注解将严重级别设为ERRORJUnit3TestNotRun.java#L56-L60摘要为Test method will not be run; please correct method signature (Should be public, non-static, and method name should begin with test).这意味着一旦命中默认配置下会直接阻断编译而不是仅仅给出警告让测试没跑这类问题在编译期暴露。它被注册进内置检查器集合的ENABLED_ERRORSBuiltInCheckerSuppliers.java#L813无需额外配置即可随 Error Prone 编译启用。若你的项目还在维护 JUnit 3 测试强烈建议保持其默认启用状态。七、延伸阅读JUnit 4 时代的姊妹检查器与JUnit3TestNotRun相对的是 JUnit4TestNotRun源码注册于 BuiltInCheckerSuppliers.java#L817。它解决的是 JUnit 4 中的镜像问题JUnit 4 靠Test注解发现测试一个看起来像测试名字以test开头、签名正确但没有Test注解的方法同样不会被运行。其修复建议同样是有意停用就加TestIgnore是辅助方法就降低可见性非public。这两个检查器共同覆盖了 JUnit 3 与 JUnit 4 两代测试框架的静默跳过场景配合 Error Prone 编译期检查与自动修复可以让开发者把精力从排查测试为什么没跑转移到真正的业务逻辑上。总结JUnit3TestNotRun是一个高度克制的编译期检查器它以 JUnit 3 的命名约定为判定依据用精心设计的拼写正则和层层防误报过滤排除真实单词、被调用方法、override、JUnit 4 类、abstract 类、Base基类等只报告真正本该是测试却不会被运行的方法并以 ERROR 级别阻断编译、提供一键自动修复。如果你维护着任何继承junit.framework.TestCase的测试代码让 Error Prone 的这条检查器保持开启是最廉价也最可靠的测试静默丢失防线。赞分享静态分析代码质量开发工具【免费下载链接】error-proneCatch common Java mistakes as compile-time errors项目地址https://gitcode.com/gh_mirrors/er/error-prone点击查看免费下载相关推荐Error Prone MissingFail 检查器让 JUnit 异常测试不再漏掉 fail() 调用Error Prone MissingFail 检查器让 JUnit 异常测试不再漏掉 fail 调用 本指南围绕 Error Prone 项目中的 Miss静态分析代码质量开发工具Error Prone 构造器链检查 ChainingConstructorIgnoresParameter编译期捕获被忽略的透传参数Error Prone 构造器链检查 ChainingConstructorIgnoresParameter编译期捕获被忽略的透传参数 在 Java 中构造静态分析代码质量开发工具Error Prone 常量溢出检查ConstantOverflow让编译期常量运算溢出无处遁形Error Prone 常量溢出检查ConstantOverflow让编译期常量运算溢出无处遁形 导读 本篇文章聚焦 Error Prone 静态分析工具静态分析代码质量开发工具上一篇M开源字体多语言支持的完美字体解决方案下一篇CombineFeedback与SwiftUI完美结合ViewContext的高效使用技巧创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
阅读完成 · 觉得有帮助？
