Spring Boot REST接口开发怎么记录接口请求日志

老萱小哥_7493

老萱小哥_7493

2026-11-16

268人浏览

原创

在spring boot中记录rest接口请求日志,最直接且标准的方法是使用aop(面向切面编程)结合自定义注解或全局拦截器。通过定义一个切面类,拦截所有被`@restcontroller`标记的控制器方法,可以在请求进入和返回时自动提取http方法、url、参数、耗时及响应状态,并统一输出到日志文件中。这种方式解耦了业务代码与日志逻辑,无需在每个controller方法中手动编写日志打印语句。

Spring Boot REST接口开发怎么记录接口请求日志

如何配置AOP切面以捕获Controller层的输入输出

要实现这一功能,需要引入Spring AOP依赖,并创建一个切面类。在该类中使用`@Around`注解包裹目标方法,利用`ProceedingJoinPoint`获取方法签名、参数以及执行结果。对于GET请求,参数通常位于查询字符串中;对于POST/PUT请求,参数可能位于请求体中。通过反射或工具类解析这些参数,并结合`StopWatch`或时间戳计算执行耗时,即可构建完整的日志条目。关键在于处理异常,确保即使接口报错也能记录错误信息。

Spring Boot REST接口开发怎么记录接口请求日志

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;

@Aspect
@Component
public class ControllerLogAspect {

    private static final Logger logger = LoggerFactory.getLogger(ControllerLogAspect.class);

    @Around("execution(* com.example.demo.controller..*(..))")
    public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        String method = request.getMethod();
        String uri = request.getRequestURI();
        long start = System.currentTimeMillis();

        logger.info("Start: {} {} | Params: {}", method, uri, Arrays.toString(joinPoint.getArgs()));

        try {
            Object result = joinPoint.proceed();
            long duration = System.currentTimeMillis() - start;
            logger.info("End: {} {} | Duration: {}ms | Result: {}", method, uri, duration, result);
            return result;
        } catch (Throwable e) {
            long duration = System.currentTimeMillis() - start;
            logger.error("Error: {} {} | Duration: {}ms | Exception: {}", method, uri, duration, e.getMessage());
            throw e;
        }
    }
}

如何处理敏感数据脱敏与日志格式标准化

在实际生产环境中,直接记录原始请求参数可能导致密码、Token等敏感信息泄露。因此,需要在切面中对特定字段进行脱敏处理,例如将密码替换为`******`。同时,为了便于ELK等日志系统解析,建议将日志输出格式化为JSON结构。可以通过实现`JsonLayout`或使用`logback-spring.xml`配置PatternLayout来实现。此外,对于大体积的请求体,应设置阈值限制,避免日志文件过大影响性能。通过自定义`HttpServletRequestWrapper`可以缓存请求体内容,以便多次读取而不破坏流机制。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

Spring Boot REST接口开发怎么记录接口请求日志

import com.fasterxml.jackson.databind.ObjectMapper;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;

@Aspect
@Component
public class SensitiveDataLogAspect {

    private static final Logger logger = LoggerFactory.getLogger(SensitiveDataLogAspect.class);
    private static final ObjectMapper mapper = new ObjectMapper();

    @Around("execution(* com.example.demo.controller..*(..))")
    public Object logWithMasking(ProceedingJoinPoint joinPoint) throws Throwable {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        Map<string object> logData = new HashMap();
        logData.put("method", request.getMethod());
        logData.put("uri", request.getRequestURI());
        
        // 简单脱敏示例:如果参数包含password,则隐藏
        Object[] args = joinPoint.getArgs();
        for (Object arg : args) {
            if (arg instanceof String && arg.toString().contains("password")) {
                logData.put("maskedParam", "******");
            } else {
                logData.put("param", arg);
            }
        }

        logger.info("Request Log: {}", mapper.writeValueAsString(logData));
        return joinPoint.proceed();
    }
}</string>

基于程序中某个输入、条件或结果的具体问题

当请求体较大或包含嵌套对象时,直接调用`joinPoint.getArgs()`可能会因为序列化开销导致性能下降,或者在某些情况下无法正确获取已消费过的InputStream。此时,若需记录详细的JSON Body,必须使用`ContentCachingRequestWrapper`包装原始请求,并在Filter阶段缓存Body内容。否则,在切面中尝试读取Body会导致后续Controller无法读取,引发“Stream closed”或空指针异常。通过在WebConfig中注册该Filter,可以确保日志记录不干扰正常业务流程,同时准确捕获复杂JSON结构的输入。

相关文章

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

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

下载

相关标签:

spring boot

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

相关专题

更多
spring boot框架优点
spring boot框架优点

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

2023.09.05

731

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

1455

7

Java Spring Boot开发
Java Spring Boot开发

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

2025.08.19

5866

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

436

5

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

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

2025.12.24

680

18

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

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

2026.02.11

425

24

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

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

2026.02.12

391

18

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

2026.04.17

366

21

Java Spring Boot多租户架构设计与数据隔离实战
Java Spring Boot多租户架构设计与数据隔离实战

本专题聚焦 Java 企业级系统中的多租户架构设计,讲解数据隔离策略、租户路由机制、数据库分库分表方案以及权限控制模型。通过真实 SaaS 系统案例,帮助开发者构建可扩展的多租户应用架构。

2026.06.29

616

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习