Java中自定义异常命名规范

自定义异常应以Exception结尾、使用驼峰命名法并确保语义明确,如InvalidUserException,避免模糊名称如MyException,便于识别和维护。

在Java中,自定义异常的命名应当清晰表达其用途和异常类型,便于团队协作和后期维护。虽然Java语言本身没有强制规定异常类的命名格式,但业界形成了广泛接受的命名规范。

1. 以“Exception”结尾

所有自定义异常类的名称应以Exception作为后缀,这是Java标准库中的通用做法,有助于快速识别该类是一个异常类型。

  • 正确示例:InvalidUserException、PaymentFailedException、FileNotReadableException
  • 错误示例:InvalidUser、UserError、BadInput

2. 使用有意义的描述性名称

异常名应准确描述异常发生的原因或场景,避免使用模糊或过于宽泛的词汇。

  • 推荐:OrderNotFoundException、InsufficientBalanceException
  • 不推荐:MyException、ErrorOccurredException

3. 遵循驼峰命名法(PascalCase)

类名使用大驼峰命名法,每个单词首字母大写,符合Java类命名惯例。

  • 正确:DataValidationException
  • 错误:data_validation_exception、datavalidationexception

4. 区分检查异常与非检查异常(可选)

虽然不常见,但有些项目会通过命名区分受检异常(checked)和运行时异常(unchecked),例如加上“Checked”或“Runtime”前缀。不过这种做法并不普遍,建议优先保持简洁。

  • 如需区分:BusinessValidationException(通用)、SystemErrorException(严重问题)

基本上就这些。只要做到以Exception结尾、语义明确、命名规范,就能写出符合Java习惯的自定义异常类。