net.hasor.web

接口 Invoker

所有超级接口:

MimeType

所有已知子接口:

RenderInvoker, ValidInvoker

所有已知实现类:

InvokerSupplier, InvokerWrap, RenderInvokerSupplier, ValidInvokerSupplier

public interface Invoker
extends MimeType

请求调用

版本:

: 2016-12-26

作者:

赵永春 (zyc@hasor.net)

字段概要

字段

限定符和类型	字段和说明
static String	REQUEST_KEY 数据池中的key，request对象。
static String	RESPONSE_KEY 数据池中的key，response对象。
static String	RETURN_DATA_KEY 数据池中的key，该数据是表示请求方法的执行返回值。
static String	ROOT_DATA_KEY 数据池中的key，数据池中的自关联，相当于 this的含义。

方法概要

限定符和类型	方法和说明
default void	computeIfAbsent(String key, Function<String,Object> mappingFunction) If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.
String	contentType() 设置内容类型类型，如果没有配置那么会通过 renderType 配置进行自动推断，若 @RenderType 也未配置，那么不会进行任何操作。
void	contentType(String contentType) 设置内容类型类型，如果没有配置那么会通过 renderType 配置进行自动推断，若 @RenderType 也未配置，那么不会进行任何操作。
default <T> T	fillForm(Class<? extends T> formType) 将Request中的参数填充到 formType 类型对象上，formType 的创建将会使用 AppContext.justInject(Object) 方法。
<T> T	fillForm(Class<? extends T> formType, T bean) 将Request中的参数填充到 formType 类型对象上，类型实例由参数指定
default void	forEach(BiConsumer<String,Object> action) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
default Object	get(String key) 从数据池中获取数据
AppContext	getAppContext() 获取当前AppContext 对象。
javax.servlet.http.HttpServletRequest	getHttpRequest() 获取 HttpServletRequest 对象。
javax.servlet.http.HttpServletResponse	getHttpResponse() 获取 HttpServletResponse 对象。
default Object	getOrDefault(String key, Object defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
default <V> V	getOrMap(String key, Function<Object,V> defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
default String	getRequestPath() 获取当前请求路径。
boolean	isLockKey(String key) 判断一个 key 是否被 lock 了。
default Set<String>	keySet() 获取数据容器中已经保存的数据 keys 。
void	lockKey(String key) 将一个 key 进行锁定。
Mapping	ownerMapping() 本次请求的 Action，如果没有命中任何 Mapping 那么会返回空。
default void	put(String key, Object value) /** 将新的值设置到数据池中，如果尝试覆盖已经被锁定的key，会引发 UnsupportedOperationException 类型异常。
default void	putIfAbsent(String key, Object value) If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.
default void	remove(String key) 从数据池中删除数据，如果尝试删除已经被锁定的key，会引发 UnsupportedOperationException 类型异常。

从接口继承的方法 net.hasor.web.MimeType

getMimeType

字段详细资料

RETURN_DATA_KEY

static final String RETURN_DATA_KEY

数据池中的key，该数据是表示请求方法的执行返回值。

另请参阅:

常量字段值

ROOT_DATA_KEY

static final String ROOT_DATA_KEY

数据池中的key，数据池中的自关联，相当于 this的含义。

另请参阅:

常量字段值

REQUEST_KEY

static final String REQUEST_KEY

数据池中的key，request对象。

另请参阅:

常量字段值

RESPONSE_KEY

static final String RESPONSE_KEY

数据池中的key，response对象。

另请参阅:

常量字段值

方法详细资料

getAppContext

AppContext getAppContext()

获取当前AppContext 对象。

getHttpRequest

javax.servlet.http.HttpServletRequest getHttpRequest()

获取 HttpServletRequest 对象。

getHttpResponse

javax.servlet.http.HttpServletResponse getHttpResponse()

获取 HttpServletResponse 对象。

contentType

String contentType()

设置内容类型类型，如果没有配置那么会通过 renderType 配置进行自动推断，若 @RenderType 也未配置，那么不会进行任何操作。

contentType

void contentType(String contentType)

设置内容类型类型，如果没有配置那么会通过 renderType 配置进行自动推断，若 @RenderType 也未配置，那么不会进行任何操作。

ownerMapping

Mapping ownerMapping()

本次请求的 Action，如果没有命中任何 Mapping 那么会返回空。例如在 InvokerFilter 拦截器中经常会看到空的 ownerMapping

keySet

default Set<String> keySet()

获取数据容器中已经保存的数据 keys 。

fillForm

default <T> T fillForm(Class<? extends T> formType)

将Request中的参数填充到 formType 类型对象上，formType 的创建将会使用 AppContext.justInject(Object) 方法。

fillForm

<T> T fillForm(Class<? extends T> formType,
               T bean)

将Request中的参数填充到 formType 类型对象上，类型实例由参数指定

get

default Object get(String key)

从数据池中获取数据

参数:

key - 数据key

remove

default void remove(String key)

从数据池中删除数据，如果尝试删除已经被锁定的key，会引发 UnsupportedOperationException 类型异常。

参数:

key - 数据key

另请参阅:

lockKey(String)

put

default void put(String key,
                 Object value)

/** 将新的值设置到数据池中，如果尝试覆盖已经被锁定的key，会引发 UnsupportedOperationException 类型异常。

参数:

key - 数据key

value - 数据 value

另请参阅:

lockKey(String)

isLockKey

boolean isLockKey(String key)

判断一个 key 是否被 lock 了。

lockKey

void lockKey(String key)

将一个 key 进行锁定。 tips：当对锁定的 key 进行 put 或者 remove 操作时会引发 UnsupportedOperationException 类型异常。

参数:

key - 要被锁定的key，大小写敏感。

getRequestPath

default String getRequestPath()

获取当前请求路径。相当于下面这样的代码：

     String contextPath = httpRequest.getContextPath();
     String requestPath = httpRequest.getRequestURI();
     if (requestPath.startsWith(contextPath)) {
     requestPath = requestPath.substring(contextPath.length());
     }
     return requestPath;
     

forEach

default void forEach(BiConsumer<String,Object> action)

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.

参数:

action - The action to be performed for each entry

抛出:

NullPointerException - if the specified action is null

从以下版本开始:

1.8

putIfAbsent

default void putIfAbsent(String key,
                         Object value)

If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.

参数:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

抛出:

UnsupportedOperationException - if the put operation is not supported by this map

从以下版本开始:

1.8

getOrDefault

default Object getOrDefault(String key,
                            Object defaultValue)

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.

参数:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

返回:

the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key

从以下版本开始:

1.8

getOrMap

default <V> V getOrMap(String key,
                       Function<Object,V> defaultValue)

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.

参数:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

返回:

the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key

从以下版本开始:

1.8

computeIfAbsent

default void computeIfAbsent(String key,
                             Function<String,Object> mappingFunction)

If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.

If the function returns null no mapping is recorded. If the function itself throws an (unchecked) exception, the exception is rethrown, and no mapping is recorded. The most common usage is to construct a new object serving as an initial mapped value or memoized result.

参数:

key - key with which the specified value is to be associated

mappingFunction - the function to compute a value

抛出:

UnsupportedOperationException - if the put operation is not supported by this map

从以下版本开始:

1.8