Spring MVC拦截器的基本使用方法

Spring MVC拦截器的基本使用方法

在 Spring MVC 中，拦截器是一种非常有用的机制，可以在请求到达控制器之前或之后执行一些操作。本文将详细讲解 Spring MVC 拦截器的基本使用方法，包括如何创建拦截器、如何配置拦截器、如何使用拦截器等。

创建拦截器

在 Spring MVC 中，我们可以通过实现 HandlerInterceptor 接口来创建拦截器。下面是一个简单的拦截器示例：

public class MyInterceptor implements HandlerInterceptor {
  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("preHandle");
    return true;
  }

  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    System.out.println("postHandle");
  }

  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    System.out.println("afterCompletion");
  }
}

在上面的代码中，我们创建了一个 MyInterceptor 类，实现了 HandlerInterceptor 接口，并重写了 preHandle、postHandle 和 afterCompletion 方法。在 preHandle 方法中，我们可以执行一些操作，例如验证用户身份、记录日志等。在 postHandle 方法中，我们可以修改 ModelAndView 对象，例如添加一些模型数据、修改视图名称等。在 afterCompletion 方法中，我们可以执行一些清理操作，例如释放资源、记录执行时间等。

配置拦截器

在 Spring MVC 中，我们可以通过配置文件来配置拦截器。下面是一个简单的配置文件示例：

<mvc:interceptors>
  <mvc:interceptor>
    <mvc:mapping path="/**" />
    <bean class="com.example.interceptor.MyInterceptor" />
  </mvc:interceptor>
</mvc:interceptors>

在上面的配置文件中，我们使用了 <mvc:interceptors> 标签来配置拦截器。其中，<mvc:interceptor> 标签用于配置一个拦截器，<mvc:mapping> 标签用于配置拦截器的路径，<bean> 标签用于配置拦截器的实现类。

使用拦截器

在 Spring MVC 中，我们可以使用拦截器来拦截请求，并执行一些操作。下面是一个简单的示例：

@Controller
public class MyController {
  @RequestMapping("/hello")
  public String hello() {
    System.out.println("hello");
    return "hello";
  }
}

在上面的代码中，我们创建了一个 MyController 类，用于处理请求。在 hello 方法中，我们输出了一条消息，并返回了一个视图名称。

现在，我们可以使用拦截器来拦截请求，并在请求到达控制器之前或之后执行一些操作。下面是一个简单的拦截器示例：

public class MyInterceptor implements HandlerInterceptor {
  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("preHandle");
    return true;
  }

  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    System.out.println("postHandle");
  }

  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    System.out.println("afterCompletion");
  }
}

在上面的代码中，我们创建了一个 MyInterceptor 类，实现了 HandlerInterceptor 接口，并重写了 preHandle、postHandle 和 afterCompletion 方法。在 preHandle 方法中，我们输出了一条消息。现在，我们可以将这个拦截器配置到 Spring MVC 中，来拦截请求并执行 preHandle 方法。

下面是一个简单的配置文件示例：

<mvc:interceptors>
  <mvc:interceptor>
    <mvc:mapping path="/**" />
    <bean class="com.example.interceptor.MyInterceptor" />
  </mvc:interceptor>
</mvc:interceptors>

在上面的配置文件中，我们使用了 <mvc:interceptors> 标签来配置拦截器。其中，<mvc:interceptor> 标签用于配置一个拦截器，<mvc:mapping> 标签用于配置拦截器的路径，<bean> 标签用于配置拦截器的实现类。

现在，我们可以访问 MyController 中的 hello 方法，来测试拦截器的功能。当我们访问 /hello 路径时，拦截器将会拦截请求，并执行 preHandle 方法。当控制器处理完请求后，拦截器将会执行 postHandle 方法和 afterCompletion 方法。