java 拦截器实现方式

原创

mob649e8165596b 2024-08-09 13:42:58 ©著作权

文章标签 拦截器 java Java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e8165596b的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 拦截器实现方式

在 Java 编程中，拦截器是一种用于处理请求和响应的设计模式，它允许对程序中的特定操作进行拦截、监控或修改。拦截器常用于 Java Web 开发、Spring 框架以及其他框架中，能够提升系统的可维护性和可扩展性。

1. 拦截器的工作原理

拦截器通常通过某种机制在请求到达控制层之前或响应返回给客户端之前被触发。它们可以执行一系列操作，例如身份验证、日志记录、参数检查、异常处理等。使用拦截器的一大优点是将这些跨切面的关注点从业务逻辑中分离出来，使代码更加简洁。

2. Java 中的拦截器实现

2.1. 基于 Servlet 的拦截器

在 Java Web 应用程序中，可以使用 Filter 接口实现拦截器。以下是一个简单的示例，展示如何使用 Filter 来记录请求信息：

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

public class LoggingFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化代码
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        System.out.println("Request URL: " + httpRequest.getRequestURL());
        // 继续进行剩余的过滤链
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        // 清理代码
    }
}

2.2. 基于 Spring 的拦截器

在 Spring 框架中，可以使用 HandlerInterceptor 接口，实现全局拦截器。下面是一个简单的 Spring 拦截器示例，它在处理请求之前执行验证操作：

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 {
        String token = request.getHeader("Authorization");
        if (token == null || !isValid(token)) {
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return false;
        }
        return true;
    }

    private boolean isValid(String token) {
        // 验证 token 的逻辑
        return "valid-token".equals(token);
    }
}

2.3. 拦截器的配置

在 Spring Boot 应用中，可以通过实现 WebMvcConfigurer 接口来注册拦截器。以下是一个简单的配置示例：

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;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authInterceptor).addPathPatterns("/api/**"); // 为指定路径添加拦截器
    }
}

3. 拦截器的优缺点

优点	缺点
1. 代码结构清晰，易于维护。	1. 可能增加请求的处理时间。
2. 提高了代码的复用性。	2. 配置复杂性可能增加。
3. 可集中处理跨越多个模块的逻辑。	3. 容易导致意外的干扰，如果没有良好的设计。