Spring Boot 接口请求日志（基于AOP和自定义注解）

news2025/1/12 16:07:41

一、需求

在Spring Boot应用中，实现接口请求日志记录功能，要求能够记录包括请求方法、接口路径及请求参数等核心信息，并提供灵活的开关配置。

二、方案概述

采用AOP（面向切面编程）结合自定义注解的方式实现。

具体步骤如下：

  1. 创建自定义注解@ApiLog，标记需要记录日志的接口。
  2. 通过AOP实现一个切面，对被@ApiLog注解修饰的方法进行前置处理，记录其请求相关信息。
  3. 提供配置项开关，控制是否开启接口日志记录。
  4. 推荐使用消息队列（例如RocketMQ）异步处理接口日志，以提升性能，但本示例仅展示简单的日志打印。使用消息队列的方法是：将接口的请求日志发送到消息队列里，由专门的日志记录服务器去处理，比如写入专门的数据库。这样可以减少接口的同步处理的时间，避免客户端等待时间过长，提升总体性能。

三、核心代码

自定义注解：@ApiLog

package com.example.core.log.annotation;

import java.lang.annotation.*;

/**
 * 接口日志注解
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ApiLog {
}

切面类：ApiLogAspect

package com.example.core.log.aspect;

import com.example.core.property.BaseFrameworkConfigProperties;
import com.example.core.util.JsonUtil;
import io.swagger.v3.oas.annotations.Operation;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.annotation.Order;
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 javax.servlet.http.HttpServletResponse;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

@Slf4j
@Aspect
@Order(20)
@Component
public class ApiLogAspect {

    @Value("${spring.application.name:}")
    private String applicationName;

    private final BaseFrameworkConfigProperties properties;

    public ApiLogAspect(BaseFrameworkConfigProperties properties) {
        this.properties = properties;
    }

    // 定义一个切点：所有被 ApiLog 注解修饰的方法会织入advice
    @Pointcut("@annotation(com.example.core.log.annotation.ApiLog)")
    private void pointcut() {
    }

    // Before表示 advice() 将在目标方法执行前执行
    @Before("pointcut()")
    public void advice(JoinPoint joinPoint) {

        if (!properties.getApiLog().isEnabled()) {
            return;
        }

        log.info("\n-------------------- 接口日志，开始 --------------------");

        log.info("applicationName：{}", applicationName);

        // 获取请求信息
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes != null) {
            HttpServletRequest request = attributes.getRequest();

            // 用户IP
            String clientIp = request.getRemoteAddr();
            log.info("clientIp：{}", clientIp);

            // URL
            String requestURL = request.getRequestURL().toString();
            log.info("url：{}", requestURL);

            // 请求方法
            String requestMethod = request.getMethod();
            log.info("requestMethod：{}", requestMethod);

            // 接口路径
            String path = request.getServletPath();
            log.info("path：{}", path);
        }

        // 控制器方法参数列表
        Object[] args = joinPoint.getArgs();
        // 获取有效的控制器方法参数列表
        List<Object> validArgs = getValidArguments(args);
        log.info("args：{}", JsonUtil.toJson(validArgs));

        // 方法签名
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        log.info("methodSignature：{}", methodSignature);

        // 方法参数名称列表
        String[] parameterNames = methodSignature.getParameterNames();
        log.info("parameterNames：{}", JsonUtil.toJson(parameterNames));

        // 获取接口的注解
        Operation operation = methodSignature.getMethod().getAnnotation(Operation.class);
        if (operation != null) {
            // 接口概述
            String summary = operation.summary();
            log.info("summary：{}", summary);

            // 接口描述
            String description = operation.description();
            log.info("description：{}", description);
        }

        log.info("\n-------------------- 接口日志，结束 --------------------\n");
    }

    /**
     * 获取有效的控制器方法参数列表
     * <p>
     * 排除 HttpServletRequest 和 HttpServletResponse 参数。
     * <p>
     * HttpServletRequest 参数，会阻塞线程，抛出异常 NestedServletException-OutOfMemoryError。
     * <p>
     * HttpServletResponse 参数，会抛出异常 NestedServletException-StackOverflowError。
     */
    private List<Object> getValidArguments(Object[] args) {
        return Stream.of(args).filter(this::isValidArgument).collect(Collectors.toList());
    }

    private Boolean isValidArgument(Object arg) {
        return isNotHttpServletRequest(arg) && isNotHttpServletResponse(arg);
    }

    /**
     * 不是 HttpServletRequest
     * <p>
     * HttpServletRequest 参数，会阻塞线程，会抛出如下异常：
     * org.springframework.web.util.NestedServletException:
     * Handler dispatch failed; nested exception is java.lang.OutOfMemoryError: Java heap space
     */
    private Boolean isNotHttpServletRequest(Object arg) {
        return !(arg instanceof HttpServletRequest);
    }

    /**
     * 不是 HttpServletResponse
     * <p>
     * HttpServletResponse 参数，会抛出如下异常：
     * org.springframework.web.util.NestedServletException:
     * Handler dispatch failed; nested exception is java.lang.StackOverflowError
     */
    private Boolean isNotHttpServletResponse(Object arg) {
        return !(arg instanceof HttpServletResponse);
    }

}

