0

0

在Java里异常信息应该如何编写_Java异常提示规范说明

P粉602998670

P粉602998670

发布时间:2026-02-22 15:30:13

|

656人浏览过

|

来源于php中文网

原创

异常信息须含可定位上下文且脱敏,如“userid cannot be null or empty, got: ”+userid;禁拼敏感数据;自定义异常需重写构造函数并确保getmessage()返回可读文本;message表“什么错”,堆栈表“在哪错”,日志表“当时上下文”。

在java里异常信息应该如何编写_java异常提示规范说明

异常信息必须包含可定位的上下文

抛出异常时,message不能只是“操作失败”“参数错误”这种空泛描述。用户看到异常第一反应是“哪里出问题了”,所以必须带具体对象、值、状态或位置。

  • ❌ 错误写法:throw new IllegalArgumentException("参数错误");
  • ✅ 正确写法:throw new IllegalArgumentException("userId cannot be null or empty, got: " + userId);
  • 如果涉及集合或索引,补上长度和索引值,例如:"index " + i + " out of bounds for array of length " + arr.length
  • 日志中打印异常时,也建议在 catch 块里加前缀,比如 "[UserService#loadById] failed to load user: " + e.getMessage()

不要在异常信息里拼接敏感数据

密码、token、身份证号、完整 SQL(含参数值)等不能直接出现在 message 中——这会导致脱敏失效,尤其在日志被集中采集或导出时风险极高。

  • ❌ 危险写法:throw new SecurityException("Invalid token: " + rawToken);
  • ✅ 安全写法:throw new SecurityException("Invalid token (length=" + rawToken.length() + ")");
  • 数据库异常建议只保留表名、字段名、错误码,如:"Failed to insert into user_profile: duplicate key on email",而非拼接完整 INSERT 语句
  • 若需调试,用 logger.debug("Raw token: {}", rawToken) 单独记录,且确保该日志级别默认关闭

自定义异常类要重写 getMessage() 或构造函数

继承 RuntimeExceptionException 后,别依赖父类默认行为。很多团队封装了 BusinessException,但没重载构造逻辑,导致最终 message 仍是空或不一致。

Gaga
Gaga

曹越团队开发的AI视频生成工具

下载
  • 务必提供至少一个接受 String 的构造函数,并调用 super(message)
  • 如果需要结构化错误码,建议额外提供 int code 字段,但 getMessage() 仍应返回人类可读文本,而不是只返回错误码数字
  • 避免在 getMessage() 中做耗时操作(如远程调用、格式化大对象),它可能被频繁调用(如序列化、日志框架采样)

日志与异常堆栈的分工要清楚

异常信息(message)负责「什么错了」,堆栈负责「在哪错的」,日志负责「当时上下文是什么」。三者混用会降低排查效率。

立即学习Java免费学习笔记(深入)”;

  • ❌ 反模式:在 message 里写 "at com.example.UserDao.save(UserDao.java:42)" ——这是堆栈的事,不是 message 的职责
  • ✅ 推荐做法:异常 message 纯业务语义,堆栈保持原生,额外关键变量用 logger.warn("Save user failed. userId={}, status={}", userId, status, e) 记录
  • 注意某些框架(如 Spring)会自动包装异常,导致原始 message 被吞掉一层,此时建议用 Throwable.getCause() 检查并提取真正有用的 message
实际项目中最容易被忽略的是:异常 message 在跨服务传递(比如通过 Dubbo 或 HTTP 返回 JSON 错误体)时,往往被前端直接展示给用户。这时候既要防信息泄露,又要保证客服能看懂——得靠统一的错误码 + 可配置的提示文案,而不是把所有逻辑塞进 message 字符串里。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1006

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

335

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

379

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1802

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

377

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1354

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

585

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

437

2024.04.29

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

1030

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 3.8万人学习

C# 教程
C# 教程

共94课时 | 9.9万人学习

Java 教程
Java 教程

共578课时 | 70万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号