springboot2.x | 过滤器(Filter)的使用

servlet简介

过滤器,依靠servlet技术。
Java Servlet 是运行在 Web 服务器或应用服务器上的程序,它是作为来自 Web 浏览器或其他 HTTP 客户端的请求和 HTTP 服务器上的数据库或应用程序之间的中间层。
servlet文档:
https://www.runoob.com/servlet/servlet-intro.html

servlet 和tomcat 是什么关系?

过滤器简介

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

1.过滤器和拦截器触发时机不一样,过滤器是在请求进入容器后,但请求进入servlet之前进行预处理的。请求结束返回也是,是在servlet处理完后,返回给前端之前。


flq.png

2.拦截器可以获取IOC容器中的各个bean,而过滤器就不行,因为拦截器是spring提供并管理的,spring的功能可以被拦截器使用,在拦截器里注入一个service,可以调用业务逻辑。而过滤器是JavaEE标准,只需依赖servlet api ,不需要依赖spring。


gg.png

1 通过@WebFilter来定义filter,

自定义 AllUrlFilter

@Slf4j
@WebFilter(filterName = "allurlfilter", urlPatterns = {"/*"})
public class AllUrlFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

        log.info("all url filter -->" + filterConfig.toString());
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        log.info("all url filter do filter");

        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        System.out.println(request.getHeader("token"));
        //往下文传递
        filterChain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        log.info("all url filter do destroy");
    }
}

在springboot 启动器类上加上注解 @ServletComponentScan

@SpringBootApplication
@ServletComponentScan
public class StudySpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(StudySpringbootApplication.class, args);
    }
}

总结:
Filter使用白名单过滤Url的方式,配置需要拦截的Url,如果想设置不过滤某些Url需要在doFilter方法中指定。
通过@WebFilter的方式定义Filter,默认使用Filter的类名设置优先级。使用FilterRegistrationBean可以指定优先级

2 filter 中的异常处理

2.1 制造错误

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        log.info("all url filter do filter");

        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;

        System.out.println(request.getHeader("token"));

        try {
            int i = 0 / 0;
        } catch (Exception e) {
            //错误封装在 request 中
            request.setAttribute("errormsg", e.getMessage());
            //
            request.getRequestDispatcher("/500").forward(request, response);
        }

        filterChain.doFilter(request, response);
    }

尽量使用request.getRequestDispatcher("/500").forward(req, resp);此方式只会在服务器内部转发客户端地址不会发生任何改变;如果使用response.sendRedirect("/500");请求转发,客户端地址会发生改变

2.2 添加/500 url

  @GetMapping("/500")
    public Response excep401(HttpServletRequest request) throws CustomException {

        System.out.println(request.getAttribute("errormsg"));

        throw new CustomException();
    }

方法2 : 通过FilterRegistrationBean来定义 多个filter

所有的filter 去掉 @WebFilter

3.1 新建HelloFilter

@Slf4j
//@WebFilter(filterName = "helloFilter" , urlPatterns = {"/hello/*"})
public class HelloFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

        log.info("hello filter --> " + filterConfig.toString());
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        log.info("hello do filter");

        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {

        log.info("hello do destroy");
    }
}

3.2 新建UserFilter

@Slf4j
//@WebFilter(filterName = "userFilter", urlPatterns = {"/user/*"})
public class UserFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

        log.info("user filter --> " + filterConfig.toString());
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        log.info("user do filter");

        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {

        log.info("user do destroy");

    }
}

3.3 新建 FilterConfig 配置

@Configuration
public class FilterConfig {

    @Bean
    public AllUrlFilter allUrlFilter(){
        return new AllUrlFilter();
    }

    @Bean
    public UserFilter userFilter(){
        return new UserFilter();
    }

    @Bean
    public HelloFilter helloFilter(){
        return new HelloFilter();
    }

    @Bean
    public FilterRegistrationBean filterRegistrationBean(AllUrlFilter allUrlFilter){
        FilterRegistrationBean registration = new FilterRegistrationBean();

        registration.setFilter(allUrlFilter);
        registration.setName("allUrlFilter");
        List<String> urlList  =  new ArrayList<>();
        urlList.add("/*");
        registration.setUrlPatterns(urlList);
        registration.setOrder(1);

        return registration;
    }


    @Bean
    public FilterRegistrationBean filterRegistrationBea2(HelloFilter helloFilter){
        FilterRegistrationBean registration = new FilterRegistrationBean();

        registration.setFilter(helloFilter);
        registration.setName("helloFilter");
        List<String> urlList  =  new ArrayList<>();
        urlList.add("/hello/*");
        registration.setUrlPatterns(urlList);
        registration.setOrder(2);

        return registration;
    }


    @Bean
    public FilterRegistrationBean filterRegistrationBea3(UserFilter userFilter){
        FilterRegistrationBean registration = new FilterRegistrationBean();

        registration.setFilter(userFilter);
        registration.setName("userFilter");
        List<String> urlList  =  new ArrayList<>();
        urlList.add("/user/*");
        registration.setUrlPatterns(urlList);
        registration.setOrder(3);

        return registration;
    }

}

SpringBoot中使用Filter和Interceptor
https://juejin.cn/post/6844903869927931918
Spring Interceptor vs Filter
https://juejin.cn/post/6844903828970553358
SpringBoot图文教程6—SpringBoot中过滤器的使用
https://juejin.cn/post/6844904072173060109

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容