博客

SpringBoot定义拦截器

在springboot中定义一个拦截器的方式：

使自定义类实现HandlerInterceptor接口

。

public class MySelfInterceptor implements HandlerInterceptor {
	@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    	System.out.println("在业务处理器处理请求之前被调用");
    	return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
		System.out.println("在业务处理器处理请求执行完成后，生成视图之前执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
		System.out.println("在DispatcherServlet完全处理完请求后被调用");
    }
} 

根据三种情况，可以在不同的方法针对请求进行额外的处理。
	在preHandle中，可以进行权限校验，安全控制。
	在postHandle中，可以对返回来的ModelAndView进行处理，这个时候还未渲染视图。
	在afterCompletion中，请求已经完成，页面已经渲染，数据已经返回。这个时候可以做一些资源清理，或者记录请求调用时间，做性能监控

在springboot中的IOC容器，所有定义的bean都应该注入到容器中，才可以被springboot调用。所以对于我们自定义的拦截器，要么通过配置文件的方式将其注入到容器中，要么通过注解的形式注入到容器中。下面来介绍这两种方式的写法。

配置文件方式

springboot推荐的是纯注解的形式，所以对于xml配置文件，仍然类似于SpringMVC的注入方式，只是springboot同样支持。

    <mvc:interceptors>
        <mvc:interceptor>
        	<!--path代表拦截哪些映射名-->
            <mvc:mapping path=" " />
            <!--class代表自定义拦截器类的位置-->
            <bean class=" "/>
        </mvc:interceptor>
    </mvc:interceptors>

纯注解方式

使用注解的方式，需要先将我们自定义的拦截器类，通过注解的方式注入到容器当中。

//一些类似的注解皆可以使该拦截器被注入到容器当中
@Component/@Slf4j/... 
public class MySelfInterceptor implements HandlerInterceptor {
	......
}

通过代码的配置方式

@Configuration

，将自定义的拦截器，添加到springboot自带拦截器的路径中。

@Configuration
public class WebCofiguration extends WebMvcConfigurerAdapter {
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MySelfInterceptor ())
                .addPathPatterns("/**")
                .excludePathPatterns("/logout");
                //过滤器可以添加多个，这里的addPathPatterns的/**是对所有的请求都做拦截。
                //excludePathPatterns代表排除url的拦截路径，即不拦截
    }
}

WebMvcConfigurerAdapter 失效的问题

springBoot2.0以上 WebMvcConfigurerAdapter 方法过时，有两种替代方案：

	继承 WebMvcConfigurationSupport 类；（会让springmvc对静态资源的自动配置失效）
	实现 WebMvcConfigurer 接口；  （推荐用这个）

出现跨域问题

出现跨域问题，可以在这里继续添加addCorsMappings，以此来解决跨域问题

@Configuration
public class WebCofiguration extends WebMvcConfigurerAdapter {

    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MySelfInterceptor ())
                .addPathPatterns("/**");
    }

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedMethods("*")
                .allowedOrigins("*")
                .allowedHeaders("*");
    }

}

如果依然出现跨域问题，可能是拦截器和addCorsMappings冲突了，这个跟dispatch中对于跨域处理的执行顺序有关系，导致response头部未正确配置跨域信息。

所以可以在过滤器中添加跨域信息，因为过滤器先于拦截器执行，在进入dispatch前就可以完成配置。