模块 org.redkale

程序包 org.redkale.net.http

注释类型 HttpMapping

@Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface HttpMapping

配合 HttpServlet 使用。 用于对@WebServlet对应的url进行细分。 其url必须是包含WebServlet中定义的前缀， 且不能是正则表达式

详情见: https://redkale.org

作者:

zhangjx

必需元素概要

所需元素

修饰符和类型	必需的元素	说明
String	url	请求地址

可选元素概要

可选元素

修饰符和类型	可选元素	说明
int	actionid	操作ID值，鉴权时用到
boolean	auth	是否鉴权，默认需要鉴权
int	cacheSeconds	结果缓存的秒数, 为0表示不缓存 * 当值大于0，将被缓存一段时间(默认值 seconds=15秒)。
String	comment	备注描述
String	example	返回结果的样例 for OpenAPI Specification 3.1.0
boolean	inherited	是否能被继承, 当 HttpServlet 被继承后该方法是否能被子类继承
String[]	methods	允许方法(不区分大小写),如:GET/POST/PUT,为空表示允许所有方法
String	name	for OpenAPI Specification 3
Class	result	输出结果的数据类型
String	resultRef	输出结果的泛型数据类型在HttpServlet里的字段名,且字段类型必须是 java.lang.reflect.Type 如果输出结果数据类型不是泛型，则值为空
Class[]	results	已过时。
boolean	rpcOnly	是否只接受RPC请求， 默认为false

元素详细资料

url

String url

请求地址

返回:

String

name

String name

for OpenAPI Specification 3

返回:

String

默认值:

""

actionid

int actionid

操作ID值，鉴权时用到

返回:

int

默认值:

0

cacheSeconds

int cacheSeconds

结果缓存的秒数, 为0表示不缓存
* 当值大于0，将被缓存一段时间(默认值 seconds=15秒)。
通常情况下需要 auth() == true 才使用，没有标记auth==true方法一般输出的结果与当前用户信息有关。

返回:

int

默认值:

0

rpcOnly

boolean rpcOnly

是否只接受RPC请求， 默认为false

返回:

默认false

默认值:

false

auth

boolean auth

是否鉴权，默认需要鉴权

返回:

boolean

默认值:

true

methods

String[] methods

允许方法(不区分大小写),如:GET/POST/PUT,为空表示允许所有方法

返回:

String[]

默认值:

{}

inherited

boolean inherited

是否能被继承, 当 HttpServlet 被继承后该方法是否能被子类继承

返回:

boolean

默认值:

true

result

Class result

输出结果的数据类型

返回:

Class

默认值:

void.class

resultRef

String resultRef

输出结果的泛型数据类型在HttpServlet里的字段名,且字段类型必须是 java.lang.reflect.Type
如果输出结果数据类型不是泛型，则值为空

返回:

String

从以下版本开始:

2.5.0

默认值:

""

results

@Deprecated(since="2.5.0")
Class[] results

已过时。

输出结果的数据类型集合，由于结果类型可能是泛型而注解的参数值不支持泛型，因此加入明细数据类型集合

返回:

Class[]

另请参阅:

resultRef()

默认值:

{}

example

String example

返回结果的样例 for OpenAPI Specification 3.1.0

返回:

String

默认值:

""

comment

String comment

备注描述

返回:

String

默认值:

""