Spring Boot 怎么通过自定义注解实现 REST 接口的操作审计日志记录

夜敏姑娘_1926

夜敏姑娘_1926

2026-09-20

692人浏览

原创

spring boot通过自定义@auditlog注解与aop实现无侵入式rest接口操作审计日志,支持动态表达式、条件触发、异步落库及敏感脱敏,一行注解即可记录操作人、时间、接口、参数、结果等全链路信息。

spring boot 怎么通过自定义注解实现 rest 接口的操作审计日志记录

Spring Boot 通过自定义注解 + AOP 实现 REST 接口操作审计日志,核心是“声明即生效”——业务方法上加一个注解,就能自动记录谁、在什么时候、调了什么接口、传了什么参数、做了什么操作。不改原有逻辑,也不侵入 Controller 层。

定义审计日志注解 @AuditLog

注解需支持灵活表达语义,关键字段包括:

  • name:日志标题,如“修改用户资料”“创建订单”,建议用中文可读性强的描述
  • type:操作类型,如 CREATE / UPDATE / DELETE / QUERY,用于分类检索和权限审计
  • operator:操作人标识,支持 SpEL 表达式,例如 #user.id#auth.userId,从方法参数或 SecurityContext 中取值
  • content:动态内容模板,如 "用户#{user.name}将状态由#{before.status}改为#{after.status}",便于比对变更
  • condition:触发条件,比如 !#result.success#user.role == 'ADMIN',满足才记录
  • recordReturnValue:默认 false,避免查询接口返回大列表导致 OOM;敏感或高频接口建议关闭

编写环绕通知切面(@Around)

使用 @Aspect + @Around 捕获方法执行全过程,确保能拿到入参、返回值、异常和耗时:

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • 进入前:解析注解属性、提取 operator 和 content 中的 SpEL 表达式、记录开始时间、存入 ThreadLocal 防止异步丢失上下文
  • 执行中:调用 joinPoint.proceed(),捕获返回值或异常
  • 结束后:组装审计实体,包含请求路径、HTTP 方法、IP、User-Agent、参数摘要、返回状态、耗时、操作人等
  • 异步落库:用线程池提交日志写入任务,避免阻塞主流程;推荐用 ApplicationEventPublisher 发布审计事件,由监听器处理存储

对接真实上下文与数据源

审计日志要真正可用,得连得上系统身份和持久化能力:

  • 用户信息获取:从 Spring Security 的 SecurityContextHolder.getContext().getAuthentication() 提取 principal;若用 JWT,也可从 HttpServletRequest 解析 token 获取 uid
  • 请求元数据:通过 RequestContextHolder.getRequestAttributes() 拿到 request,再提取 client IP(注意代理转发场景,用 X-Forwarded-For)、URI、method、header 等
  • 日志存储:建议存入独立 audit_log 表,字段至少含 id、biz_id(业务主键)、operator_id、operator_name、biz_type、content、extra(JSON 存完整参数/返回体)、status(SUCCESS/FAIL)、cost_ms、create_time
  • 敏感脱敏:在序列化参数前,对手机号、身份证、密码等字段做自动掩码,例如用正则替换或白名单字段过滤

实际使用示例

Controller 方法只需一行注解,即可启用全链路审计:

@PutMapping("/users/{id}")
@AuditLog(
  name = "更新用户基本信息",
  type = "UPDATE",
  operator = "#auth.principal.username",
  content = "将用户#{user.name}的邮箱由#{before.email}更新为#{user.email}",
  condition = "#user.email != null"
)
public Result updateUserInfo(@PathVariable Long id, @RequestBody User user, Authentication auth) {
  // 业务逻辑
  return Result.ok();
}

该调用会自动生成一条结构化日志,含操作人、变更前/后字段、耗时、是否成功等,便于后续排查、合规审查或行为分析。

相关文章

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

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

下载

相关标签:

java spring boot

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

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2091

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

377

25

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.05

511

5

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

2023.10.12

1395

7

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

2025.08.19

3886

10

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

2025.12.22

416

5

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

2025.12.24

580

18

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

2026.02.11

345

24

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

2026.02.12

311

18

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习