cn.dev33.satoken.context.model

接口 SaRequest

public interface SaRequest

Request 包装类

作者:

kong

方法概要

限定符和类型	方法和说明
default java.lang.Object	forward(java.lang.String path) 转发请求
java.lang.String	getCookieValue(java.lang.String name) 在 [Cookie作用域] 里获取一个值
java.lang.String	getHeader(java.lang.String name) 在 [请求头] 里获取一个值
default java.lang.String	getHeader(java.lang.String name, java.lang.String defaultValue) 在 [请求头] 里获取一个值
java.lang.String	getMethod() 返回当前请求的类型
java.lang.String	getParam(java.lang.String name) 在 [请求体] 里获取一个值
default java.lang.String	getParam(java.lang.String name, java.lang.String defaultValue) 在 [请求体] 里获取一个值，值为空时返回默认值
default java.lang.String	getParamNotNull(java.lang.String name) 在 [请求体] 里获取一个值 （此值必须存在，否则抛出异常 ）
java.lang.String	getRequestPath() 返回当前请求path (不包括上下文名称)
java.lang.Object	getSource() 获取底层源对象
java.lang.String	getUrl() 返回当前请求的url，不带query参数，例：http://xxx.com/test
default boolean	hasParam(java.lang.String name) 检测请求是否提供了指定参数
default boolean	isAjax() 此请求是否为Ajax请求
default boolean	isParam(java.lang.String name, java.lang.String value) 检测提供的参数是否为指定值
default boolean	isPath(java.lang.String path) 返回当前请求path是否为指定值

方法详细资料

getSource

java.lang.Object getSource()

获取底层源对象

返回:

see note

getParam

java.lang.String getParam(java.lang.String name)

在 [请求体] 里获取一个值

参数:

name - 键

返回:

值

getParam

default java.lang.String getParam(java.lang.String name,
                                  java.lang.String defaultValue)

在 [请求体] 里获取一个值，值为空时返回默认值

参数:

name - 键

defaultValue - 值为空时的默认值

返回:

值

isParam

default boolean isParam(java.lang.String name,
                        java.lang.String value)

检测提供的参数是否为指定值

参数:

name - 键

value - 值

返回:

是否相等

hasParam

default boolean hasParam(java.lang.String name)

检测请求是否提供了指定参数

参数:

name - 参数名称

返回:

是否提供

getParamNotNull

default java.lang.String getParamNotNull(java.lang.String name)

在 [请求体] 里获取一个值 （此值必须存在，否则抛出异常 ）

参数:

name - 键

返回:

参数值

getHeader

java.lang.String getHeader(java.lang.String name)

在 [请求头] 里获取一个值

参数:

name - 键

返回:

值

getHeader

default java.lang.String getHeader(java.lang.String name,
                                   java.lang.String defaultValue)

在 [请求头] 里获取一个值

参数:

name - 键

defaultValue - 值为空时的默认值

返回:

值

getCookieValue

java.lang.String getCookieValue(java.lang.String name)

在 [Cookie作用域] 里获取一个值

参数:

name - 键

返回:

值

getRequestPath

java.lang.String getRequestPath()

返回当前请求path (不包括上下文名称)

返回:

see note

isPath

default boolean isPath(java.lang.String path)

返回当前请求path是否为指定值

参数:

path - path

返回:

see note

getUrl

java.lang.String getUrl()

返回当前请求的url，不带query参数，例：http://xxx.com/test

返回:

see note

getMethod

java.lang.String getMethod()

返回当前请求的类型

返回:

see note

isAjax

default boolean isAjax()

此请求是否为Ajax请求

返回:

see note

forward

default java.lang.Object forward(java.lang.String path)

转发请求

参数:

path - 转发地址

返回:

任意值