cn.dev33.satoken.filter

类 SaServletFilter

java.lang.Object

cn.dev33.satoken.filter.SaServletFilter

所有已实现的接口:

javax.servlet.Filter

@Order(value=-100)
public class SaServletFilter
extends java.lang.Object
implements javax.servlet.Filter

Servlet全局过滤器

作者:

kong

字段概要

字段

限定符和类型	字段和说明
SaFilterAuthStrategy	auth 认证函数：每次请求执行
SaFilterAuthStrategy	beforeAuth 前置函数：在每次[认证函数]之前执行
SaFilterErrorStrategy	error 异常处理函数：每次[认证函数]发生异常时执行此函数

构造器概要

构造器

构造器和说明
SaServletFilter()

方法概要

限定符和类型	方法和说明
SaServletFilter	addExclude(java.lang.String... paths) 添加 [放行路由]
SaServletFilter	addInclude(java.lang.String... paths) 添加 [拦截路由]
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
java.util.List<java.lang.String>	getExcludeList() 获取 [放行路由] 集合
java.util.List<java.lang.String>	getIncludeList() 获取 [拦截路由] 集合
void	init(javax.servlet.FilterConfig filterConfig)
SaServletFilter	setAuth(SaFilterAuthStrategy auth) 写入[认证函数]: 每次请求执行
SaServletFilter	setBeforeAuth(SaFilterAuthStrategy beforeAuth) 写入[前置函数]：在每次[认证函数]之前执行
SaServletFilter	setError(SaFilterErrorStrategy error) 写入[异常处理函数]：每次[认证函数]发生异常时执行此函数
SaServletFilter	setExcludeList(java.util.List<java.lang.String> pathList) 写入 [放行路由] 集合
SaServletFilter	setIncludeList(java.util.List<java.lang.String> pathList) 写入 [拦截路由] 集合

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

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

字段详细资料

auth

public SaFilterAuthStrategy auth

认证函数：每次请求执行

error

public SaFilterErrorStrategy error

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

beforeAuth

public SaFilterAuthStrategy beforeAuth

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

构造器详细资料

SaServletFilter

public SaServletFilter()

方法详细资料

addInclude

public SaServletFilter addInclude(java.lang.String... paths)

添加 [拦截路由]

参数:

paths - 路由

返回:

对象自身

addExclude

public SaServletFilter addExclude(java.lang.String... paths)

添加 [放行路由]

参数:

paths - 路由

返回:

对象自身

setIncludeList

public SaServletFilter setIncludeList(java.util.List<java.lang.String> pathList)

写入 [拦截路由] 集合

参数:

pathList - 路由集合

返回:

对象自身

setExcludeList

public SaServletFilter setExcludeList(java.util.List<java.lang.String> pathList)

写入 [放行路由] 集合

参数:

pathList - 路由集合

返回:

对象自身

getIncludeList

public java.util.List<java.lang.String> getIncludeList()

获取 [拦截路由] 集合

返回:

see note

getExcludeList

public java.util.List<java.lang.String> getExcludeList()

获取 [放行路由] 集合

返回:

see note

setAuth

public SaServletFilter setAuth(SaFilterAuthStrategy auth)

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

参数:

auth - see note

返回:

对象自身

setError

public SaServletFilter setError(SaFilterErrorStrategy error)

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

参数:

error - see note

返回:

对象自身

setBeforeAuth

public SaServletFilter setBeforeAuth(SaFilterAuthStrategy beforeAuth)

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

参数:

beforeAuth - see note

返回:

对象自身

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException

指定者:

doFilter 在接口中 javax.servlet.Filter

抛出:

java.io.IOException

javax.servlet.ServletException

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

指定者:

init 在接口中 javax.servlet.Filter

抛出:

javax.servlet.ServletException

destroy

public void destroy()

指定者:

destroy 在接口中 javax.servlet.Filter