日志开关配置

配置类：BaseFrameworkConfigProperties


package com.example.core.property;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;


/**
 * BaseFramework 配置文件
 *
 * @author songguanxun
 * 2019/08/27 15:40
 * @since 1.0.0
 */
@Data
@Component
@ConfigurationProperties(prefix = "base-framework")
public class BaseFrameworkConfigProperties {

    /**
     * 接口日志配置
     */
    private ApiLog apiLog = new ApiLog();

    /**
     * 接口日志配置
     */
    @Data
    public static class ApiLog {

        /**
         * 是否开启接口日志
         */
        private boolean enabled = false;

    }

}

配置文件：application.yml

# 自定义配置
base-framework:
  api-log:
    enabled: false

四、测试案例一：查询用户列表

4.1 测试代码

package com.example.web.user.controller;

import com.example.core.log.annotation.ApiLog;
import com.example.core.model.PageQuery;
import com.example.web.model.query.UserQuery;
import com.example.web.model.vo.UserVO;
import com.example.web.user.service.UserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;
import java.util.List;

@Slf4j
@RestController
@RequestMapping("users")
@Tag(name = "用户管理")
public class UserController {

    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @ApiLog
    @GetMapping
    @Operation(summary = "查询用户列表", description = "支持通过”姓名“和”手机号码“筛选用户")
    public List<UserVO> listUsers(@Valid UserQuery userQuery, PageQuery pageQuery) {
        log.info("查询用户列表。userQuery={}，pageQuery={}", userQuery, pageQuery);
        return userService.listUsers(userQuery);
    }

}


package com.example.web.model.query;

import com.example.core.constant.RegexConstant;
import com.example.core.validation.phone.query.MobilePhoneQuery;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import org.springdoc.api.annotations.ParameterObject;

@Data
@ParameterObject
@Schema(name = "用户Query")
public class UserQuery {

    @Schema(description = "姓名", example = "张三")
    private String name;

    @MobilePhoneQuery
    @Schema(description = "手机号码", example = "18612345678", pattern = RegexConstant.NUMBERS, maxLength = 11)
    private String mobilePhone;

}


package com.example.core.model;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.experimental.FieldNameConstants;
import org.springdoc.api.annotations.ParameterObject;

@Data
@FieldNameConstants
@ParameterObject
@Schema(name = "分页参数Query")
public class PageQuery {

    @Schema(description = "当前页码", type = "Integer", defaultValue = "1", example = "1", minimum = "1")
    private Integer pageNumber = 1;

    @Schema(description = "每 1 页的数据量", type = "Integer", defaultValue = "10", example = "10", minimum = "1", maximum = "100")
    private Integer pageSize = 10;

}

4.2 接口调用效果

在这里插入图片描述

4.3 控制台日志

在这里插入图片描述

五、排除HttpServletRequest和HttpServletResponse参数

测试 HttpServletRequest、HttpServletResponse 和 HttpSession，是否在接口日志处理时堵塞线程或抛出异常？

5.1 原因

获取有效的控制器方法参数列表时，需要排除 HttpServletRequest 和 HttpServletResponse 参数。原因如下：

  1. 打印 HttpServletRequest 参数，会阻塞线程，抛出异常 NestedServletException-OutOfMemoryError。
  2. 打印 HttpServletResponse 参数，会抛出异常 NestedServletException-StackOverflowError。

