spring boot 实现自定义 filter

实际项目中，经常需要拦截前端的请求，做一些预处理，比如访问权限控制等，毕竟并不是所有的用户都有权限访问所有的功能。这个时候，可以使用过滤器来实现。过滤器依赖servlet容器。在实现上基于函数回调，可以对几乎所有请求进行过滤。下面简单的说说Spring Boot里面如何增加过滤器。

 

一 引入spring-boot-starter-web

在pom.xml 中引入spring-boot-starter-web包。

       <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

 

 

二 创建过滤器 

 

常用注解如下：

@Order(1)：确定过滤器的执行顺序，后面的数字代表过滤器的生效顺序，           如果有多个过滤器，就可以通过后面的数字来指定过滤器的生效顺序了。@WebFilter：指定这个类是过滤器的注解里面的参数，     filterName 为过滤器名字，     urlPatterns 为过滤器的范围，     initParams 为过滤器初始化参数。

 

过滤器里面的三个方法

init ：filter对象只会创建一次，init方法也只会执行一次。doFilter ：主要的业务代码编写方法，可以多次重复调用destroy ：在销毁Filter时自动调用（程序关闭或者主动销毁Filter）。

下面创建两个过滤器，分别指定为order的值为1 和 2,用来验证过滤器的执行顺序。

过滤器1：

@Order(1)
@WebFilter(filterName = "Test", urlPatterns = "/*", initParams = {
@WebInitParam(name = "URL", value = "http://localhost:8080") })
public class TestFilter implements Filter {
​
  private String url;
​
  /**
   * 可以初始化Filter在web.xml里面配置的初始化参数 filter对象只会创建一次，init方法也只会执行一次。
   * 
   * @param filterConfig
   * @throws ServletException
   */
  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
    this.url = filterConfig.getInitParameter("URL");
    System.out.println("过滤器的初始化方法！URL=" + this.url + "，开始访问.........");
  }
​
  /**
   * 过滤器的工作主体
   * 
   * @param servletRequest
   * @param servletResponse
   * @param filterChain
   * @throws IOException
   * @throws ServletException
   */
  @Override
  public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
      throws IOException, ServletException {
    System.out.println("过滤器的执行方法，客户端向Servlet发送的请求被我拦截到了");
    filterChain.doFilter(servletRequest, servletResponse);
    System.out.println("过滤器的执行方法，Servlet向客户端发送的响应被我拦截到了");
  }
​
  /**
   * 在销毁Filter时自动调用。
   */
  @Override
  public void destroy() {
    System.out.println("我是过滤器的被销毁时调用的方法！，活不下去了................");
  }
​
}

 

过滤器2：

@Order(2)
@WebFilter(filterName = "Test2", urlPatterns = "/*", initParams = {
    @WebInitParam(name = "URL", value = "http://localhost:8080") })
public class TestFilter2 implements Filter {
​
  private String url;
​
  /**
   * 可以初始化Filter在web.xml里面配置的初始化参数 filter对象只会创建一次，init方法也只会执行一次。
   * 
   * @param filterConfig
   * @throws ServletException
   */
  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
    this.url = filterConfig.getInitParameter("URL");
    System.out.println("过滤器的初始化方法2！URL=" + this.url + "，开始访问.........");
  }
​
  /**
   * 过滤器的工作主体
   * 
   * @param servletRequest
   * @param servletResponse
   * @param filterChain
   * @throws IOException
   * @throws ServletException
   */
  @Override
  public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
      throws IOException, ServletException {
    System.out.println("过滤器2的执行方法，客户端向Servlet发送的请求被我拦截到了");
    filterChain.doFilter(servletRequest, servletResponse);
    System.out.println("过滤器2的执行方法，Servlet向客户端发送的响应被我拦截到了");
  }
​
  /**
   * 在销毁Filter时自动调用。
   */
  @Override
  public void destroy() {
    System.out.println("我是过滤器的被销毁时调用的方法！，活不下去了................");
  }
  
}

 

 

三 建立Contoller类

 

controller类比较简单，定义好路由即可

@RestController
public class TestController {
​
  @GetMapping("/test")
  public void getFilter() {
    System.out.println("server begin worker");
  }
}

 

 

四 启动类中增加注解，自动注册Filter

 

@ServletComponentScan:  在 SpringBootApplication上使用@ServletComponentScan注解后，Servlet、Filter、Listener可以直接通过@WebServlet、@WebFilter、@WebListener注解自动注册，无需其他代码。

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

 

 

五 测试结果

 

在浏览中输入：http://localhost:8080/test

这个时候控制台的输入为如下图片。

 

从执行结果可以看到，过滤器的执行顺序是按照我们的定义的顺序执行的。在进入到congtroller层之前就被拦截到了，在将数据返回给前台的时候又被拦截了。

 

 

                不端不装，有趣有梦