抽离过滤器接口 SaFilter

sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/filter/SaServletFilter.java

@@ -27,75 +27,43 @@ import cn.dev33.satoken.util.SaTokenConsts;
  *
  */
 @Order(SaTokenConsts.ASSEMBLY_ORDER)
-public class SaServletFilter implements Filter {
+public class SaServletFilter implements SaFilter, Filter {
 
 	// ------------------------ 设置此过滤器 拦截 & 放行 的路由 
 
 	/**
 	 * 拦截路由 
 	 */
-	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 SaServletFilter addInclude(String... paths) {
 		includeList.addAll(Arrays.asList(paths));
 		return this;
 	}
-	
-	/**
-	 * 添加 [放行路由]
-	 * @param paths 路由
-	 * @return 对象自身
-	 */
+
+	@Override
 	public SaServletFilter addExclude(String... paths) {
 		excludeList.addAll(Arrays.asList(paths));
 		return this;
 	}
 
-	/**
-	 * 写入 [拦截路由] 集合
-	 * @param pathList 路由集合 
-	 * @return 对象自身
-	 */
+	@Override
 	public SaServletFilter setIncludeList(List<String> pathList) {
 		includeList = pathList;
 		return this;
 	}
-	
-	/**
-	 * 写入 [放行路由] 集合
-	 * @param pathList 路由集合 
-	 * @return 对象自身
-	 */
+
+	@Override
 	public SaServletFilter 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;
-	}
 
 
 	// ------------------------ 钩子函数
@@ -113,35 +81,24 @@ public class SaServletFilter implements Filter {
 	};
 
 	/**
-	 * 前置函数：在每次[认证函数]之前执行 
+	 * 前置函数：在每次[认证函数]之前执行
+	 *      <b>注意点：前置认证函数将不受 includeList 与 excludeList 的限制，所有路由的请求都会进入 beforeAuth</b>
 	 */
 	public SaFilterAuthStrategy beforeAuth = r -> {};
 
-	/**
-	 * 写入[认证函数]: 每次请求执行 
-	 * @param auth see note 
-	 * @return 对象自身
-	 */
+	@Override
 	public SaServletFilter setAuth(SaFilterAuthStrategy auth) {
 		this.auth = auth;
 		return this;
 	}
 
-	/**
-	 * 写入[异常处理函数]：每次[认证函数]发生异常时执行此函数 
-	 * @param error see note 
-	 * @return 对象自身
-	 */
+	@Override
 	public SaServletFilter setError(SaFilterErrorStrategy error) {
 		this.error = error;
 		return this;
 	}
 
-	/**
-	 * 写入[前置函数]：在每次[认证函数]之前执行
-	 * @param beforeAuth see note 
-	 * @return 对象自身
-	 */
+	@Override
 	public SaServletFilter setBeforeAuth(SaFilterAuthStrategy beforeAuth) {
 		this.beforeAuth = beforeAuth;
 		return this;
@@ -151,8 +108,7 @@ public class SaServletFilter implements Filter {
 	// ------------------------ doFilter
 
 	@Override
-	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
-			throws IOException, ServletException {
+	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
 		
 		try {
 			// 执行全局过滤器