前言
在实际开发过程中,经常会碰见一些比如系统启动初始化信息、统计在线人数、在线用户数、过滤敏高词汇、访问权限控制(URL级别)等业务需求。这些对于业务来说一般上是无关的,业务方是无需关系的,业务只需要关系自己内部业务的事情。所以一般上实现以上的功能,都会或多或少的用到今天准备讲解的
过滤器、监听器、拦截器来实现以上功能。
过滤器
过滤器
Filter,是Servlet的的一个实用技术了。可通过过滤器,对请求进行拦截,比如读取session判断用户是否登录、判断访问的请求URL是否有访问权限(黑白名单)等。主要还是可对请求进行预处理。接下来介绍下,在springboot如何实现过滤器功能。
利用WebFilter注解配置
@WebFilter时Servlet3.0新增的注解,原先实现过滤器,需要在web.xml中进行配置,而现在通过此注解,启动启动时会自动扫描自动注册。
编写Filter类:
//注册器名称为customFilter,拦截的url为所有@WebFilter(filterName="customFilter",urlPatterns={"/*"})@Slf4jpublic 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@Slf4jpublic class Chapter7Application {
public static void main(String[] args) {
SpringApplication.run(Chapter7Application.class, args);
log.info("chapter7 服务启动");
}
}启动后,控制台输出:
image
过滤器已经生效了。但当注册多个过滤器时,无法指定执行顺序的,原本使用web。xml配置过滤器时,是可指定执行顺序的,但使用@WebFilter时,没有这个配置属性的,所以接下来介绍下通过FilterRegistrationBean进行过滤器的注册。
--小技巧--(2018-08-25修订)
通过过滤器的java类名称,进行顺序的约定,比如
LogFilter和AuthFilter,此时AuthFilter就会比LogFilter先执行,因为首字母A比L前面。
可查看具体原因:《关于@webFilter使用@Order无效问题》
FilterRegistrationBean方式
FilterRegistrationBean是springboot提供的,此类提供setOrder方法,可以为filter设置排序值,让spring在注册web filter之前排序后再依次注册。
改写filter
其实就输出了@webFilter注解即可。其他的都没有变化。
启动类中利用@bean注册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();
}注册多个时,就注册多个FilterRegistrationBean即可
启动后,效果和第一种是一样的。
image
作者:oKong
链接:https://www.jianshu.com/p/e89fe42ea1bb