cn.dev33.satoken.solon.integration

类 SaTokenFilter

java.lang.Object

cn.dev33.satoken.solon.integration.SaTokenFilter

所有已实现的接口:

org.noear.solon.core.handle.Filter

public class SaTokenFilter
extends Object
implements org.noear.solon.core.handle.Filter

sa-token 基于路由的过滤式鉴权（增加了注解的处理）；使用优先级要低些 对静态文件有处理效果 order: -100 (SaTokenInterceptor 和 SaTokenFilter 二选一；不要同时用)

从以下版本开始:

1.10

作者:

noear

字段概要

字段

限定符和类型	字段和说明
protected cn.dev33.satoken.filter.SaFilterAuthStrategy	auth 认证函数：每次请求执行
protected cn.dev33.satoken.filter.SaFilterAuthStrategy	beforeAuth 前置函数：在每次[认证函数]之前执行
protected cn.dev33.satoken.filter.SaFilterErrorStrategy	error 异常处理函数：每次[认证函数]发生异常时执行此函数
protected List<String>	excludeList 放行路由
protected List<String>	includeList 拦截路由
boolean	isAnnotation 是否打开注解鉴权

构造器概要

构造器

构造器和说明
SaTokenFilter()

方法概要

限定符和类型	方法和说明
SaTokenFilter	addExclude(String... paths) 添加 [放行路由]
SaTokenFilter	addInclude(String... paths) 添加 [拦截路由]
void	doFilter(org.noear.solon.core.handle.Context ctx, org.noear.solon.core.handle.FilterChain chain)
List<String>	getExcludeList() 获取 [放行路由] 集合
List<String>	getIncludeList() 获取 [拦截路由] 集合
SaTokenFilter	setAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy auth) 写入[认证函数]: 每次请求执行
SaTokenFilter	setBeforeAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth) 写入[前置函数]：在每次[认证函数]之前执行
SaTokenFilter	setError(cn.dev33.satoken.filter.SaFilterErrorStrategy error) 写入[异常处理函数]：每次[认证函数]发生异常时执行此函数
SaTokenFilter	setExcludeList(List<String> pathList) 写入 [放行路由] 集合
SaTokenFilter	setIncludeList(List<String> pathList) 写入 [拦截路由] 集合

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

isAnnotation

public boolean isAnnotation

是否打开注解鉴权

includeList

protected List<String> includeList

拦截路由

excludeList

protected List<String> excludeList

放行路由

auth

protected cn.dev33.satoken.filter.SaFilterAuthStrategy auth

认证函数：每次请求执行

error

protected cn.dev33.satoken.filter.SaFilterErrorStrategy error

异常处理函数：每次[认证函数]发生异常时执行此函数

beforeAuth

protected cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth

前置函数：在每次[认证函数]之前执行

构造器详细资料

SaTokenFilter

public SaTokenFilter()

方法详细资料

addInclude

public SaTokenFilter addInclude(String... paths)

添加 [拦截路由]

参数:

paths - 路由

返回:

对象自身

addExclude

public SaTokenFilter addExclude(String... paths)

添加 [放行路由]

参数:

paths - 路由

返回:

对象自身

setIncludeList

public SaTokenFilter setIncludeList(List<String> pathList)

写入 [拦截路由] 集合

参数:

pathList - 路由集合

返回:

对象自身

setExcludeList

public SaTokenFilter setExcludeList(List<String> pathList)

写入 [放行路由] 集合

参数:

pathList - 路由集合

返回:

对象自身

getIncludeList

public List<String> getIncludeList()

获取 [拦截路由] 集合

返回:

see note

getExcludeList

public List<String> getExcludeList()

获取 [放行路由] 集合

返回:

see note

setAuth

public SaTokenFilter setAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy auth)

写入[认证函数]: 每次请求执行

参数:

auth - see note

返回:

对象自身

setError

public SaTokenFilter setError(cn.dev33.satoken.filter.SaFilterErrorStrategy error)

写入[异常处理函数]：每次[认证函数]发生异常时执行此函数

参数:

error - see note

返回:

对象自身

setBeforeAuth

public SaTokenFilter setBeforeAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth)

写入[前置函数]：在每次[认证函数]之前执行

参数:

beforeAuth - see note

返回:

对象自身

doFilter

public void doFilter(org.noear.solon.core.handle.Context ctx,
                     org.noear.solon.core.handle.FilterChain chain)
              throws Throwable

指定者:

doFilter 在接口中 org.noear.solon.core.handle.Filter

抛出:

Throwable