接口的使用
cn.dev33.satoken.context.model.SaRequest

使用SaRequest的程序包

程序包	说明
cn.dev33.satoken.apikey
cn.dev33.satoken.context
cn.dev33.satoken.context.mock
cn.dev33.satoken.context.model	因为不能确定最终运行的 web 容器属于标准 Servlet 模型还是非 Servlet 模型，特封装此包下的包装类进行对接。
cn.dev33.satoken.fun
cn.dev33.satoken.fun.strategy
cn.dev33.satoken.sign
cn.dev33.satoken.strategy.hooks

cn.dev33.satoken.apikey中SaRequest的使用

参数类型为SaRequest的cn.dev33.satoken.apikey中的方法

修饰符和类型	方法	说明
String	SaApiKeyTemplate.readApiKeyValue(SaRequest request)	数据读取：从请求对象中读取 ApiKey，获取不到返回 null
static String	SaApiKeyUtil.readApiKeyValue(SaRequest request)	数据读取：从请求对象中读取 ApiKey，获取不到返回 null

cn.dev33.satoken.context中SaRequest的使用

返回SaRequest的cn.dev33.satoken.context中的方法

修饰符和类型	方法	说明
static SaRequest	SaHolder.getRequest()	获取当前请求的 Request 包装对象
default SaRequest	SaTokenContext.getRequest()	获取当前上下文的 Request 包装对象
SaRequest	SaTokenContextDefaultImpl.getRequest()
static SaRequest	SaTokenContextForThreadLocalStaff.getRequest()	在当前线程的 SaRequest 包装对象

参数类型为SaRequest的cn.dev33.satoken.context中的方法

修饰符和类型	方法	说明
void	SaTokenContext.setContext(SaRequest req, SaResponse res, SaStorage stg)	初始化上下文
void	SaTokenContextDefaultImpl.setContext(SaRequest req, SaResponse res, SaStorage stg)
default void	SaTokenContextForReadOnly.setContext(SaRequest req, SaResponse res, SaStorage stg)
void	SaTokenContextForThreadLocal.setContext(SaRequest req, SaResponse res, SaStorage stg)
static void	SaTokenContextForThreadLocalStaff.setModelBox(SaRequest request, SaResponse response, SaStorage storage)	初始化当前线程的 [ Box 存储器 ]

cn.dev33.satoken.context.mock中SaRequest的使用

实现SaRequest的cn.dev33.satoken.context.mock中的类

修饰符和类型	类	说明
class	SaRequestForMock	对 SaRequest 包装类的实现（Mock 版）

cn.dev33.satoken.context.model中SaRequest的使用

声明为SaRequest的cn.dev33.satoken.context.model中的字段

修饰符和类型	字段	说明
SaRequest	SaTokenContextModelBox.request

返回SaRequest的cn.dev33.satoken.context.model中的方法

修饰符和类型	方法	说明
SaRequest	SaTokenContextModelBox.getRequest()

参数类型为SaRequest的cn.dev33.satoken.context.model中的方法

修饰符和类型	方法	说明
void	SaTokenContextModelBox.setRequest(SaRequest request)

参数类型为SaRequest的cn.dev33.satoken.context.model中的构造器

限定符	构造器	说明
	SaTokenContextModelBox(SaRequest request, SaResponse response, SaStorage storage)

cn.dev33.satoken.fun中SaRequest的使用

参数类型为SaRequest的cn.dev33.satoken.fun中的方法

修饰符和类型	方法	说明
void	SaRouteFunction.run(SaRequest request, SaResponse response, Object handler)	执行验证的方法

cn.dev33.satoken.fun.strategy中SaRequest的使用

参数类型为SaRequest的cn.dev33.satoken.fun.strategy中的方法

修饰符和类型	方法	说明
void	SaCorsHandleFunction.execute(SaRequest req, SaResponse res, SaStorage sto)	CORS 策略处理函数
void	SaFirewallCheckFunction.execute(SaRequest req, SaResponse res, Object extArg)	执行函数
void	SaFirewallCheckFailHandleFunction.run(FirewallCheckException e, SaRequest req, SaResponse res, Object extArg)	执行函数

cn.dev33.satoken.sign中SaRequest的使用

参数类型为SaRequest的cn.dev33.satoken.sign中的方法

修饰符和类型	方法	说明
void	SaSignTemplate.checkRequest(SaRequest request, String... paramNames)	校验：一个请求的 nonce、timestamp、sign 是否均为合法的，如果不合法，则抛出对应的异常
static void	SaSignUtil.checkRequest(SaRequest request, String... paramNames)	校验：一个请求的 nonce、timestamp、sign 是否均为合法的，如果不合法，则抛出对应的异常
boolean	SaSignTemplate.isValidRequest(SaRequest request, String... paramNames)	判断：一个请求中的 nonce、timestamp、sign 是否均为合法的
static boolean	SaSignUtil.isValidRequest(SaRequest request, String... paramNames)	判断：一个请求中的 nonce、timestamp、sign 是否均为合法的
protected Map<String,String>	SaSignTemplate.takeRequestParam(SaRequest request, String[] paramNames)	从请求中提取指定的参数

cn.dev33.satoken.strategy.hooks中SaRequest的使用

参数类型为SaRequest的cn.dev33.satoken.strategy.hooks中的方法

修饰符和类型	方法	说明
void	SaFirewallCheckHook.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForBlackPath.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForDirectoryTraversal.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForHeader.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForHost.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForHttpMethod.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForParameter.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForPathBannedCharacter.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForPathDangerCharacter.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法
void	SaFirewallCheckHookForWhitePath.execute(SaRequest req, SaResponse res, Object extArg)	执行的方法