Java记录流水服务拦截器开发教程

在Java Web开发中，记录流水服务（如请求日志、操作日志）是常见的需求，用于问题排查、安全审计、性能分析等。拦截器（Interceptor）是实现这一需求的核心组件，主要分为Servlet Filter（请求级拦截）和Spring AOP（方法级拦截）两类，分别适用于不同的场景。本教程将详细介绍这两类拦截器的开发步骤，并提供完整的代码示例。

一、前置知识

1. 拦截器的核心作用：在请求处理流程的关键节点（如请求前、请求后、异常时）插入自定义逻辑（如记录日志、权限检查）。

2. Servlet Filter：属于Java EE标准，用于拦截HTTP请求，可获取请求的URL、IP、参数等基础信息，适用于全局请求日志。

3. Spring AOP：属于Spring框架，用于拦截方法调用，可获取方法参数、返回值、注解等详细信息，适用于业务方法级流水（如订单支付、用户注册）。

二、开发环境准备

• JDK 1.8+：支持Servlet 3.0及以上版本。

• Spring Boot 2.7+：简化配置，内置Tomcat服务器。

• Maven：依赖管理工具。

• Lombok：简化实体类和日志类的代码（可选，但推荐）。

三、实现步骤

（一）使用Servlet Filter实现全局请求流水

Servlet Filter是Java EE标准组件，用于拦截所有进入应用的HTTP请求，适合记录全局请求日志（如请求URL、IP、耗时、响应状态等）。

1. 添加依赖

在pom.xml中添加Servlet API依赖（Spring Boot已内置，无需额外添加）：

<!-- Spring Boot Web依赖（包含Servlet API） -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2. 创建Filter类

实现javax.servlet.Filter接口，重写doFilter方法，在请求前后记录日志：

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.util.StopWatch;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**
 * 全局请求日志拦截器（Servlet Filter）
 * 拦截所有HTTP请求，记录请求URL、IP、耗时、响应状态等信息
 */
@Slf4j
@Component
@WebFilter(filterName = "requestLogFilter", urlPatterns = "/*") // 拦截所有路径
public class RequestLogFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 1. 转换为HttpServletRequest（方便获取请求信息）
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        // 2. 记录请求开始时间（用于计算耗时）
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        // 3. 获取请求基础信息
        String requestUri = httpRequest.getRequestURI();
        String queryString = httpRequest.getQueryString();
        String clientIp = getClientIp(httpRequest);
        String method = httpRequest.getMethod();
        // 4. 打印请求开始日志
        log.info("请求开始 | URI: {}?{} | IP: {} | 方法: {}", requestUri, queryString, clientIp, method);
        // 5. 执行请求（传递给下一个