Java 异常与日志规范宣讲大纲怎么写

落晨同学_1509

落晨同学_1509

2026-10-24

383人浏览

原创

空指针异常是程序逻辑错误,需按场景区分处理:支付模块应转为业务异常并warn日志,工具类须fail-fast;外部调用要捕获封装,内部校验直接抛illegalargumentexception;npe属bug不捕获,error日志须含traceid、用户id、入参摘要。

java 异常与日志规范宣讲大纲怎么写

一、明确宣讲目标:不是讲语法,而是统一团队认知

重点不在于复述 Exception 和 RuntimeException 的继承关系,而是让开发、测试、运维理解:为什么同一类空指针,在支付模块要抛出业务异常并记录 warn,在工具类中却应快速 fail-fast 不捕获?核心是建立「异常代表什么、日志说明什么、谁来关注、何时介入」的共识。

二、异常规范:聚焦三个关键决策点

用实际代码场景带出判断逻辑,避免抽象定义:

  • 该不该捕获? —— 外部系统调用(如 HTTP 请求)必须捕获并转为受检异常或封装后的业务异常;内部方法参数校验失败(如 ID ≤ 0)直接 throw IllegalArgumentException,不 try-catch
  • 该不该往上抛? —— Service 层不吞异常;Controller 层统一用 @ExceptionHandler 处理,返回标准错误码和提示,不把原始堆栈暴露给前端
  • 该用哪种异常? —— 业务规则失败(如“余额不足”)用自定义 Checked 异常(如 InsufficientBalanceException);程序逻辑错误(如 NPE、ArrayIndexOutOfBoundsException)属于 Bug,不捕获、不包装、让其崩溃并靠日志定位

三、日志规范:围绕「可查、可溯、可读」落地

拒绝“System.out.println”和“log.info(“出错了”)”:

  • 级别要精准:info 仅用于关键业务节点(如“订单创建成功,ID=12345”);warn 用于预期外但可恢复的情况(如缓存未命中、降级触发);error 必须伴随完整上下文(traceId、用户ID、入参摘要、异常 cause)
  • 内容要结构化:禁用字符串拼接日志(log.info("处理用户" + userId + "失败")),改用占位符(log.error("订单支付失败,orderNo={}, userId={}", orderNo, userId))
  • 敏感信息要过滤:手机号、身份证、银行卡号等字段在打日志前脱敏(如 138****1234),配置 logback 的 MaskingPatternLayout 或自定义 Appender

四、协同动作:让规范真正跑起来

单靠文档无法落地,需配套机制:

  • 在 CI 流程中加入日志扫描(如使用 Log4j2 的 Lookups 检测未脱敏字段)、异常吞没检测(FindBugs/SpotBugs 规则)
  • 提供标准模板:Controller 全局异常处理器代码片段、常用业务异常类骨架、logback-spring.xml 推荐配置
  • 设立「异常日志看板」:聚合 error 日志 Top10、慢请求关联异常率、各服务 warn/error 比率趋势,每周同步给研发负责人

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

11077

6

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

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

2023.07.05

8202

9

java自学难吗
java自学难吗

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

2023.07.31

7092

8

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

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

2023.08.01

1184

3

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

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

2023.08.02

968

3

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

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

2023.08.02

1436

5

java有什么用
java有什么用

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

2023.08.02

2929

5

java在线网站
java在线网站

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

2023.08.03

20191

3

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

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

2023.08.03

1275

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习