快捷導(dǎo)航

SpringBoot項(xiàng)目中filter的兩種使用詳解

更新時(shí)間：2025年10月29日 14:47:03 作者：0和1搭建網(wǎng)絡(luò)世界

文章介紹了兩種方式在Spring Boot中創(chuàng)建和配置過濾器：使用`@WebFilter`注解和`@ServletComponentScan`注解,以及通過`@Bean`注解自定義過濾器并加載到IOC容器,通過測試啟動(dòng)項(xiàng)目并訪問指定URL,可以查看控制臺打印的過濾器執(zhí)行順序結(jié)果

一、添加依賴

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.3</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.10</version>
        </dependency>
    </dependencies>

二、@WebFilter方式

@WebFilter(filterName = "myFilter",urlPatterns = "/*")
@Slf4j
@Order(value = 2) //存在多個(gè)filter時(shí) 指定filter執(zhí)行順序
public class MyFilter02 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("=======過濾器初始化2=======");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        log.info("過濾器2：請求的sessionID為{},請求的url為{}",httpServletRequest.getSession().getId(),httpServletRequest.getRequestURL());
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {

    }
}

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

啟動(dòng)類中@ServletComponentScan注解和@WebFilter注解配合使用，@ServletComponentScan注解會自動(dòng)掃描帶有@WebFilter注解的類

三、@Bean注解方式

先自定義一個(gè)過濾器：

@Slf4j
public class MyFilter01 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("=====初始化過濾器1======");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        log.info("過濾器1：請求路徑：{}",httpServletRequest.getRequestURL());
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {

    }
}

將自定義的過濾器加載到ioc容器中

@Configuration
public class AddFilters {

    @Bean
    public FilterRegistrationBean addFilter(){
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new MyFilter01());
        filterRegistrationBean.setOrder(1);
        filterRegistrationBean.addUrlPatterns("/*");
        return filterRegistrationBean;
    }
}

上面可以看出，通過兩種方式分別創(chuàng)建了filter01和filter02兩個(gè)過濾器，并分別指定了他們執(zhí)行的順序

三、測試

@RestController
@RequestMapping("/user")
public class UserController {

    @GetMapping("/getUserInfo")
    public String getUserInfo(){
        return "獲取成功";
    }
}

啟動(dòng)項(xiàng)目：訪問http://localhost:8080/user/getUserInfo

查看控制臺打印的結(jié)果：