Spring Boot 拦截器HandlerInterceptor

Spring Boot拦截器

拦截器主要应用于登陆校验、权限验证、乱码解决、性能监控和异常处理等功能，Spring Boot 同样提供了拦截器功能。

1.定义拦截器

在 Spring Boot 中定义拦截器十分的简单，只需要创建一个拦截器类，并实现 HandlerInterceptor 接口即可。

HandlerInterceptor 接口中定义以下 3 个方法，如下表。

返回值类型	方法声明	描述
boolean	preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)	该方法在控制器处理请求方法前执行，其返回值表示是否中断后续操作，返回 true 表示继续向下执行，返回 false 表示中断后续操作。
void	postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)	该方法在控制器处理请求方法调用之后、解析视图之前执行，可以通过此方法对请求域中的模型和视图做进一步修改。
void	afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)	该方法在视图渲染结束后执行，可以通过此方法实现资源清理、记录日志信息等工作。

LoginInterceptor

public class LoginInterceptor implements HandlerInterceptor {
    private final Logger logger = LoggerFactory.getLogger(LoginInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

       String requestURI = request.getRequestURI();
        log.info("请求的URI：",requestURI);

        String token = request.getParameter("token");

        if(StrUtil.isEmpty(token)){

            response.sendRedirect("/login");

        }
        return true;
    }
}

2.注册拦截器

创建一个实现了 WebMvcConfigurer 接口的配置类（使用了 @Configuration 注解的类），重写 addInterceptors() 方法，并在该方法中调用 registry.addInterceptor() 方法将自定义的拦截器注册到容器中。

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

3.指定拦截规则

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {
    ......
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") //拦截所有请求，包括静态资源文件
                .excludePathPatterns("/register", "/login",  "/css/**", "/images/**", "/js/**"); //放行登录页，登陆操作，静态资源
    }
}

在指定拦截器拦截规则时，调用了两个方法，这两个方法的说明如下：

• addPathPatterns：该方法用于指定拦截路径，例如拦截路径为“/**”，表示拦截所有请求，包括对静态资源的请求。

• excludePathPatterns：该方法用于排除拦截路径，即指定不需要被拦截器拦截的请求。

4.对比Spring MVC

让自定义的拦截器生效需要在 Spring MVC 的配置文件中进行配置，配置示例代码如下

<mvc:interceptors>
    <mvc:interceptor>
        <!-- 配置拦截器的路径 /** 表示拦截所有请求-->
        <mvc:mapping path="/**"/>
        <!-- 配置不需要拦截的路径 -->
        <mvc:exclude-mapping path="/login.do"/>
        <!--自定义的拦截器-->
        <bean class="com.by.interceptor.LoginInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

说明：

<mvc:interceptors> 元素用于配置一组拦截器
<mvc:interceptor> 元素中定义的是指定路径的拦截器
 <mvc:mapping> 用于配置拦截器作用的路径，该路径在其属性 path 中定义。如属性值“/**”表示拦截所有路径，“/member”表示拦截所有以“/member”结尾的路径。
<mvc:exclude-mapping> 子元素可以配置在请求路径中包含不需要拦截的内容
<mvc:interceptor> 元素的子元素必须按照 <mvc：mapping.../>、<mvc：exclude-mapping.../>、<bean.../> 的顺序配置。

全局拦截器

<mvc:interceptors>
    <!-- 配置一个全局拦截器，拦截所有请求 -->
   <bean class="com.by.interceptor.LoginInterceptor"/>
</mvc:interceptors>