springboot拦截器使用说明

• 拦截器（Interceptor）是Spring MVC框架中的重要组件之一，用于在请求处理过程中对请求进行拦截和处理， 常用于执行一些公共业务逻辑、请求参数校验、身份认证、日志记录等。它是通过配置的方式实现的,可以通过实现 HandlerInterceptor接口定义拦截器的具体行为。

• 拦截器可以拦截的请求包括所有的请求方式和对应的URL，即拦截所有的请求。同时，它还支持链式调用，我们可以 在各个拦截器中对请求进行处理，使得我们的业务逻辑更加清晰.在Spring MVC中，拦截器的执行顺序是由配置的 顺序决定的。当一个请求开始进入时，拦截器将按照配置的顺序执行，直到链中的所有拦截器都执行完成，才会将请求 交给最终的Controller或者抛出异常。代码实例:

     public class MyInterceptor implements HandlerInterceptor {
  
     @Override
     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
     
         // 在请求处理之前进行调用（Controller方法调用之前）
         System.out.println("拦截器preHandle()方法开始执行！");
         // 如果返回false，表示仅执行到此，后续的Interceptor和Controller方法都不会再被执行
         return true;
     }
  
     @Override
     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
     
         // 请求处理之后进行调用（Controller方法调用之后，视图渲染之前）
         System.out.println("拦截器postHandle()方法开始执行！");
     }
  
     @Override
     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
     
         // 整个请求处理完毕后并且视图渲染结束后执行（如当Controller方法抛出异常时就不会被调用了）
         System.out.println("拦截器afterCompletion()方法开始执行！");
     }
 }

• Spring MVC中，定义的拦截器必须实现HandlerInterceptor接口或其子接口。HandlerInterceptor接口定义了 三个方法：preHandle、postHandle和afterCompletion，这些方法为拦截器的执行提供了三个不同的阶段。 如果定义的拦截器没有实现HandlerInterceptor接口或其子接口，那么这个拦截器实际上就不是拦截器，仅仅是一个 普通的Java类，并不能在Spring MVC的拦截器链中起到拦截器的作用。因此，实现HandlerInterceptor接口 或其子接口是必须的。另外，为了将拦截器加入Spring MVC的拦截器链中，还需要在配置类中通过addInterceptor 方法将拦截器添加进去。在addInterceptor方法中，需要传递一个实现了HandlerInterceptor接口或其子接口的 拦截器实例。通过这种方式，才能让拦截器真正地在请求处理过程中起到拦截和处理的作用。 15.4 mybatis-plus分页插件的拦截器

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
       MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
       interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
       return interceptor;
    }

• 这段代码中的MybatisPlusInterceptor是Mybatis-Plus插件中的拦截器，不是Spring MVC框架中的拦截器。 这个拦截器不需要实现HandlerInterceptor接口，因为它的作用是拦截Mybatis的SQL执行过程而非Spring MVC 框架中的请求处理过程。当我们使用Mybatis-Plus的分页插件时，可以配置MybatisPlusInterceptor来实现 分页功能。MybatisPlusInterceptor是一个拦截器，负责拦截Mybatis执行SQL的过程，它在SQL执行前将分页 参数注入到SQL中，在SQL执行后将查询到的数据进行分页处理和封装返回结果。因此，在这段代码中，虽然 MybatisPlusInterceptor不需要实现HandlerInterceptor接口，但它的作用和Spring MVC框架中的拦截器 有所不同，主要是在Mybatis的SQL执行过程中拦截对SQL的处理。

• 当后端拦截了某个请求时，可以根据实际场景选择不同的方式返回错误信息给前端。以下是一些常用的方式：

1. 返回状态码和错误信息：在拦截器中可以通过HttpServletResponse对象设置响应状态码和响应正文，将错误信息返回给前端。例如，可以使用400表示客户端请求有误，401表示未授权，403表示禁止访问，404表示资源不存在等。示例代码：

 response.setStatus(400);
 response.getWriter().write("请求参数有误！");

1. 返回JSON格式的错误信息：可以将错误信息封装成JSON格式返回给前端。在拦截器中，可以使用@ResponseBody注解将错误信息封装成JSON格式后直接返回给前端。

示例代码：

 @ResponseStatus(HttpStatus.BAD_REQUEST)
 @ResponseBody
 public Map<String, Object> handleException(Exception ex) {
     Map<String, Object> resultMap = new HashMap<>();
     resultMap.put("error", ex.getMessage());
     return resultMap;
 }

1. 跳转到错误页面：在拦截器中，可以使用HttpServletRequest对象将错误信息设置到request域中，在跳转到错误页面时通过thymeleaf等模板引擎展示错误信息。示例代码：

 request.setAttribute("error", "请求参数有误！");
 return "error";

无论采用哪种方式，都需要在前端对返回的错误信息进行相应的处理，以提高用户体验。

多个拦截器的执行顺序

①若每个拦截器的preHandle()都返回true 此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关： preHandle()会按照配置的顺序执行，而postHandle()和afterCompletion()会按照配置的反序执行

②若某个拦截器的preHandle()返回了false preHandle()返回false和它之前的拦截器的preHandle()都会执行，postHandle()都不执行，返回false 的拦截器之前的拦截器的afterCompletion()会执行

(非原创,纯小白,非喜勿喷)