抽离过滤器接口 SaFilter

sa-token-starter/sa-token-jfinal-plugin/src/main/java/cn/dev33/satoken/jfinal/SaTokenPathFilter.java

@@ -3,81 +3,50 @@ package cn.dev33.satoken.jfinal;
 import cn.dev33.satoken.exception.SaTokenException;
 import cn.dev33.satoken.filter.SaFilterAuthStrategy;
 import cn.dev33.satoken.filter.SaFilterErrorStrategy;
+import cn.dev33.satoken.filter.SaFilter;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
-public class SaTokenPathFilter {
+public class SaTokenPathFilter implements SaFilter {
 
     // ------------------------ 设置此过滤器 拦截 & 放行 的路由
 
     /**
      * 拦截路由
      */
-    private List<String> includeList = new ArrayList<>();
+    public List<String> includeList = new ArrayList<>();
 
     /**
      * 放行路由
      */
-    private List<String> excludeList = new ArrayList<>();
+    public List<String> excludeList = new ArrayList<>();
 
-    /**
-     * 添加 [拦截路由]
-     * @param paths 路由
-     * @return 对象自身
-     */
+    @Override
     public SaTokenPathFilter addInclude(String... paths) {
         includeList.addAll(Arrays.asList(paths));
         return this;
     }
 
-    /**
-     * 添加 [放行路由]
-     * @param paths 路由
-     * @return 对象自身
-     */
+    @Override
     public SaTokenPathFilter addExclude(String... paths) {
         excludeList.addAll(Arrays.asList(paths));
         return this;
     }
 
-    /**
-     * 写入 [拦截路由] 集合
-     * @param pathList 路由集合
-     * @return 对象自身
-     */
+    @Override
     public SaTokenPathFilter setIncludeList(List<String> pathList) {
         includeList = pathList;
         return this;
     }
 
-    /**
-     * 写入 [放行路由] 集合
-     * @param pathList 路由集合
-     * @return 对象自身
-     */
+    @Override
     public SaTokenPathFilter setExcludeList(List<String> pathList) {
         excludeList = pathList;
         return this;
     }
 
-    /**
-     * 获取 [拦截路由] 集合
-     * @return see note
-     */
-    public List<String> getIncludeList() {
-        return includeList;
-    }
-
-    /**
-     * 获取 [放行路由] 集合
-     * @return see note
-     */
-    public List<String> getExcludeList() {
-        return excludeList;
-    }
-
 
     // ------------------------ 钩子函数
 
@@ -95,34 +64,23 @@ public class SaTokenPathFilter {
 
     /**
      * 前置函数：在每次[认证函数]之前执行
+     *      <b>注意点：前置认证函数将不受 includeList 与 excludeList 的限制，所有路由的请求都会进入 beforeAuth</b>
      */
     public SaFilterAuthStrategy beforeAuth = r -> {};
 
-    /**
-     * 写入[认证函数]: 每次请求执行
-     * @param auth see note
-     * @return 对象自身
-     */
+    @Override
     public SaTokenPathFilter setAuth(SaFilterAuthStrategy auth) {
         this.auth = auth;
         return this;
     }
 
-    /**
-     * 写入[异常处理函数]：每次[认证函数]发生异常时执行此函数
-     * @param error see note
-     * @return 对象自身
-     */
+    @Override
     public SaTokenPathFilter setError(SaFilterErrorStrategy error) {
         this.error = error;
         return this;
     }
 
-    /**
-     * 写入[前置函数]：在每次[认证函数]之前执行
-     * @param beforeAuth see note
-     * @return 对象自身
-     */
+    @Override
     public SaTokenPathFilter setBeforeAuth(SaFilterAuthStrategy beforeAuth) {
         this.beforeAuth = beforeAuth;
         return this;