HttpSession能够正常获取并打印日志，不需要特殊处理。

5.2 核心代码示例

下面图片中圈中的部分，就是排除HttpServletRequest和HttpServletResponse参数的核心代码。
在这里插入图片描述

5.3 测试代码

package com.example.web.api.log.controller;

import com.example.core.log.annotation.ApiLog;
import com.example.core.model.PageQuery;
import com.example.web.model.query.UserQuery;
import com.example.web.model.vo.UserVO;
import com.example.web.user.service.UserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.validation.Valid;
import java.util.List;

@Slf4j
@RestController
@RequestMapping("/api/log")
@Tag(name = "接口日志")
public class ApiLogController {

    private final UserService userService;

    public ApiLogController(UserService userService) {
        this.userService = userService;
    }

    @ApiLog
    @GetMapping(path = "users")
    @Operation(summary = "查询用户列表", description = "测试 HttpServletRequest、HttpServletResponse 和 HttpSession，是否在接口日志处理时堵塞线程或抛出异常")
    public List<UserVO> listUsers(@Valid UserQuery userQuery, PageQuery pageQuery,
                                  HttpServletRequest request, HttpServletResponse response, HttpSession session) {
        log.info("查询用户列表。userQuery={}，pageQuery={}", userQuery, pageQuery);
        return userService.listUsers(userQuery);
    }

}

5.4 正常调用效果

在这里插入图片描述

5.5 打印HttpServletRequest参数，会阻塞线程，抛出异常

测试不排除控制器方法中的HttpServletRequest参数，直接打印的效果

打印HttpServletRequest 参数，会阻塞线程很长一段时间，大约几十秒，然后会抛出如下异常：

org.springframework.web.util.NestedServletException: Handler dispatch failed; nested exception is java.lang.OutOfMemoryError: Java heap space

接口阻塞

在这里插入图片描述

抛出异常NestedServletException-OutOfMemoryError

在这里插入图片描述

接口响应

异常统一处理后，响应给前端，耗时50多秒。

在这里插入图片描述

5.6 打印HttpServletResponse参数，会抛出异常

测试不排除控制器方法中的HttpServletResponse参数，直接打印的效果

打印 HttpServletResponse 参数，会抛出如下异常：

org.springframework.web.util.NestedServletException: Handler dispatch failed; nested exception is java.lang.StackOverflowError

抛出异常NestedServletException-StackOverflowError

在这里插入图片描述

接口响应

异常统一处理后，响应给前端。
在这里插入图片描述

六、总结

本文实现了基于Spring Boot的接口请求日志记录方案，通过AOP与自定义注解相结合，为指定接口提供了灵活的日志记录能力，并通过配置项支持日志记录的开启与关闭，优化了系统性能。实际生产环境中，建议采用异步方式（如消息队列）处理接口日志。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1471248.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

1904_ARM Cortex M系列芯片特性小结

1904_ARM Cortex M系列芯片特性小结

1904_ARM Cortex M系列芯片特性小结 全部学习汇总&#xff1a; g_arm_cores: ARM内核的学习笔记 (gitee.com) ARM Cortex M系列的MCU用过好几款了&#xff0c;也涉及到了不同的内核。不过&#xff0c;关于这些内核的基本的特性还是有些不了解。从ARM的官方网站上找来了一个对比…
阅读更多...
《游戏引擎架构》 -- 学习4

《游戏引擎架构》 -- 学习4

资源及文件系统 文件系统 游戏引擎的文件系统API通常提供以下功能&#xff1a; 搜需路径&#xff1a;是含一串路径的字符串&#xff0c;各路径之间以特殊字符&#xff08;如冒号或分号&#xff09;分隔&#xff0c;找文件时就会从这些路径进行搜寻。例如在命令行下执行程序&a…
阅读更多...
2023年06月CCF-GESP编程能力等级认证Scratch编程一级真题解析

2023年06月CCF-GESP编程能力等级认证Scratch编程一级真题解析

一、单选题&#xff08;共10题&#xff0c;共30分&#xff09; 第1题 以下不属于计算机输出设备的有&#xff08; &#xff09;。 A&#xff1a;麦克风 B&#xff1a;音箱 C&#xff1a;打印机 D&#xff1a;显示器 答案&#xff1a;A 第2题 点击下面哪个图标可以使舞台区…
阅读更多...
真香！NineData SQL开发全面适配 GaiaDB

