過濾器(Filter)是Servlet中常用的技術,可以實現用戶在訪問某個目標資源之前,對訪問的請求和響應進行攔截,常用的場景有登錄校驗、權限控制、敏感詞過濾等,下面介紹下Spring Boot配置過濾器的兩種方式。
本文目錄
一、@WebFilter注解方式二、@Bean注解方式三、查看運行效果
一、@WebFilter注解方式
使用@WebFilter注解為聲明當前類為filter,第一個參數為該filter起一個名字,第二個參數為說明要攔截的請求地址,當前類需要實現Filter接口,里面有三個方法,分別為過濾器初始化、過濾方法和過濾器銷毀。
@Slf4j
@WebFilter(filterName = "myFilter1", urlPatterns = "/*")
public class MyFilter1 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
log.info(filterConfig.getFilterName() + " init");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
log.info("myFilter1 begin");
try {
log.info("業務方法執行");
chain.doFilter(request, response);
} catch (Exception e) {
log.error("error!", e);
}
log.info("myFilter1 end");
}
@Override
public void destroy() {
}
}
啟動類添加@ServletComponentScan注解,@ServletComponentScan注解所掃描的包路徑必須包含該Filter,代碼如下:
@SpringBootApplication
@ServletComponentScan(basePackages = "com.example.demo.filter")
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
二、@Bean注解方式
新建MyFilter2.java類,不要加注解@WebFilter,代碼如下:
@Slf4j
public class MyFilter2 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
log.info(filterConfig.getFilterName() + " init");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
log.info("myFilter2 begin");
try {
log.info("業務方法執行");
chain.doFilter(request, response);
} catch (Exception e) {
log.error("error!", e);
}
log.info("myFilter2 end");
}
@Override
public void destroy() {
}
}
新建配置類WebConfig.java,配置bean,代碼如下:
@Configuration
public class WebConfig {
@Bean
public FilterRegistrationBean testFilterRegistration() {
FilterRegistrationBean registration = new FilterRegistrationBean(new MyFilter2());
registration.addUrlPatterns("/test"); //
registration.setName("myFilter2");
return registration;
}
}
三、查看運行效果
項目啟動后瀏覽器訪問http://localhost:8080/test,可以看到過濾器已生效,后台打印日志如下:
[nio-8080-exec-1] com.example.demo.filter.MyFilter1 : myFilter1 begin
[nio-8080-exec-1] com.example.demo.filter.MyFilter1 : 業務方法執行
[nio-8080-exec-1] com.example.demo.filter.MyFilter1 : myFilter1 end
到此Spring Boot配置過濾器的兩種方式已經全部實現,有問題歡迎留言溝通哦!
完整源碼地址: https://github.com/suisui2019/springboot-study