Spring MVC中HandlerInterceptor的作用是什么？

在Spring MVC框架中，HandlerInterceptor（也称为拦截器）是一种机制，用于在控制器方法执行之前或之后执行一些特定的操作。它提供了一种灵活的方式来处理诸如登录验证、请求响应时间的记录、修改请求或响应对象等功能，而不必在每个控制器方法中重复相同的代码。

HandlerInterceptor接口

HandlerInterceptor接口定义了三个方法，它们是：

1. preHandle：

   • 方法签名：boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception;
   • 描述：在控制器方法执行之前调用，可以用于做一些预处理操作，如验证用户是否已登录、设置线程局部变量等。
   • 返回值：如果返回true，则控制器方法将继续执行；如果返回false，则控制器方法不会执行，后续的拦截器也不会被调用。

2. postHandle：

   • 方法签名：void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception;
   • 描述：在控制器方法执行之后，但在视图渲染之前调用。可以用于修改ModelAndView对象，或者做其他的清理工作。

3. afterCompletion：

   • 方法签名：void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception;
   • 描述：在整个请求处理完成之后调用，即在视图渲染之后。可以用于释放资源、记录请求耗时等。

使用示例

下面是一个简单的示例，展示了如何创建和使用HandlerInterceptor：

public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 检查用户是否已登录
        HttpSession session = request.getSession(false);
        if (session != null && session.getAttribute("user") != null) {
            // 用户已登录，允许访问
            return true;
        } else {
            // 用户未登录，重定向到登录页面
            response.sendRedirect("/login");
            return false;
        }
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 可以在这里做一些处理，例如修改ModelAndView对象
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 可以在这里做一些清理工作，例如记录请求耗时
    }
}

注册拦截器

要在Spring MVC中注册拦截器，可以通过配置类来实现：

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/secure/**") // 添加拦截器生效的路径
                .excludePathPatterns("/secure/login"); // 排除不需要拦截的路径
    }
}

总结

HandlerInterceptor是Spring MVC框架中一种非常有用的工具，它允许开发者在请求处理的各个阶段执行自定义的逻辑。通过使用拦截器，可以实现诸如用户认证、日志记录、性能监控等多种功能，从而提高应用程序的安全性和可维护性。