Java 中怎么使用 Spring AOP 记录接口访问日志

大芳君_1911

大芳君_1911

2026-10-12

911人浏览

原创

spring aop记录接口日志的核心是通过@aspect切面拦截controller层public方法,精准定义切入点、安全序列化参数与响应、脱敏敏感字段,并控制日志粒度以保障性能。

java 中怎么使用 spring aop 记录接口访问日志

在 Spring 项目中,用 AOP 记录接口访问日志,核心是通过切面(@Aspect)拦截控制器方法(如 @GetMapping、@PostMapping),在执行前后获取请求信息、参数、响应结果和耗时。关键在于精准定义切入点(Pointcut)、合理处理参数与异常,并避免敏感数据泄露。

定义切入点:只拦截 Controller 层的公开接口

使用 @Pointcut 匹配所有 @RestController 或 @Controller 中的 public 方法,推荐按注解匹配更清晰:

  • 写法示例:@Pointcut("@within(org.springframework.web.bind.annotation.RestController) || @within(org.springframework.web.bind.annotation.Controller)")
  • 再组合方法级注解(如 @GetMapping)可进一步缩小范围:@Pointcut("execution(* com.example..*Controller.*(..)) && @annotation(org.springframework.web.bind.annotation.RequestMapping) || @annotation(org.springframework.web.bind.annotation.GetMapping) || ...")
  • 实际开发中建议统一用包路径 + 注解方式,例如:@Pointcut("execution(* com.example.web..*.*(..)) && @annotation(org.springframework.web.bind.annotation.RequestMapping)")

记录请求基本信息:时间、URI、HTTP 方法、IP 和用户标识

在 @Before 增强中,从 RequestContextHolder 获取当前请求上下文:

java-enterprise
java-enterprise

Java企业开发专家,专注于Spring Boot、微服务架构和JVM优化。适用于:Java语言掌握、

下载
  • 用 HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
  • 提取 request.getRequestURL().toString()、request.getMethod()、request.getRemoteAddr()
  • 若已集成登录(如 Spring Security),可通过 SecurityContextHolder.getContext().getAuthentication().getName() 获取当前用户名
  • 注意:不要直接打印完整请求体(如 JSON body),避免日志污染或泄露密码等敏感字段

记录参数与响应:安全地序列化非敏感内容

用 @Around 拦截整个方法执行流程,捕获入参、返回值和异常:

  • 入参建议用 JSON.toJSONString(args, SerializerFeature.WriteMapNullValue)(FastJSON)或 ObjectMapper.writeValueAsString()(Jackson)转为字符串,但先过滤掉含 password、token、auth 等字段的对象
  • 响应结果可在 proceed() 后获取,同样做脱敏处理;若返回值是 ResponseEntity 或自定义封装类(如 Result<t></t>),需解析其 data 字段再记录
  • 捕获异常时,记录 throwable.getMessage() 即可,避免打印完整堆栈到业务日志(堆栈应进 error 日志文件)

控制日志粒度与性能:避免过度记录

AOP 日志容易成为性能瓶颈,尤其高频接口:

  • 对 GET 查询类接口,可只记录 URI、参数摘要(如分页参数 page=1&size=20)、耗时和状态码
  • 对 POST/PUT 接口,才记录入参摘要和返回摘要;大文件上传、流式响应等场景建议跳过参数记录
  • 使用 SLF4J 的 isDebugEnabled() 判断是否开启 debug 日志,避免无意义字符串拼接
  • 考虑异步写日志(如 Logback 的 AsyncAppender),防止阻塞主线程

只要切点准确、参数脱敏到位、日志分级合理,Spring AOP 记录接口日志既轻量又实用,不需要额外引入链路追踪框架也能满足基础审计和问题排查需求。

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

相关文章

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

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

下载

相关标签:

java java接口 java爬虫

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

相关专题

更多
java
java

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

2023.06.15

10397

6

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

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

2023.07.05

7542

9

java自学难吗
java自学难吗

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

2023.07.31

6592

8

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

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

2023.08.01

1124

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1376

5

java有什么用
java有什么用

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

2023.08.02

2749

5

java在线网站
java在线网站

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

2023.08.03

20051

3

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

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

2023.08.03

1215

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习