Java 拦截器实战：从入门到精通（精选）

在 Java Web 开发中，拦截器是一种强大的工具，它允许开发者在请求处理的各个环节进行拦截和处理。与过滤器类似，拦截器也能够对请求和响应进行操作，但它工作在 Spring MVC 框架内部，能够访问 Spring 管理的 Bean，与 Spring 的依赖注入无缝集成。本文将通过实战案例，帮助您深入理解 Java 拦截器的应用，并掌握高效编程技巧。

一、拦截器基础概念

拦截器是 Spring MVC 框架中提供的一种机制，通过实现 HandlerInterceptor 接口或继承 HandlerInterceptorAdapter 抽象类来创建。该接口定义了三个核心方法：

• preHandle：在 Controller 方法执行前被调用，返回 true 表示继续执行，返回 false 表示中断执行。
• postHandle：在 Controller 方法执行后，视图渲染前被调用，可以对 ModelAndView 进行修改。
• afterCompletion：在整个请求处理完成后被调用，通常用于资源清理工作。

二、实战案例

1. 用户认证与授权

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class AuthInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 获取用户登录状态
        Object user = request.getSession().getAttribute("user");
        if (user == null) {
            // 如果用户未登录，重定向到登录页面
            response.sendRedirect("/login");
            return false;
        }
        // 如果用户已登录，继续请求处理流程
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 请求处理完成后执行的逻辑
        System.out.println("Request processing completed");
    }
}

2. 请求日志与性能监控

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.time.LocalDateTime;

@Component
public class PerformanceInterceptor implements HandlerInterceptor {

    private ThreadLocal<Long> startTimeThreadLocal = new ThreadLocal<>();

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 记录请求开始时间
        startTimeThreadLocal.set(System.currentTimeMillis());
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 计算请求处理时间
        long startTime = startTimeThreadLocal.get();
        long endTime = System.currentTimeMillis();
        System.out.println("Request URI: " + request.getRequestURI() + ", Time taken: " + (endTime - startTime) + "ms");
        startTimeThreadLocal.remove();
    }
}

3. 国际化与本地化

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.LocaleResolver;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Locale;

@Component
public class LocaleInterceptor implements HandlerInterceptor {

    private LocaleResolver localeResolver;

    public LocaleInterceptor(LocaleResolver localeResolver) {
        this.localeResolver = localeResolver;
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 获取请求中的语言参数
        String lang = request.getParameter("lang");
        if (lang != null) {
            // 设置本地化信息
            Locale locale = new Locale(lang);
            localeResolver.setLocale(request, response, locale);
        }
        return true;
    }
}

三、注册拦截器

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private AuthInterceptor authInterceptor;

    @Autowired
    private PerformanceInterceptor performanceInterceptor;

    @Autowired
    private LocaleInterceptor localeInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册用户认证拦截器，拦截所有请求
        registry.addInterceptor(authInterceptor).addPathPatterns("/**");
        // 注册性能监控拦截器，拦截所有请求
        registry.addInterceptor(performanceInterceptor).addPathPatterns("/**");
        // 注册国际化拦截器，拦截所有请求
        registry.addInterceptor(localeInterceptor).addPathPatterns("/**");
    }
}

四、总结

通过本文的实战案例，我们深入解析了 Java 拦截器的应用。拦截器在 Java Web 开发中具有广泛的应用场景，如用户认证与授权、请求日志与性能监控、国际化与本地化等。掌握拦截器的使用，可以帮助开发者提高代码的可维护性和扩展性，是高效编程的重要技巧。