Filter

Filter屬于Servlet規(guī)范，并不是Spring獨(dú)有的。Filter主要用于攔截請(qǐng)求，做一些業(yè)務(wù)邏輯操作，然后可以決定請(qǐng)求是否可以繼續(xù)往下分發(fā)，落到其他的Filter或者對(duì)應(yīng)的Servlet。

Filter的工作流程

1. 進(jìn)入filter，執(zhí)行相關(guān)業(yè)務(wù)邏輯
2. 若判定失敗，直接返回，不需要將請(qǐng)求發(fā)給Servlet
3. 若判定通行，進(jìn)行入下一個(gè)filter
4. 如果全部filter通行，進(jìn)入Servlet邏輯，Servlet執(zhí)行完畢之后，又返回Filter，最后在返回給請(qǐng)求方

自定義Filter的使用方式

Spring中過(guò)濾器Filter不同使用方式都是通過(guò)：FilterRegistrationBean包裝filter，最終注冊(cè)到Servlet容器中。

1. @WebFilter+@ServletComponentScan

在SpringBootApplication上添加@ServletComponentScan注解，在Filter上添加@WebFilter注解。

該方式的缺點(diǎn)：無(wú)法設(shè)置過(guò)濾器之間的優(yōu)先級(jí)。

@WebFilter+@ServletComponentScan方式無(wú)法通過(guò)@Order注解指定過(guò)濾器優(yōu)先級(jí)：優(yōu)先級(jí)使用默認(rèn)值Ordered.LOWEST_PRECEDENCE（2147483647），相同優(yōu)先級(jí)的情況下，根據(jù)名字先后順序來(lái)決定。

使用方法

1. 在SpringBootApplication上使用@ServletComponentScan注解

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

2.在Filter上使用@WebFilter注解

@WebFilter(urlPatterns = {"/test3"})
public class MyFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        System.out.println("======= MyFilter =======");
        filterChain.doFilter(request,response);
    }
}

@WebFilter

@WebFilter用于將一個(gè)類聲明為過(guò)濾器。

WebFilter注解的主要屬性：

在SpringBoot項(xiàng)目中，@WebServlet、@WebFilter、@WebListener這三個(gè)注解默認(rèn)是不會(huì)被掃描的，一般在SpringBootApplication上添加@ServletComponentScan注解，表示對(duì)這三個(gè)注解的掃描。

@ServletComponentScan可以實(shí)現(xiàn)將Servlet（控制器）、Filter（過(guò)濾器）、Listener（監(jiān)聽器）自動(dòng)注冊(cè)到Spring容器中，無(wú)需其他代碼。

• Servlet：通過(guò)@WebServlet注解定義
• Filter：通過(guò)@WebFilter注解定義
• Listener：通過(guò)@WebListener注解定義

常見問(wèn)題分析

1. 只使用@WebFilte：過(guò)濾器不生效

WebFilter屬于注解屬于Servlet3+，與Spring本身沒(méi)有什么關(guān)系，所以Spring默認(rèn)是不認(rèn)識(shí)這個(gè)注解的。

2. @WebFilter+@Component：配置的過(guò)濾條件不生效 同上，Spring是不認(rèn)識(shí)@WebFilter注解的，所以注解配置的任何屬性都無(wú)意義（例如：指定過(guò)濾的url）。 該種方式其實(shí)就等同于只加了個(gè)@Component注解，此時(shí)過(guò)濾器能生效，但無(wú)過(guò)濾條件，會(huì)過(guò)濾所有url。

3. @WebFilter+@Component+@ServletComponentScan：過(guò)濾器會(huì)被調(diào)用兩次

• 一次：@WebFilter+@ServletComponentScan，被SpringBean管理，過(guò)濾器生效，根據(jù)@WebFilter配置的屬性過(guò)濾
• 二次：@Component，又被SpringBean管理一次，過(guò)濾器生效（和上面不是同一個(gè)bean），過(guò)濾全部url

4. @WebFilter+@Order+@ServletComponentScan：設(shè)置過(guò)濾器優(yōu)先級(jí)無(wú)效

通過(guò)@WebFilter+@ServletComponentScan方式注冊(cè)的，其生成的FilterRegistrationBean并沒(méi)有檢查@Order注解，所以@Order注解不生效。

2. @Component+@Order

通過(guò)在Filter上加@Component和@Order注解，即可被Spring管理，并可指定過(guò)濾器的執(zhí)行順序。

該方式的缺點(diǎn)：只能過(guò)濾所有URL，不能通過(guò)配置去過(guò)濾指定的 URL。

使用方法

@Order(100)
@Component
public class MyFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        System.out.println("======= MyFilter =======");
        filterChain.doFilter(request,response);
    }
}

3. FilterRegistrationBean（推薦）

直接通過(guò)配置類定義Filter的FilterRegistrationBean，交給SpringBean容器管理。

該方式既能通過(guò)配置去過(guò)濾指定的 URL，也能指定過(guò)濾器之間的優(yōu)先級(jí)。

使用方法

public class MyFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        System.out.println("======= MyFilter =======");
        filterChain.doFilter(request,response);
    }
}

@Configuration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean<MyFilter> filterRegistrationBean() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(myFilter());
        registration.setName("myFilter");
        registration.addUrlPatterns("/test3");
        registration.setOrder(100);
        return registration;
    }
    @Bean
    public MyFilter myFilter() {
        return new MyFilter();
    }
}

到此這篇關(guān)于SptingBoot過(guò)濾器Filter的使用詳解的文章就介紹到這了,更多相關(guān)SptingBoot過(guò)濾器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論