spring boot 注解实现自定义Filter

简介

过滤器实际上就是对web资源进行拦截，做一些处理后再交给下一个过滤器或servlet处理
通常都是用来拦截request进行处理的，也可以对返回的response进行拦截处理。

本教程使用注解来自定义一个Filter，使用到的注解：
@WebFilter、@Order
耶，是的，步骤走起》》》

1、新建一个Class并实现Filter接口

注意，是javax.servlet.Filter接口。

import lombok.extern.slf4j.Slf4j;
import org.springframework.core.annotation.Order;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
//打印日志的注解，无须关心
@Slf4j
//后面再详解下面两个注解
@WebFilter(filterName = "myFilter", urlPatterns = "/*", servletNames = "*")
@Order(1)
public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
      log.info("初始化我的过滤器。。。。。。。。");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
throws IOException, ServletException {
        //放行前可在这里做一些操作
        log.info("doFilter进入过滤器操作方法。。。");
        chain.doFilter(request, response);
        // 请求返回可在这里做一些操作
        log.info("doFilter准备离开过滤器操作。。。");
    }

    @Override
    public void destroy() {
        // 该过滤器销毁前可在这里做一些操作
        log.info("准备销毁过滤器操。。。");
    }
}

嘻嘻，到此已经完成一大半了。。

2、在启动类上，开启Servlet相关注解的扫描

import com.example.demo.config.MyFilter;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
//后面讲解该注解
@ServletComponentScan(basePackageClasses = {MyFilter.class})
public class SpringbootLogbackAsyncApplication {

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

3、OK，新建一个测试接口类InitRest。

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
public class InitRest {

    @GetMapping("/hello")
    public String hello() {
        log.info("进入接口。。。");
        return "Hello greetings...";
    }
}

4、OK，启动程序，验证。

启动程序时，会初始化过滤器：

初始化过滤器

接口正常返回值

看过滤器启用成功了：（注意看日志的顺序）

过滤器打印的日志

至此，自定义过滤器实现成功！！！

5、注解详解

@WebFilter

使用该注解的类，必须实现Filter接口，
常用属性：
filterName ：字符串，命名过滤器名称，默认是该过滤器类名；
urlPatterns：路径表达式，指定需要过滤的请求路径，与value属性相同，二者必选其一；
value：同urlPatterns；
servletNames：指定需要过滤的接口类，

@Order

只有一个属性value，指定该过滤器的优先级，值越小，优先级越高，即越优先执行。

@ServletComponentScan

用于扫描servlet3.0相关的注解，必须使用，其相关注解才能生效，它就三个属性：
value与basePackages，作用相同，可接受一个字符串数组，用于指定需要扫描的包；
basePackageClasses，接受一个Class数组，用于指定需要扫描的Java类，例如本教程所示。

OK，至此自定义Filter实现了，若您觉得文章还不错，记得点赞评论加关注哦！！！