讲师中心 微信公众号
AI工具推荐 视频效率加速

怎么编写符合阿里巴巴开发规约的标准自定义异常POJO

夜浩大大_9913

夜浩大大_9913

发布时间:2026-03-26 17:49:19

|

785人浏览过

|

来源于php中文网

原创

应继承 RuntimeException 并提供4个标准构造方法,不添加字段、不实现 Serializable,命名体现业务域且以 Exception 结尾。

怎么编写符合阿里巴巴开发规约的标准自定义异常pojo

编写符合阿里巴巴 Java 开发手册(《阿里巴巴 Java 开发规约》)的自定义异常 POJO,核心是继承 RuntimeException、提供规范构造方法、避免冗余字段、不实现序列化接口。手册明确要求:业务异常应使用 unchecked 异常(即继承 RuntimeException),且自定义异常类应保持轻量、语义清晰、便于定位问题。

1. 继承 RuntimeException,不继承 Exception

阿里规约第 7 章「异常日志」明确指出:“推荐使用 RuntimeException 或其子类作为业务异常类型”。因为业务异常属于“可预期的、流程中主动抛出的异常”,不应强制调用方 try-catch,避免代码臃肿。

  • ✅ 正确:public class BizException extends RuntimeException
  • ❌ 错误:public class BizException extends Exception(需声明 throws,违反规约)
  • ❌ 错误:public class BizException extends IOException(属于受检异常体系,不适用业务场景)

2. 提供标准构造方法(4 种必须)

为兼容主流日志框架(如 Logback、SLF4J)和 IDE 自动补全,需完整提供以下构造方法(顺序与 JDK 内置异常一致):

  • 无参构造:public BizException()
  • 带 message 构造:public BizException(String message)
  • 带 cause 构造:public BizException(Throwable cause)
  • 带 message 和 cause 构造:public BizException(String message, Throwable cause)

注意:message 应简洁明确,建议包含业务上下文关键词(如“订单”“库存”“用户ID=xxx”),但不要拼接敏感信息或堆栈;cause 必须调用 super(cause) 传递,确保异常链完整。

3. 不添加额外字段,禁止序列化相关代码

阿里规约强调“异常类不应有属性,更不应实现 Serializable 接口”。原因有三:

  • 异常本质是信号,不是数据载体;加字段易被误用为 DTO
  • 序列化 ID(serialVersionUID)和 writeObject/readObject 方法会引入维护负担
  • 分布式场景下异常跨服务传播时,字段可能引发版本兼容或安全问题

✅ 正确写法:类体为空,仅含构造方法;

❌ 错误写法:private String errorCode; private Long userId; private static final long serialVersionUID = 1L;

4. 命名与包路径规范

命名体现业务域和异常性质,包路径与对应 service 层对齐:

  • 类名以 Exception 结尾,如 OrderCreateException、InventoryLockFailException
  • 包路径建议:com.xxx.yyy.exception(与 service 包同级,避免放在 dto 或 model 下)
  • 避免泛化命名:如 MyException、BaseException、GlobalException(语义模糊,违反规约“异常命名应见名知意”)

示例精简代码:

<!-- Java -->

package com.alibaba.trade.exception;<br><br>public class OrderCreateException extends RuntimeException {<br>    public OrderCreateException() {<br>        super();<br>    }<br><br>    public OrderCreateException(String message) {<br>        super(message);<br>    }<br><br>    public OrderCreateException(Throwable cause) {<br>        super(cause);<br>    }<br><br>    public OrderCreateException(String message, Throwable cause) {<br>        super(message, cause);<br>    }<br>}

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
java
java

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

10877

2023.06.15

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

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

8002

2023.07.05

java自学难吗
java自学难吗

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

6952

2023.07.31

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

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

1164

2023.08.01

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

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

948

2023.08.02

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

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

1416

2023.08.02

java有什么用
java有什么用

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

2869

2023.08.02

java在线网站
java在线网站

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

20151

2023.08.03

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn