Java 项目中怎么记录详细的接口出入参日志

轻墨姑娘_6254

轻墨姑娘_6254

2026-08-07

503人浏览

原创

spring aop统一拦截controller方法结合fastjson序列化,需精准控制日志粒度(自定义注解或包路径切点+redis动态开关),参数与返回值结构化序列化并脱敏,日志包含路径、ip、用户id、耗时、状态码及异常,异步落库并分级输出。

java 项目中怎么记录详细的接口出入参日志

用 Spring AOP 统一拦截 Controller 方法,结合 FastJSON 序列化参数与返回值,是最常用且低侵入的方式。关键不是“能不能记”,而是“记哪些、怎么记得清、怎么不影响性能”。

只对需要的接口记录,避免全量日志爆炸

盲目拦截所有 Controller 会导致日志量激增,尤其在高并发或含大文件上传的接口中。推荐两种控制粒度的方式:

  • 用自定义注解(如 @LogRequest)标注具体方法,精准开启日志;
  • 或按包路径切点(如 execution(* com.example.api..*Controller.*(..))),限定在对外暴露的 API 层;
  • 配合 Redis 动态开关(如 key = log:enabled:paths),运行时启停某类接口日志,无需重启服务。

参数和返回值要可读、可还原

直接打印对象引用(如 toString())没意义,必须序列化成结构化文本:

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载
  • 请求参数:从 HttpServletRequest 取 query/body 参数,用 FastJSON.toJSONString(params, SerializerFeature.WriteMapNullValue) 保留空字段;
  • 响应数据:若返回 ResponseEntity> 或自定义 Result 包装类,需反射提取 body 内容再序列化;
  • 敏感字段(如密码、身份证号)建议在序列化前脱敏,例如通过 JSONWriter 自定义 ValueFilter。

日志内容至少包含 5 个核心字段

光有参数和返回值不够,排查问题时还需上下文信息:

  • 请求路径(requestURI)+ HTTP 方法(GET/POST);
  • 客户端 IP(注意代理场景下要用 X-Forwarded-For 多级解析);
  • 登录用户 ID(从 Token 或 Session 中提取,非 request.getParameter);
  • 执行耗时(毫秒级,用 ThreadLocal 记录开始时间,@AfterReturning 中计算差值);
  • 状态码与异常堆栈(@AfterThrowing 捕获异常并记录完整 stackTrace)。

异步落库 + 日志分级,兼顾可查性与性能

同步写数据库会拖慢接口响应,尤其当日志表无索引或磁盘 I/O 紧张时:

  • 日志实体(如 RequestLog)先存入内存队列,由独立线程池异步刷入 MySQL 或写入 Elasticsearch;
  • 同时保留一份轻量级文本日志(如 logback 输出到 access.log),仅含 path、ip、status、duration,便于快速 grep;
  • 调试阶段用 DEBUG 级别输出完整出入参,生产环境调为 INFO,异常强制 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

9977

6

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

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

2023.07.05

7122

9

java自学难吗
java自学难吗

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

2023.07.31

6272

8

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

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

2023.08.01

1084

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1316

5

java有什么用
java有什么用

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

2023.08.02

2629

5

java在线网站
java在线网站

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

2023.08.03

19951

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习