真香！NineData SQL开发全面适配 GaiaDB

2 月&#xff0c;新年伊始&#xff0c;NineData 重磅发布&#xff0c;提供了对百度云原生关系型数据库 GaiaDB 的支持。 这一次的发布不仅仅是简单的数据源支持&#xff0c;而是覆盖了整个 SQL 开发能力的重要发布&#xff0c;意味着您已经可以完整地使用 NineData SQL 开发的…
阅读更多...
Redis高并发分布锁实战

Redis高并发分布锁实战

Redis高并发分布锁实战 问题场景 场景一: 没有捕获异常 // 仅仅加锁 // 读取 stock15 Boolean ret stringRedisTemplate.opsForValue().setIfAbsent("lock_key", "1"); // jedis.setnx(k,v) // TODO 业务代码 stock-- stringRedisTemplate.delete(&quo…
阅读更多...
AI时代 编程高手的秘密武器：世界顶级大学推荐的计算机教材

AI时代 编程高手的秘密武器：世界顶级大学推荐的计算机教材

文章目录 01 《深入理解计算机系统》02 《算法导论》03 《计算机程序的构造和解释》04 《数据库系统概念》05 《计算机组成与设计&#xff1a;硬件/软件接口》06 《离散数学及其应用》07 《组合数学》08《斯坦福算法博弈论二十讲》 清华、北大、MIT、CMU、斯坦福的学霸们在新学…
阅读更多...
MySQL篇—持久化和非持久化统计信息介绍（第一篇，总共三篇）

MySQL篇—持久化和非持久化统计信息介绍（第一篇，总共三篇）

☘️博主介绍☘️&#xff1a; ✨又是一天没白过&#xff0c;我是奈斯&#xff0c;DBA一名✨ ✌✌️擅长Oracle、MySQL、SQLserver、Linux&#xff0c;也在积极的扩展IT方向的其他知识面✌✌️ ❣️❣️❣️大佬们都喜欢静静的看文章&#xff0c;并且也会默默的点赞收藏加关注❣…
阅读更多...
Spring事务模板及afterCommit存在的坑

Spring事务模板及afterCommit存在的坑

大家好&#xff0c;我是墨哥&#xff08;隐墨星辰&#xff09;。今天的内容来源于两个线上问题&#xff0c;主要和大家聊聊为什么支付系统中基本只使用事务模板方法&#xff0c;而不使用声明式事务Transaction注解&#xff0c;以及使用afterCommit()出现连接未按预期释放导致的…
阅读更多...
科技云报道：黑马Groq单挑英伟达，AI芯片要变天？

科技云报道：黑马Groq单挑英伟达，AI芯片要变天？

科技云报道原创。 近一周来&#xff0c;大模型领域重磅产品接连推出&#xff1a;OpenAI发布“文字生视频”大模型Sora&#xff1b;Meta发布视频预测大模型 V-JEPA&#xff1b;谷歌发布大模型 Gemini 1.5 Pro&#xff0c;更毫无预兆地发布了开源模型Gemma… 难怪网友们感叹&am…
阅读更多...
不可错过的Telegram神器：十个实用Telegram机器人介绍

不可错过的Telegram神器：十个实用Telegram机器人介绍

Telegram机器人是基于Telegram平台上的自动化程序&#xff0c;通过Telegram Bot API来与用户交互&#xff0c;执行各种任务&#xff0c;大大拓宽了Telegram这个软件的功能。不只是可以进行简单的自动化任务如提醒服务、天气预报、个人助理&#xff0c;也可以完成复杂的商业行为…
阅读更多...
SpringBoot自带的tomcat的最大连接数和最大的并发数

SpringBoot自带的tomcat的最大连接数和最大的并发数

先说结果&#xff1a;springboot自带的tomcat的最大并发数是200&#xff0c; 最大连接数是&#xff1a;max-connectionsaccept-count的值 再说一下和连接数相关的几个配置&#xff1a; 以下都是默认值&#xff1a; server.tomcat.threads.min-spare10 server.tomcat.threa…
阅读更多...
基于Pytorch的猫狗图片分类【深度学习CNN】

基于Pytorch的猫狗图片分类【深度学习CNN】

