springboot自定義過濾器的方法

更新時間：2022年01月05日 10:10:32 作者：clonetx

這篇文章主要為大家詳細介紹了springboot自定義過濾器的方法，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下

過濾器是Servlet的規(guī)范，是基于函數(shù)回調(diào)的，需要實現(xiàn)javax.servlet.Filter接口，依賴于Tomcat等容器，一般用于過濾請求的URL。

1自定義過濾器

自定義filter的實現(xiàn)，本質(zhì)上只有一種方式，就是實現(xiàn)Filter接口。但是在spring中我們有時候也會通過繼承框架提供的XXXFilter，例如OncePerRequestFilter、 AbstractAuthenticationProcessingFilter（Spring Security使用的認證過濾器），當然，這些過濾器所實現(xiàn)的頂層接口還是Filter，只不過框架提供的過濾器都是有其特殊職能的，我們自己實現(xiàn)過濾器基本通過下面兩種方法。

1.1實現(xiàn)Filter接口

public class MyFilterOne implements Filter {
?
? ? @Override
? ? public void destroy() {
? ? ? ? //服務(wù)停止時銷毀;
? ? }
?
? ? @Override
? ? public void doFilter(ServletRequest srequest, ServletResponse sresponse, FilterChain filterChain)
? ? ? ? ? ? throws IOException, ServletException {
? ? ? ??
? ? ? ? System.out.println("this is MyFilter,url :" + request.getRequestURI());
? ? ? ? //1、進入過濾器，通常在這里根據(jù)requet做一些事情
? ? ? ? HttpServletRequest request = (HttpServletRequest) srequest;
? ? ? ? //2、放行，進入下一個過濾器，如果是最后一個過濾器，就執(zhí)行Controller代碼
? ? ? ? filterChain.doFilter(srequest, sresponse);
? ? ? ? //3、回到過濾器，通常在這里對response做一些處理
? ? ? ? HttpServletResponse response = (HttpServletResponse) srequest;
? ? }
?
? ? @Override
? ? public void init(FilterConfig arg0) throws ServletException {
? ? ? ? //服務(wù)啟動時創(chuàng)建;
? ? }
?
}

1.2繼承OncePerRequestFilter

下面的實現(xiàn)，并沒有配置過濾路徑，所有的請求都會進入到這個過濾器，但是它通過@Value獲取配置的url列表，然后用這個列表去和進入過濾器的請求進行對比，如果匹配就做一些操作，如果不匹配直接放行。個人覺得還是配置過濾路徑好。

@Component
@Order(-1)
public class MyFilterThree extends OncePerRequestFilter {
?
? ? private final List<Pattern> uriPatterns = new ArrayList<Pattern>();
?
? ? @Value("#{'${filtered.uris:^$}'.split(',')}")
? ? private List<String> filteredUris;
?
? ? @PostConstruct
? ? public void initialize() {
? ? ? ? for (String uri : this.filteredUris) {
? ? ? ? ? ? try {
? ? ? ? ? ? ? ? this.uriPatterns.add(Pattern.compile(uri));
? ? ? ? ? ? ? ? System.out.println(String.format("符合 '%s' 格式的URI,將進行過濾處理，否則放行.", uri));
?
? ? ? ? ? ? } catch (PatternSyntaxException patternSyntaxException) {
? ? ? ? ? ? ? ? System.out.println("Invalid regular expression pattern in filtered.uris: " + uri);
? ? ? ? ? ? }
? ? ? ? }
? ? }
?
? ? @Override
? ? protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
? ? ? ? System.out.println(httpServletRequest.getRequestURI());
? ? ? ? System.out.println("需要過濾的路徑"+ Arrays.toString(uriPatterns.toArray()));
? ? ? ? System.out.println("進入過濾器了");
? ? ? ? filterChain.doFilter(httpServletRequest, httpServletResponse);//放行
? ? ? ? System.out.println("又回到過濾器了");
? ? }
?
? ? private boolean isMatchedUri(String uri) {
? ? ? ? if (StringUtils.isEmpty(uri)) {
? ? ? ? ? ? return false;
? ? ? ? } else {
? ? ? ? ? ? Iterator var2 = this.uriPatterns.iterator();
?
? ? ? ? ? ? Pattern pattern;
? ? ? ? ? ? do {
? ? ? ? ? ? ? ? if (!var2.hasNext()) {
? ? ? ? ? ? ? ? ? ? return false;
? ? ? ? ? ? ? ? }
?
? ? ? ? ? ? ? ? pattern = (Pattern)var2.next();
? ? ? ? ? ? } while(!pattern.matcher(uri).find());
?
? ? ? ? ? ? return true;
? ? ? ? }
? ? }
}

1.3使過濾器生效配置

使用配置類

@Configuration
public class MyFilterConfiguration {
?
? ? @Bean
? ? public FilterRegistrationBean registerFilter() {
? ? ? ? System.out.println("MyFilterConfiguration");
? ? ? ? FilterRegistrationBean registration = new FilterRegistrationBean();
? ? ? ? registration.setFilter(new MyFilterOne());
? ? ? ? registration.addUrlPatterns("/public/*");//過濾的路徑
? ? ? ? registration.addInitParameter("paramName", "paramValue");
? ? ? ? registration.setName("MyFilter");
? ? ? ? registration.setOrder(1);//在過濾鏈中的執(zhí)行順序
? ? ? ? return registration;
? ? }
}

@WebFilter和@ServletComponentScan(basePackages = "")

個人比較喜歡這個方式，代碼量最小

第一步：在啟動類上添加注解@ServletComponentScan(basePackages = "")

第二步：Filter類添加@WebFilter注解，配置FilterRegistrationBean的屬性@WebFilter基本都有

@WebFilter(urlPatterns = "/selfAnnotation/*")
@Order(-2)
public class MyFilterFive extends OncePerRequestFilter {
?
? ? @Override
? ? protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
?
? ? ? ? System.out.println("進入5號過濾器了");
? ? }
}