# SpringBootFilter **Repository Path**: Protector_hui/spring-boot-filter ## Basic Information - **Project Name**: SpringBootFilter - **Description**: No description available - **Primary Language**: Java - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-03-01 - **Last Updated**: 2021-03-01 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # SpringBoot 实现过滤器 ## Filter 介绍 Filter 过滤器这个概念应该大家不会陌生，特别是对与从 Servlet 开始入门学 Java 后台的同学来说。那么这个东西我们能做什么呢？Filter 过滤器主要是用来过滤用户请求的，它允许我们对用户请求进行**前置处理**和**后置处理**，比如实现 **URL 级别的权限控制**、**过滤非法请求**等等。Filter 过滤器是面向切面编程——AOP 的具体实现（AOP切面编程只是一种编程思想而已）。 另外，Filter 是依赖于 Servlet 容器，`Filter`接口就在 Servlet 包下面，属于 Servlet 规范的一部分。所以，很多时候我们也称其为**“增强版 Servlet”**。 如果我们需要自定义 Filter 的话非常简单，只需要实现 `javax.Servlet.Filter` 接口，然后重写里面的 3 个方法即可！ ```java public interface Filter { //初始化过滤器后执行的操作 default void init(FilterConfig filterConfig) throws ServletException { } // 对请求进行过滤 void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException; // 销毁过滤器后执行的操作，主要用户对某些资源的回收 default void destroy() { } } ``` ## Filter是如何实现拦截的？ `Filter`接口中有一个叫做 `doFilter` 的方法，这个方法实现了对用户请求的过滤。具体流程大体是这样的： 1. 用户发送请求到 web 服务器，请求会先到过滤器； 2. 过滤器会对请求进行一些处理比如过滤请求的参数、修改返回给客户端的 response 的内容、判断是否让用户访问该接口等等。 3. 用户请求响应完毕。 4. 进行一些自己想要的其他操作。 ![img](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/filter1.png) ## 如何自定义Filter ### 自己手动注册配置实现 **自定义的 Filter 需要实现`javax.Servlet.Filter`接口，并重写接口中定义的3个方法。** ```java /** * @author shuang.kou */ @Component public class MyFilter implements Filter { private static final Logger logger = LoggerFactory.getLogger(MyFilter.class); @Override public void init(FilterConfig filterConfig) { logger.info("初始化过滤器：", filterConfig.getFilterName()); } @Override public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException { // 对请求进行预处理 logger.info("过滤器开始对请求进行预处理："); HttpServletRequest request = (HttpServletRequest) servletRequest; String requestUri = request.getRequestURI(); System.out.println("请求的接口为：" + requestUri); long startTime = System.currentTimeMillis(); // 通过 doFilter 方法实现过滤功能 filterChain.doFilter(servletRequest, servletResponse); // 上面的 doFilter 方法执行结束后用户的请求已经返回 long endTime = System.currentTimeMillis(); System.out.println("该用户的请求已经处理完毕，请求花费的时间为：" + (endTime - startTime)); } @Override public void destroy() { logger.info("销毁过滤器"); } } ``` **在配置中注册自定义的过滤器。** ```java @Configuration public class MyFilterConfig { @Autowired MyFilter myFilter; @Bean public FilterRegistrationBean thirdFilter() { FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean<>(); filterRegistrationBean.setFilter(myFilter); filterRegistrationBean.setUrlPatterns(new ArrayList<>(Arrays.asList("/api/*"))); return filterRegistrationBean; } } ``` ### 通过提供好的一些注解实现 **在自己的过滤器的类上加上`@WebFilter` 然后在这个注解中通过它提供好的一些参数进行配置。** ```java @WebFilter(filterName = "MyFilterWithAnnotation", urlPatterns = "/api/*") public class MyFilterWithAnnotation implements Filter { ...... } ``` 另外，为了能让 Spring 找到它，你需要在启动类上加上 `@ServletComponentScan` 注解。 ## 定义多个过滤器，并决定它们的执行顺序 **假如我们现在又加入了一个过滤器怎么办？** ```java @Component public class MyFilter2 implements Filter { private static final Logger logger = LoggerFactory.getLogger(MyFilter2.class); @Override public void init(FilterConfig filterConfig) { logger.info("初始化过滤器2"); } @Override public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException { //对请求进行预处理 logger.info("过滤器开始对请求进行预处理2："); HttpServletRequest request = (HttpServletRequest) servletRequest; String requestUri = request.getRequestURI(); System.out.println("请求的接口为2：" + requestUri); long startTime = System.currentTimeMillis(); //通过 doFilter 方法实现过滤功能 filterChain.doFilter(servletRequest, servletResponse); // 上面的 doFilter 方法执行结束后用户的请求已经返回 long endTime = System.currentTimeMillis(); System.out.println("该用户的请求已经处理完毕，请求花费的时间为2：" + (endTime - startTime)); } @Override public void destroy() { logger.info("销毁过滤器2"); } } ``` **在配置中注册自定义的过滤器，通过`FilterRegistrationBean` 的`setOrder` 方法可以决定 Filter 的执行顺序。** ```java @Configuration public class MyFilterConfig { @Autowired MyFilter myFilter; @Autowired MyFilter2 myFilter2; @Bean public FilterRegistrationBean setUpMyFilter() { FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean<>(); filterRegistrationBean.setOrder(2); filterRegistrationBean.setFilter(myFilter); filterRegistrationBean.setUrlPatterns(new ArrayList<>(Arrays.asList("/api/*"))); return filterRegistrationBean; } @Bean public FilterRegistrationBean setUpMyFilter2() { FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean<>(); filterRegistrationBean.setOrder(1); filterRegistrationBean.setFilter(myFilter2); filterRegistrationBean.setUrlPatterns(new ArrayList<>(Arrays.asList("/api/*"))); return filterRegistrationBean; } } ``` **自定义 Controller 验证过滤器** ```java import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/api") public class MyController { @GetMapping("/hello") public String getHello() throws InterruptedException { Thread.sleep(1000); return "Hello"; } } ``` **实际测试效果如下：** ``` 2019-10-22 22:32:15.569 INFO 1771 --- [ main] g.j.springbootfilter.filter.MyFilter2 : 初始化过滤器2 2019-10-22 22:32:15.569 INFO 1771 --- [ main] g.j.springbootfilter.filter.MyFilter : 初始化过滤器 2019-10-22 22:32:55.199 INFO 1771 --- [nio-8080-exec-1] g.j.springbootfilter.filter.MyFilter2 : 过滤器开始对请求进行预处理2： 请求的接口为2：/api/hello 2019-10-22 22:32:55.199 INFO 1771 --- [nio-8080-exec-1] g.j.springbootfilter.filter.MyFilter : 过滤器开始对请求进行预处理： 请求的接口为：/api/hello 该用户的请求已经处理完毕，请求花费的时间为：1037 该用户的请求已经处理完毕，请求花费的时间为2：1037 ```