SpringMVC拦截器和异常处理器使用示例超详细讲解

SpringMVC拦截器和异常处理器使用示例超详细讲解

在Spring MVC中，拦截器和异常处理器是两个非常重要的组件，它们可以帮助我们实现一些通用的功能，如日志记录、权限验证、异常处理等。本文将详细介绍如何使用拦截器和异常处理器，并提供两个示例说明。

拦截器

拦截器的作用

拦截器是Spring MVC中的一个组件，它可以在请求到达处理器之前或之后执行一些通用的操作，如日志记录、权限验证、参数校验等。拦截器可以帮助我们实现一些通用的功能，避免代码重复，提高代码复用性。

拦截器的实现

在Spring MVC中，我们可以通过实现HandlerInterceptor接口来定义一个拦截器。HandlerInterceptor接口定义了三个方法，分别是preHandle()、postHandle()和afterCompletion()。其中，preHandle()方法在请求到达处理器之前执行，postHandle()方法在处理器执行之后、视图渲染之前执行，afterCompletion()方法在视图渲染之后执行。

以下是一个简单的拦截器示例，它在preHandle()方法中记录请求的URL和时间戳。

public class LoggingInterceptor implements HandlerInterceptor {
  private static final Logger logger = LoggerFactory.getLogger(LoggingInterceptor.class);

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    logger.info("Request URL: {}", request.getRequestURL());
    logger.info("Request Timestamp: {}", System.currentTimeMillis());
    return true;
  }

  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    // do nothing
  }

  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    // do nothing
  }
}

在上面的示例中，我们定义了一个LoggingInterceptor类，它实现了HandlerInterceptor接口，并在preHandle()方法中记录请求的URL和时间戳。在postHandle()和afterCompletion()方法中，我们什么也不做。

拦截器的配置

在Spring MVC中，我们可以通过配置InterceptorRegistry来注册拦截器。以下是一个简单的拦截器配置示例，它将LoggingInterceptor拦截器注册到Spring MVC中。

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new LoggingInterceptor());
  }
}

在上面的示例中，我们定义了一个WebConfig类，它实现了WebMvcConfigurer接口，并在addInterceptors()方法中注册了LoggingInterceptor拦截器。

异常处理器

异常处理器的作用

异常处理器是Spring MVC中的一个组件，它可以在发生异常时执行一些通用的操作，如记录日志、返回错误信息等。异常处理器可以帮助我们实现一些通用的功能，避免代码重复，提高代码复用性。

异常处理器的实现

在Spring MVC中，我们可以通过实现HandlerExceptionResolver接口来定义一个异常处理器。HandlerExceptionResolver接口定义了一个方法resolveException()，它可以在发生异常时执行一些通用的操作。

以下是一个简单的异常处理器示例，它在resolveException()方法中记录异常信息并返回一个错误页面。

public class ExceptionHandler implements HandlerExceptionResolver {
  private static final Logger logger = LoggerFactory.getLogger(ExceptionHandler.class);

  @Override
  public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
    logger.error("Exception: {}", ex.getMessage());
    ModelAndView modelAndView = new ModelAndView("error");
    modelAndView.addObject("message", ex.getMessage());
    return modelAndView;
  }
}

在上面的示例中，我们定义了一个ExceptionHandler类，它实现了HandlerExceptionResolver接口，并在resolveException()方法中记录异常信息并返回一个错误页面。

异常处理器的配置

在Spring MVC中，我们可以通过配置HandlerExceptionResolver来注册异常处理器。以下是一个简单的异常处理器配置示例，它将ExceptionHandler异常处理器注册到Spring MVC中。

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
  @Override
  public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    resolvers.add(new ExceptionHandler());
  }
}

在上面的示例中，我们定义了一个WebConfig类，它实现了WebMvcConfigurer接口，并在configureHandlerExceptionResolvers()方法中注册了ExceptionHandler异常处理器。

示例1：使用拦截器记录请求日志

以下是一个使用拦截器记录请求日志的示例。

public class LoggingInterceptor implements HandlerInterceptor {
  private static final Logger logger = LoggerFactory.getLogger(LoggingInterceptor.class);

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    logger.info("Request URL: {}", request.getRequestURL());
    logger.info("Request Timestamp: {}", System.currentTimeMillis());
    return true;
  }

  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    // do nothing
  }

  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    // do nothing
  }
}

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new LoggingInterceptor());
  }
}

在上面的示例中，我们首先定义了一个LoggingInterceptor拦截器，它在preHandle()方法中记录请求的URL和时间戳。然后，我们定义了一个WebConfig类，它实现了WebMvcConfigurer接口，并在addInterceptors()方法中注册了LoggingInterceptor拦截器。

示例2：使用异常处理器处理异常

以下是一个使用异常处理器处理异常的示例。

public class ExceptionHandler implements HandlerExceptionResolver {
  private static final Logger logger = LoggerFactory.getLogger(ExceptionHandler.class);

  @Override
  public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
    logger.error("Exception: {}", ex.getMessage());
    ModelAndView modelAndView = new ModelAndView("error");
    modelAndView.addObject("message", ex.getMessage());
    return modelAndView;
  }
}

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
  @Override
  public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    resolvers.add(new ExceptionHandler());
  }
}

在上面的示例中，我们首先定义了一个ExceptionHandler异常处理器，它在resolveException()方法中记录异常信息并返回一个错误页面。然后，我们定义了一个WebConfig类，它实现了WebMvcConfigurer接口，并在configureHandlerExceptionResolvers()方法中注册了ExceptionHandler异常处理器。

总结

本文详细介绍了如何使用拦截器和异常处理器，并提供了两个示例说明。我们首先介绍了拦截器和异常处理器的作用和实现方式，然后，我们提供了一个使用拦截器记录请求日志的示例和一个使用异常处理器处理异常的示例。通过本文的介绍，我们可以了解到如何在Spring MVC应用程序中使用拦截器和异常处理器来实现一些通用的功能。