在springboot中如何使用filter設置要排除的URL

Posted on by

使用filter設置要排除的URL

@WebFilter(urlPatterns = "/*")
@Order(value = 1)
public class TestFilter implements Filter {
 
    private static final Set<String> ALLOWED_PATHS = Collections.unmodifiableSet(new HashSet<>(
            Arrays.asList("/main/excludefilter", "/login", "/logout", "/register")));
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("init-----------filter");
    }
 
    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) res;
        String path = request.getRequestURI().substring(request.getContextPath().length()).replaceAll("[/]+$", "");
        boolean allowedPath = ALLOWED_PATHS.contains(path);
 
        if (allowedPath) {
            System.out.println("這裡是不需要處理的url進入的方法");
            chain.doFilter(req, res);
        }
        else {
            System.out.println("這裡是需要處理的url進入的方法");
        }
    }
 
    @Override
    public void destroy() {
        System.out.println("destroy----------filter");
    }
}

@Order中的value越小，優先級越高。

  • ALLOWED_PATHS

這個是一個集合，存放的是需要排出的URL，用來判斷是否是需要排除的URL。

關於為什麼SpringBoot中使用瞭@WebFilter但是過濾器卻沒有生效：一定要加上@Configuration註解，@Service其實也可以，其他類似。

filter指定過濾URL的常見問題

在使用Filter對一些自己指定的URL進行過濾攔截時

經常會出現如下錯誤

1、 明明在@WebFilter(urlPatterns={“/app/online”})中過濾的是/app/online 路徑，但是運行之後發現，這個WebFilter過濾器對所有的URL都進行瞭過濾。

2、 運行之後發現過濾器沒有初始化，沒有被加載

下面總結一下使用正確的

合適的註解配置filter的方法：

1、 指定路徑

在class 上添加註解@WebFilter(urlPatterns={“/app/online”})

然後在啟動類（**Application.java ）上添加註解@ServletComponentScan

即可。

代碼如下：

2、 過濾所有路徑

在class上添加@Component或@Configuration 即可

如果添加瞭@Component或@Configuration，又添加瞭@WebFilter（），那麼會初始化兩次Filter，並且會過濾所有路徑+自己指定的路徑 ，便會出現對沒有指定的URL也會進行過濾

//過濾所有路徑
@Component
public class WebFilter implements Filter(){
//override三個方法
。。。
。。。
@Override
 public void init (FilterConfig filterConfig) throws ServletException{
 System.out.println("初始化filter");
 }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：