猫狗分类来源于Kaggle上的一个入门竞赛——Dogs vs Cats。为了加深对CNN的理解&#xff0c;基于Pytorch复现了LeNet,AlexNet,ResNet等经典CNN模型&#xff0c;源代码放在GitHub上&#xff0c;地址传送点击此处。项目大纲如下&#xff1a; 文章目录 一、问题描述二、数据集处理…
阅读更多...
【Vue3】学习watch监视：深入了解Vue3响应式系统的核心功能（上）

【Vue3】学习watch监视：深入了解Vue3响应式系统的核心功能（上）

&#x1f497;&#x1f497;&#x1f497;欢迎来到我的博客&#xff0c;你将找到有关如何使用技术解决问题的文章&#xff0c;也会找到某个技术的学习路线。无论你是何种职业&#xff0c;我都希望我的博客对你有所帮助。最后不要忘记订阅我的博客以获取最新文章&#xff0c;也欢…
阅读更多...
Linux基础命令—进程管理

Linux基础命令—进程管理

基础知识 linux进程管理 什么是进程 开发写代码->代码运行起来->进程 运行起来的程序叫做进程程序与进程区别 1.程序是一个静态的概念,主要是指令集和数据的结合,可以长期存放在操作系统中 2.进程是一个动态的概念,主要是程序的运行状态,进程存在生命周期,生命周期结…
阅读更多...
nginx.conf配置文件详解、案例，Nginx常用命令与模块

nginx.conf配置文件详解、案例，Nginx常用命令与模块

目录 一、Nginx常用命令 二、Nginx涉及的文件 2.1、Nginx 的默认文件夹 2.2、Nginx的主配置文件nginx.conf nginx.conf 配置的模块 2.2.1、全局块&#xff1a;全局配置&#xff0c;对全局生效 2.2.2、events块&#xff1a;配置影响 Nginx 服务器与用户的网络连接 2.2.3…
阅读更多...
docker 容器访问 GPU 资源使用指南

docker 容器访问 GPU 资源使用指南

概述 nvidia-docker 和 nvidia-container-runtime 是用于在 NVIDIA GPU 上运行 Docker 容器的两个相关工具。它们的作用是提供 Docker 容器与 GPU 加速硬件的集成支持&#xff0c;使容器中的应用程序能够充分利用 GPU 资源。 nvidia-docker 为了提高 Nvidia GPU 在 docker 中的…
阅读更多...
Python爬虫-爬取豆瓣高分电影封面

Python爬虫-爬取豆瓣高分电影封面

本文是本人最近学习Python爬虫所做的小练习。如有侵权&#xff0c;请联系删除。 页面获取url 代码 import requests import os import re# 创建文件夹 path os.getcwd() /images if not os.path.exists(path):os.mkdir(path)# 获取全部数据 def get_data():# 地址url "…
阅读更多...
输电线路微波覆冰监测装置助力电网应对新一轮寒潮

输电线路微波覆冰监测装置助力电网应对新一轮寒潮

2月19日起&#xff0c;湖南迎来新一轮寒潮雨雪冰冻天气。为做好安全可靠的供电准备&#xff0c;国网国网湘潭供电公司迅速启动雨雪、覆冰预警应急响应&#xff0c;采取“人巡机巡可视化巡视”的方式&#xff0c;对输电线路实施三维立体巡检。该公司组织员工对1324套通道可视化装…
阅读更多...
leetcode hot100 买卖股票的最佳时机二

leetcode hot100 买卖股票的最佳时机二

注意&#xff0c;本题是针对股票可以进行多次交易&#xff0c;但是下次买入的时候必须保证上次买入的已经卖出才可以。 动态规划可以解决整个股票买卖系列问题。 dp数组含义&#xff1a; dp[i][0]表示第i天不持有股票的最大现金 dp[i][1]表示第i天持有股票的最大现金 递归公…
阅读更多...
全面InfiniBand解决方案——LLM培训瓶颈问题

全面InfiniBand解决方案——LLM培训瓶颈问题

ChatGPT对技术的影响引发了对人工智能未来的预测&#xff0c;尤其是多模态技术的关注。OpenAI推出了具有突破性的多模态模型GPT-4&#xff0c;使各个领域取得了显著的发展。 这些AI进步是通过大规模模型训练实现的&#xff0c;这需要大量的计算资源和高速数据传输网络。端到端…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023