springboot的过滤器、监听器、拦截器

springboot的过滤器、监听器、拦截器

1.过滤器

过滤器Filter，是Servlet的的一个实用技术了。可通过过滤器，对请求进行拦截，比如读取session判断用户是否登录、判断访问的请求URL是否有访问权限(黑白名单)等。主要还是可对请求进行预处理。接下来介绍下，在springboot如何实现过滤器功能。

1.1利用@WebFilter注解配置

@WebFilter是Servlet3.0新增的注解，原先实现过滤器，需要在web.xml中进行配置，而现在通过此注解，启动启动时会自动扫描自动注册。

• 1.在过滤器中添加@WebFilter注解
• 2.在启动类加入@ServletComponentScan注解

//注册器名称为customFilter,拦截的url为所有
@WebFilter(filterName="customFilter",urlPatterns={"/*"})
@Slf4j
public class CustomFilter implements Filter{
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("filter 初始化");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // TODO Auto-generated method stub
        log.info("doFilter 请求处理");
        //对request、response进行一些预处理
        // 比如设置请求编码
        // request.setCharacterEncoding("UTF-8");
        // response.setCharacterEncoding("UTF-8");
        //TODO 进行业务逻辑
 
        //链路 直接传给下一个过滤器
        chain.doFilter(request, response);
    }
 
    @Override
    public void destroy() {
        log.info("filter 销毁");
    }
}

//在启动类加入@ServletComponentScan注解
@SpringBootApplication
@ServletComponentScan
@Slf4j
public class Chapter7Application {
 
    public static void main(String[] args) {
        SpringApplication.run(Chapter7Application.class, args);
        log.info("chapter7 服务启动");
    }
}

注意:当注册多个过滤器时，无法指定执行顺序的，原本使用web.xml配置过滤器时，是可指定执行顺序的，但使用@WebFilter时，没有这个配置属性的(需要配合@Order进行)

---

指定过滤器顺序小技巧

通过过滤器的java类名称，进行顺序的约定，比如LogFilter和AuthFilter，此时AuthFilter就会比LogFilter先执行，因为首字母A比L前面。

1.2.FilterRegistrationBean方式

FilterRegistrationBean是springboot提供的，此类提供setOrder方法，可以为filter设置排序值，让spring在注册web filter之前排序后再依次注册。

• 启动类中利用@bean注册FilterRegistrationBean ,注册多个时，就注册多个FilterRegistrationBean即可

    //排序
    @Bean
    public FilterRegistrationBean  filterRegistrationBean() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        //当过滤器有注入其他bean类时，可直接通过@bean的方式进行实体类过滤器，这样不可自动注入过滤器使用的其他bean类。
        //当然，若无其他bean需要获取时，可直接new CustomFilter()，也可使用getBean的方式。
        registration.setFilter(customFilter());
        //过滤器名称
        registration.setName("customFilter");
        //拦截路径
        registration.addUrlPatterns("/*");
        //设置顺序
        registration.setOrder(10);
        return registration;
    }
 
//注入过滤器
    @Bean
    public Filter customFilter() {
        return new CustomFilter();
    }

2.监听器

Listeeshi是servlet规范中定义的一种特殊类。用于监听servletContext、HttpSession和servletRequest等域对象的创建和销毁事件。监听域对象的属性发生修改的事件。用于在事件发生前、发生后做一些必要的处理。一般是获取在线人数等业务需求。

• 创建一个ServletRequest监听器(其他监听器类似创建)

@WebListener
@Slf4j
public class Customlister implements ServletRequestListener{
 
    @Override
    public void requestDestroyed(ServletRequestEvent sre) {
        log.info("监听器：销毁");
    }
 
    @Override
    public void requestInitialized(ServletRequestEvent sre) {
        log.info("监听器：初始化");
    }
 
}

• 和创建过滤器一样，在启动类中加入@ServletComponentScan进行自动注册即可。

2.拦截器

以上的过滤器、监听器都属于Servlet的api，我们在开发中处理利用以上的进行过滤web请求时，还可以使用Spring提供的拦截器(HandlerInterceptor)进行更加精细的控制。

• 编写自定义拦截器类

@Slf4j
public class CustomHandlerInterceptor implements HandlerInterceptor{//或者 extends HandlerInterceptorAdapter
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        log.info("preHandle:请求前调用");
           //    logger.info("pre handle");//日志
        HttpSession session=request.getSession();
        User user=(User) session.getAttribute("loginMessage");//已经登录
        if (user!=null) {
            return true;
        }else {
            PrintWriter printWriter=response.getWriter();
            printWriter.println("false");
            return false;
        }
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        log.info("postHandle:请求后调用");
 
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        log.info("afterCompletion:请求调用完成后回调方法，即在视图渲染完成后回调");
 
    }
}

• 通过继承WebMvcConfigurerAdapter注册拦截器

在主类上
extends WebMvcConfigurerAdapter
或者
implements WebMvcConfigurer
//配置
@Override
public void addInterceptors(InterceptorRegistry registry) {
        // addPathPatterns 用于添加拦截规则
        // excludePathPatterns 用户排除拦截
        registry.addInterceptor(loginInterceptor()).
        addPathPatterns("/**/**").
        excludePathPatterns("/user/login").
        excludePathPatterns("/user/signOut").
        excludePathPatterns("/user/regis").
        excludePathPatterns("/dict/dictlist").
        excludePathPatterns("/product/list");//fileup
        super.addInterceptors(registry);
    }
    //注入
    @Bean
    public LoginInterceptor loginInterceptor() {
        return new  LoginInterceptor();
    }