Java 日志规范与脱敏指南怎么编写

千杰君_4123

千杰君_4123

2026-10-20

363人浏览

原创

java日志规范与脱敏指南的核心是记录必要信息、不泄露敏感数据、便于排查问题、符合安全合规要求,是开发、运维、安全三方共同遵守的协作约定。

java 日志规范与脱敏指南怎么编写

Java 日志规范与脱敏指南的核心是:记录必要信息、不泄露敏感数据、便于排查问题、符合安全合规要求。它不是纯技术文档,而是开发、运维、安全三方共同遵守的协作约定。

一、日志内容规范:记什么、怎么记

避免“全量打印”或“只打异常堆栈”,应分场景明确日志级别和内容:

  • INFO 级别:记录关键业务流转节点,如“用户[12345]提交订单成功,订单号ORD-20240501-789”——含主键ID、操作类型、结果状态,不含密码、手机号、身份证等原始值;
  • WARN 级别:记录可恢复的异常或边界情况,如“支付回调签名验证失败(商户号MCH-678,时间偏差+3200ms)”,需包含上下文线索但不暴露密钥或明文签名;
  • ERROR 级别:仅记录不可忽略的系统级错误,必须带完整异常类名、消息、关键业务ID(如订单ID、请求traceId),禁止直接打印Exception.printStackTrace()到业务日志;
  • DEBUG 级别:仅在本地或测试环境开启,用于临时定位逻辑分支,上线前必须关闭或用条件日志(如if (log.isDebugEnabled()))包裹。

二、敏感信息识别与脱敏策略

脱敏不是“模糊处理”,而是按字段类型+使用场景分级控制:

JavaStoryDevelop
JavaStoryDevelop

你接手一个需求时,是不是经常这样:"改一个小字段 → 结果把不相关的代码也改了"、"需求说得很模糊 → 做着做着发现跑偏了"、"数据库加个字段 → 上线才发现漏了数据兼容"、"做了个新功能 → 一个月后自己都忘了当时怎么设计的"、"写到一半被中断 → 再回来不知道从哪继续";这个 Skill 就是专门解决这些问题的。 它会自动探测你的项目环境(JDK、Spring Boot、ORM、数据库、前端框架),记在

下载
  • 身份证号:保留前3位+后4位,中间用*代替(如110**********1234),日志中禁止出现完整18位;
  • 手机号/固话:保留前3位+后4位(如138****1234),国际号码需保留国家码(如+86****1234);
  • 银行卡号:仅记录发卡行+后4位(如ICBC-****5678),禁止记录BIN段或完整卡号;
  • 密码、密钥、Token、JWT载荷:任何环境日志中均不得出现明文,连“***”都不建议打,可记录“[REDACTED: password]”或直接省略;
  • 姓名、地址、邮箱:非必要不记录;若必须记录(如投诉工单日志),采用泛化方式,如“用户[张*]”、“地址[北京市朝*区]”、“邮箱[user_***@domain.com]”。

三、技术落地要点

规范要能跑在代码里,不是贴在墙上:

  • 统一使用 SLF4J + Logback(或 Log4j2),禁止直接调用底层实现类(如LoggerFactory.getLogger() 可,new ConsoleAppender() 不可);
  • 自定义日志工具类封装脱敏逻辑,例如LogUtil.info("下单完成", Map.of("uid", maskUserId(uid), "orderId", orderId));
  • 在 MDC(Mapped Diagnostic Context)中注入 traceId、userId(脱敏后)、ip(匿名化,如192.168.1.*),确保跨线程/异步日志可追溯;
  • 配置 logback-spring.xml 时,禁用 console 输出到生产环境,启用异步 Appender + 滚动策略(timeBased + sizeBased),并设置 maxHistory=30;
  • 静态代码扫描(如 SonarQube)加入规则:拦截含“password”、“idCard”、“phone”等关键字的字符串拼接日志语句。

四、协同与演进机制

规范的生命力在于持续对齐:

  • 新接口上线前,由开发填写《日志影响评估表》,说明记录字段、脱敏方式、日志级别、留存周期;
  • 安全团队每季度抽样审计日志文件(尤其是 ERROR 和 WARN),检查脱敏覆盖率与 traceId 完整性;
  • 将典型误打案例(如打印了Map.toString()导致泄露token)纳入新人培训题库;
  • 当引入新中间件(如 Dubbo、Feign、RocketMQ)时,同步更新日志采集点清单,明确哪些框架日志需重定向或过滤。

一份好的日志规范,是写给未来自己和同事看的“系统旁白”。它不追求完美,但必须清晰、可执行、可验证。

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

相关文章

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

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

下载

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

相关专题

更多
java
java

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

2023.06.15

10837

6

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

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

2023.07.05

7962

9

java自学难吗
java自学难吗

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

2023.07.31

6912

8

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

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

2023.08.01

1164

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1416

5

java有什么用
java有什么用

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

2023.08.02

2849

5

java在线网站
java在线网站

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

2023.08.03

20151

3

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

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

2023.08.03

1255

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习