SpringBoot--Filter过滤器

Posted 2023-04-01 卷神一代

一.了解过滤器Filter

• 过滤器: Filter, 是 Servlet 技术中最实用的技术。
• 过滤器是处于客户端和服务器之间的一个过滤网,可以过滤掉一些不符合要求的请求
• 常见场景: 
  • Session 校验
  • 判断用户权限
  • 不符合设定条件，则会被重定向特殊的地址或者设定的响应
  • 过滤敏感词汇
  • 设置编码

二.基础入门代码编写

第一步:引入SpringBoot基础依赖即可

第二步:创建自己的过滤器

• note:实现 Filter接口,并重写它的三个方法

  • init -- filter对象在服务器启动时就会自动创建

  • doFilter -- 每次有拦截到请求时都会调用，可以调用多次；

  • destroy -- filter对象在服务器关闭/应用移除时销毁

/**
 * @Classname MyFilter
 * @Description 过滤器
 * @Date 2022/3/6 21:47
 * @Created ben
 */
@Component
@WebFilter(filterName = "MyFilter",
        /**
         * 通配符（*）表示对所有的web资源进行拦截
        */
        urlPatterns = "/*"
        )
public class MyFilter implements Filter 
    /**
     * 过滤器初始化
     * explain:在容器中创建当前过滤器的时候自动调用
     *
     * @param filterConfig
     */
    @Override
    public void init(FilterConfig filterConfig)
        System.out.println("初始化过滤器!");
    

    /**
     * 过滤器过滤操作
     * explain:过滤的具体操作
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException 
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        System.out.println("请求地址:"+request.getRequestURI());

        HttpServletResponseWrapper wrapper = new HttpServletResponseWrapper((HttpServletResponse) servletResponse);

        // 请求url中包含/hello||/online,继续执行
        if (request.getRequestURI().contains("/hello")
                || request.getRequestURI().contains("/online") )
            // 交给下一个过滤器或servlet处理
            filterChain.doFilter(servletRequest,servletResponse);
        else 
            // 请求url不包含/hello||/online,重定向到/online接口
            wrapper.sendRedirect("/entry/online");
        
    

    /**
     * 过滤器销毁
     * explain:在容器中销毁当前过滤器的时候自动调用
     */
    @Override
    public void destroy() 
        System.out.println("销毁过滤器!");
    

第三步:测试

• 启动服务

  • note:可以看见过滤器中init 方法,在服务启动的时候被调用到,说明服务器启动,容器也接着被创建

• 测试一:127.0.0.1/entry/hello
  • note:访问的url在过滤器中存在,则继续交给了下一个过滤器或servlet处理

​

• 测试二:127.0.0.1/entry 
  • note:访问的url在过滤器中不存在,则会经过特殊处理
  • note:注意访问url的变化,从/entry重定向到了/entry/online

​

​ 

 ​

三.配置

• 注解配置

• 拦截路径

1、完全路径匹配：以/开始，以具体路径结尾
	/aa   /aa.do  /aa/bb/xx
	
2、目录匹配：以/开始，以*结尾
	/* /aa/*  /aa/bb/*
	
3、扩展名匹配：以*开始，以扩展名结尾
	*.do   *.action
	
****以上三种路径写法都是指拦截路径，一个资源访问是可以同时被多个过滤器拦截的，所以是没有优先级

• 拦截方式

  • note:默认只拦截 从浏览器端过来的正常request，转发是默认不拦截，如果希望拦截到转发的资源跳转，需要通过配置
  • dispatcherTypes:不配置,默认过滤所有方式的请求

SpringBoot——SpringBoot中使用过滤器Filter的两种方式

1.方式一（使用注解）

首先，我们写一个Filter。要求就是简单的打印一句话。

在MyFilter这个类的上方使用 @WebFilter 注解来创建Filter即可。

package com.songzihao.springboot.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

/**
 *
 */
@WebFilter(urlPatterns = "/myfilter")
public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("======您已进入过滤器======");

        filterChain.doFilter(servletRequest,servletResponse);
    }
}

之后在SpringBoot项目的入口类上方使用注解 @ServletComponentScan 注解来扫描filter包中的注解即可。

package com.songzihao.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
@ServletComponentScan(basePackages = "com.songzihao.springboot.filter")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

最后启动测试。

---

2.方式二（定义配置类）

仍然是先写一个 Filter。这次不使用注解。 

package com.songzihao.springboot.filter;

import javax.servlet.*;
import java.io.IOException;

/**
 *
 */
public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("======您已进入过滤器======");

        filterChain.doFilter(servletRequest,servletResponse);
    }
}

之后写一个控制层controller。

package com.songzihao.springboot.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 *
 */
@Controller
public class UserController {

    @RequestMapping(value = "/user/detail")
    public @ResponseBody String userDetail() {
        return "/user/detail";
    }

    @RequestMapping(value = "/center")
    public @ResponseBody String center() {
        return "center";
    }
}

然后再写一个配置类！！！

package com.songzihao.springboot.config;

import com.songzihao.springboot.filter.MyFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 *
 */
@Configuration //定义此类为配置类
public class FilterConfig {

    @Bean
    public FilterRegistrationBean myFilterRegistrationBean() {
        //注册过滤器
        FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean(new MyFilter());
        //添加过滤路径
        filterRegistrationBean.addUrlPatterns("/user/*");
        return filterRegistrationBean;
    }
}

最后启动测试。