Java中 怎么用 ArchUnit 单元测试静态代码检查自定义异常的命名规范

酷磊君_8505

酷磊君_8505

2026-07-19

606人浏览

原创

archunit 可在单元测试中静态检查自定义异常命名是否以 exception 或 error 结尾:先筛选继承 throwable 的顶层非 jdk 类,再校验类名后缀,支持排除例外并提供清晰失败报告。

java中 怎么用 archunit 单元测试静态代码检查自定义异常的命名规范

ArchUnit 可以在单元测试中检查代码的静态结构,包括类名、包名、字段名等命名规范。要验证自定义异常是否遵循命名约定(例如:必须以 Exception 或 Error 结尾),不需要运行时逻辑,只需用 ArchUnit 的 Java 类解析能力 + 自定义规则即可实现。

识别自定义异常类

ArchUnit 通过 `classes().that()` 定义筛选条件。自定义异常通常是继承自 Throwable(或其子类如 Exception、RuntimeException、Error)且不在 JDK 核心包中(如 java.lang、java.util)的非匿名、非合成类。

  • 使用 haveSuperClass(Conditionally) 或 areAssignableTo(Throwable.class) 捕获所有异常类型
  • 排除 JDK 自带异常:用 and().not(beInAnyPackage("java..", "javax.."))
  • 确保是顶层类(非内部类/匿名类):加 and().areTopLevelClasses()

定义命名后缀规则

Java 异常命名惯例要求类名以 Exception 或 Error 结尾(如 ValidationException、NetworkError)。ArchUnit 提供 haveSimpleNameEndingWith(...) 直接校验简单类名(不含包路径)。

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载
  • 支持多后缀:用 or(haveSimpleNameEndingWith("Exception")).or(haveSimpleNameEndingWith("Error"))
  • 注意大小写敏感:默认严格匹配,若允许小写可先用 convert(...) 统一转为大写再判断
  • 避免误判接口或普通类:务必结合“继承自 Throwable”前提,否则可能把 MyExceptionUtil 这类名字也纳入检查

编写可执行的 ArchUnit 测试

将上述逻辑组合成一个 ArchRule,并在 JUnit 测试方法中调用 check(classes)。推荐使用 @AnalyzeClasses 注解自动加载项目字节码。

  • 添加依赖:archunit-junit5 和 archunit(版本建议 1.3.0+)
  • 测试类加上 @AnalyzeClasses(packages = "com.yourcompany")
  • 规则示例:
    ArchRuleDefinition.classes()<br>  .that().areAssignableTo(Throwable.class)<br>  .and().areTopLevelClasses()<br>  .and().not(beInAnyPackage("java..", "javax.."))<br>  .should().haveSimpleNameEndingWith("Exception")<br>  .orShould().haveSimpleNameEndingWith("Error")<br>  .because("custom exceptions must end with 'Exception' or 'Error'");
  • 运行失败时,ArchUnit 会清晰列出违反规则的类名和原因

处理常见例外情况

实际项目中可能存在合理例外,比如工具类 Exceptions(复数形式)、枚举 ErrorCode、或基类 BaseException。可通过 ignoreMethod(...) 或 ignorePackages(...) 排除干扰。

  • 忽略特定类:.and().not(new DescribedPredicate("is BaseException") { ... })
  • 忽略某包下所有类:and().not(beInAnyPackage("com.yourcompany.infra.exception"))
  • 若需更灵活匹配(如支持 ExceptionBase),可用正则:haveSimpleNameMatching(".*Exception|.*Error")

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10517

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7642

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6672

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1144

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

928

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1376

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2769

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20071

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1235

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习