展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > Java异常信息编写规范说明

Java异常信息编写规范说明

异常信息须含可定位上下文:明确类/方法、操作对象及失败原因;禁用泛化消息;自定义异常需重写getMessage()且不抛新异常;业务校验不用异常;包装异常须保留真实cause链。

本文目录

    异常信息须含可定位上下文:明确类/方法、操作对象及失败原因;禁用泛化消息;自定义异常需重写getMessage()且不抛新异常;业务校验不用异常;包装异常须保留真实cause链。

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

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

    Java里抛出的异常如果只写 "Error occurred" 这类泛化消息,等于没写。调用方根本无法判断是参数错、资源不可用,还是逻辑分支没覆盖。真正有用的异常信息要能回答三个问题:在哪发生的(类/方法)、对什么操作失败了(关键输入或状态)、为什么失败(直接原因)。

    实操建议:

    • 用模板句式:"Failed to [verb] [resource/object] due to [specific cause]",例如 "Failed to parse JSON string 'user_data' due to malformed UTF-8 byte sequence"
    • 避免在消息里拼接敏感数据(如密码、token),可用占位符代替:"Failed to connect to database at jdbc:mysql://***:3306/mydb"
    • 不要依赖日志级别来“补全”信息——catch 块里 log.error("xxx", e) 的日志内容,和 e.getMessage() 应该各自完整,不能互相依赖

    自定义异常类必须重写 getMessage() 且不抛出新异常

    很多团队建了 UserNotFoundException 却没重写 getMessage(),导致实际抛出时只有类名,或者重写时又调用了可能抛异常的方法(比如去查数据库拼消息),这会让原始错误被掩盖甚至引发 StackOverflowError。

    实操建议:

    • 所有自定义异常必须显式覆写 getMessage(),且只基于构造时传入的字段拼接,不调用外部方法
    • 推荐构造函数签名统一为:public MyException(String message, Throwable cause) 和 public MyException(String template, Object... args)(用 String.format 安全填充)
    • 禁止在 getMessage() 中做格式化失败兜底(比如 try-catch 吞掉 IllegalFormatException),那说明模板本身就有问题,该在测试阶段暴露

    不要用异常信息替代业务校验提示

    用户提交手机号为空,后端抛 IllegalArgumentException("phone is null") 并返回 HTTP 500,这是典型误用。异常是给开发者看的故障信号,不是给终端用户读的友好提示。

    实操建议:

    • 参数校验失败、业务规则拒绝等预期场景,应走正常返回路径(如 ResponseEntity.badRequest().body(...)),附带结构化错误码和用户语言提示
    • 异常仅用于非预期路径:文件突然被删、远程服务无响应、JSON 解析器内部状态损坏等“程序不该走到这里”的情况
    • 若框架强制要求异常转响应(如 Spring 的 @ExceptionHandler),也要在 handler 里剥离技术细节,重新组装面向用户的提示,而不是直接返回 e.getMessage()

    getCause() 链必须保持真实且不截断

    常见错误是捕获异常后“美化”再抛出:throw new ServiceException("Operation failed", e.getCause()),结果把中间一层 SQLException 给丢了,只剩最外层包装。调试时看到的是 ServiceException 套着 NullPointerException,但真实根因是数据库连接池耗尽。

    实操建议:

    • 包装异常时,始终用原始异常作 cause,不要取 e.getCause() 再传——除非你明确知道那层是冗余噪音(极少见)
    • 避免多层无意义包装:不要从 IOException → DaoException → ServiceException → ApiException,保留两层以内更利于归因
    • 日志打印时务必用 logger.error("xxx", e) 而不是 logger.error("xxx " + e.getMessage()),否则堆栈链丢失
    异常信息规范最难的部分不在写法,而在团队对“什么是预期/非预期”的共识。同一段代码,有人觉得空指针是bug,有人觉得是前端没校验——这种分歧会直接反映在异常层级和消息粒度上。别指望靠文档一次性对齐,得靠 Code Review 时具体问:“这个异常,运维看到第一条消息能立刻执行哪条命令?”
    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。

    Cubase Windows版
    Cubase Windows版

    Cubase 是 Steinberg 推出的数字音频工作站,提供 MIDI 编曲、多轨录音、音频编辑、虚拟乐器、效果处理、自动化、混音和母带输出工具。其 Pro、Artist 与 Elements 版本面向不同预算和制作规模,