Java 中 Spring MVC 怎么配置拦截器实现请求日志记录

陌磊小哥_7682

陌磊小哥_7682

2026-08-27

402人浏览

原创

spring mvc中配置日志拦截器需实现handlerinterceptor接口,在prehandle记录请求信息、aftercompletion记录响应与耗时,并通过webmvcconfigurer注册;注意requestbody只能读一次,需用contentcachingrequestwrapper包装,且应脱敏敏感字段、控制日志级别。

java 中 spring mvc 怎么配置拦截器实现请求日志记录

在 Spring MVC 中配置拦截器记录请求日志,核心是实现 HandlerInterceptor 接口,并在 preHandle 记录入参、afterCompletion 记录响应结果和耗时,再通过配置类或 XML 注册到拦截器链中。

编写日志拦截器类

创建一个实现 HandlerInterceptor 的类,重点覆盖三个方法:

  • preHandle:在 Controller 方法执行前调用,适合记录请求 URL、HTTP 方法、请求头、查询参数和请求体(注意:request body 只能读取一次,如需记录需用 ContentCachingRequestWrapper 包装)
  • postHandle:Controller 执行完但视图渲染前,可获取 ModelAndView,一般日志场景中较少使用
  • afterCompletion:整个请求结束后调用,适合记录响应状态码、耗时、异常信息(如有)

示例代码片段:

public class RequestLogInterceptor implements HandlerInterceptor {
    private static final Logger log = LoggerFactory.getLogger(RequestLogInterceptor.class);
<pre class="brush:java;toolbar:false;">@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    long startTime = System.currentTimeMillis();
    request.setAttribute("startTime", startTime);

    String uri = request.getRequestURI();
    String method = request.getMethod();
    String queryString = request.getQueryString();
    log.info("→ [{} {}{}] {}", method, uri, queryString != null ? "?" + queryString : "", getRemoteAddr(request));
    return true;
}

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    long startTime = (Long) request.getAttribute("startTime");
    long cost = System.currentTimeMillis() - startTime;
    int status = response.getStatus();
    log.info("← [{}ms {} {}]", cost, status, handler);
    if (ex != null) {
        log.error("Exception in request", ex);
    }
}

private String getRemoteAddr(HttpServletRequest request) {
    String ip = request.getHeader("X-Forwarded-For");
    if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
        ip = request.getRemoteAddr();
    }
    return ip;
}

}

注册拦截器到 Spring MVC 配置

Spring Boot 项目推荐使用配置类方式注册:

  • 继承 WebMvcConfigurer,重写 addInterceptors 方法
  • 通过 registry.addInterceptor() 添加自定义拦截器
  • 用 excludePathPatterns 排除静态资源(如 /static/**、/favicon.ico)避免干扰日志

示例配置类:

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

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

下载
@Configuration
public class WebConfig implements WebMvcConfigurer {
<pre class="brush:java;toolbar:false;">@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new RequestLogInterceptor())
            .excludePathPatterns("/static/**", "/favicon.ico", "/actuator/**");
}

}

增强请求体(RequestBody)记录能力

默认 HttpServletRequest 的 input stream 只能读取一次,直接调用 getInputStream() 会导致后续 Controller 无法解析 JSON。解决办法:

  • 在 preHandle 中将原始 request 包装为 ContentCachingRequestWrapper
  • 该包装类会缓存请求体内容,供多次读取
  • 从包装类中提取 byte[],再转成字符串(注意字符编码,推荐 UTF-8)

小提示:仅对需要记录 body 的路径启用(如 POST/PUT),避免性能开销;生产环境慎用,建议配合日志级别控制(如只在 DEBUG 级别下打印 body)。

日志输出优化建议

为避免日志爆炸或敏感信息泄露,建议:

  • 对密码、token、身份证号等字段做脱敏处理(如用 *** 替换)
  • 限制日志长度,超长内容截断并标记(如 ...[TRUNCATED])
  • 区分日志级别:请求入口用 INFO,详细参数用 DEBUG,异常用 ERROR
  • 使用 MDC(Mapped Diagnostic Context)添加 traceId,便于分布式链路追踪

不复杂但容易忽略。

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

相关专题

更多
java
java

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

2023.06.15

9097

6

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

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

2023.07.05

6282

9

java自学难吗
java自学难吗

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

2023.07.31

5612

8

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

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

2023.08.01

1004

3

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

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

2023.08.02

848

3

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

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

2023.08.02

1196

5

java有什么用
java有什么用

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

2023.08.02

2409

5

java在线网站
java在线网站

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

2023.08.03

19731

3

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

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

2023.08.03

1095

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习