程序包 org.ssssssss.magicapi.core.web

类 RequestHandler

java.lang.Object

org.ssssssss.magicapi.core.web.MagicController

org.ssssssss.magicapi.core.web.RequestHandler

所有已实现的接口:

JsonCodeConstants

public class RequestHandler
extends MagicController

请求入口处理

作者:

mxd

字段概要

字段

修饰符和类型	字段	说明
private static final List<String>	DEFAULT_ALLOW_READ_RESPONSE_HEADERS
private static final Map<String,Object>	EMPTY_MAP
private static final org.slf4j.Logger	logger
private final RequestMagicDynamicRegistry	requestMagicDynamicRegistry
private final ResultProvider	resultProvider

从类继承的字段 org.ssssssss.magicapi.core.web.MagicController

configuration, magicAPIService, magicBackupService

从接口继承的字段 org.ssssssss.magicapi.core.config.JsonCodeConstants

API_NOT_FOUND, BACKUP_NOT_ENABLED, BODY_INVALID, CRON_ID_REQUIRED, DATASOURCE_KEY_INVALID, DS_KEY_CONFLICT, DS_KEY_REQUIRED, DS_URL_REQUIRED, FILE_IS_REQUIRED, FILE_NOT_FOUND, FILE_PATH_NOT_EXISTS, FILE_SAVE_FAILURE, FUNCTION_PATH_REQUIRED, GROUP_ID_REQUIRED, GROUP_NOT_FOUND, HEADER_INVALID, IS_READ_ONLY, MOVE_NAME_CONFLICT, MOVE_PATH_CONFLICT, NAME_INVALID, NAME_REQUIRED, NOT_SUPPORTED_GROUP_TYPE, PARAMETER_INVALID, PATH_CONFLICT, PATH_REQUIRED, PATH_VARIABLE_INVALID, PERMISSION_INVALID, REQUEST_METHOD_REQUIRED, REQUEST_PATH_CONFLICT, REQUEST_PATH_REQUIRED, RESOURCE_LOCKED, RESOURCE_PATH_CONFLICT, SAVE_GROUP_PATH_CONFLICT, SCRIPT_REQUIRED, SECRET_KEY_IS_REQUIRED, SIGN_IS_INVALID, SRC_GROUP_CONFLICT, SUCCESS, TARGET_IS_REQUIRED, TOPIC_ID_REQUIRED, TOPIC_TAG_REPEAT

构造器概要

构造器

构造器	说明
RequestHandler(MagicConfiguration configuration, RequestMagicDynamicRegistry requestMagicDynamicRegistry)

方法概要

修饰符和类型	方法	说明
private Object	afterCompletion(RequestEntity requestEntity, Object returnValue)
private Object	afterCompletion(RequestEntity requestEntity, Object returnValue, Throwable throwable)
private Object	buildResult(RequestEntity requestEntity, JsonCode code, Object data)
private Object	convertValue(DataType dataType, String name, String value)	转换参数类型
private org.ssssssss.script.MagicScriptContext	createMagicScriptContext(String scriptName, RequestEntity requestEntity)	构建 MagicScriptContext
private Object	doPostHandle(RequestEntity requestEntity, Object value)	执行后置拦截器
private Object	doPreHandle(RequestEntity requestEntity)	执行前置拦截器
private Map<String,Object>	doValidate(String scriptName, String comment, List<? extends BaseDefinition> validateParameters, Map<String,Object> parameters, JsonCode jsonCode, boolean disabledUnknownParameter)
private boolean	doValidateBody(String comment, BaseDefinition parameter, Map<String,Object> parameters, JsonCode jsonCode, Class<?> target)
Object	invoke(MagicHttpServletRequest request, MagicHttpServletResponse response, Map<String,Object> pathVariables, Map<String,Object> defaultHeaders, Map<String,Object> parameters)	测试入口、实际请求入口
private Object	invokeRequest(RequestEntity requestEntity)
private Object	processException(RequestEntity requestEntity, Throwable root)
private Object	readRequestBody(MagicHttpServletRequest request)	读取RequestBody
private void	removeUnknownKey(Map<String,Object> src, List<? extends BaseDefinition> definitions)
private Object	response(RequestEntity requestEntity, Object value)	包装返回结果

从类继承的方法 org.ssssssss.magicapi.core.web.MagicController

allowVisit, allowVisit, allowVisit, doValid, entities, invalidLogin

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

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

从接口继承的方法 org.ssssssss.magicapi.core.config.JsonCodeConstants

isTrue, notBlank, notNull

字段详细资料

logger

private static final org.slf4j.Logger logger

EMPTY_MAP

private static final Map<String,Object> EMPTY_MAP

DEFAULT_ALLOW_READ_RESPONSE_HEADERS

private static final List<String> DEFAULT_ALLOW_READ_RESPONSE_HEADERS

resultProvider

private final ResultProvider resultProvider

requestMagicDynamicRegistry

private final RequestMagicDynamicRegistry requestMagicDynamicRegistry

构造器详细资料

RequestHandler

public RequestHandler(MagicConfiguration configuration,
 RequestMagicDynamicRegistry requestMagicDynamicRegistry)

方法详细资料

invoke

@ResponseBody
@Valid(requireLogin=false)
public Object invoke(MagicHttpServletRequest request,
 MagicHttpServletResponse response,
 @PathVariable(required=false)
 Map<String,Object> pathVariables,
 @RequestHeader(required=false)
 Map<String,Object> defaultHeaders,
 @RequestParam(required=false)
 Map<String,Object> parameters)
              throws Throwable

测试入口、实际请求入口

参数:

request - HttpServletRequest

response - HttpServletResponse

pathVariables - 路径变量

parameters - 表单参数无效输入：'&URL参数'

返回:

返回请求结果

抛出:

Throwable - 处理失败抛出的异常

buildResult

private Object buildResult(RequestEntity requestEntity,
 JsonCode code,
 Object data)

removeUnknownKey

private void removeUnknownKey(Map<String,Object> src,
 List<? extends BaseDefinition> definitions)

doValidateBody

private boolean doValidateBody(String comment,
 BaseDefinition parameter,
 Map<String,Object> parameters,
 JsonCode jsonCode,
 Class<?> target)

doValidate

private Map<String,Object> doValidate(String scriptName,
 String comment,
 List<? extends BaseDefinition> validateParameters,
 Map<String,Object> parameters,
 JsonCode jsonCode,
 boolean disabledUnknownParameter)

convertValue

private Object convertValue(DataType dataType,
 String name,
 String value)

转换参数类型

invokeRequest

private Object invokeRequest(RequestEntity requestEntity)
                      throws Throwable

抛出:

Throwable

processException

private Object processException(RequestEntity requestEntity,
 Throwable root)
                         throws Throwable

抛出:

Throwable

readRequestBody

private Object readRequestBody(MagicHttpServletRequest request)
                        throws IOException

读取RequestBody

抛出:

IOException

createMagicScriptContext

private org.ssssssss.script.MagicScriptContext createMagicScriptContext(String scriptName,
 RequestEntity requestEntity)

构建 MagicScriptContext

response

private Object response(RequestEntity requestEntity,
 Object value)

包装返回结果

doPostHandle

private Object doPostHandle(RequestEntity requestEntity,
 Object value)
                     throws Exception

执行后置拦截器

抛出:

Exception

afterCompletion

private Object afterCompletion(RequestEntity requestEntity,
 Object returnValue)

afterCompletion

private Object afterCompletion(RequestEntity requestEntity,
 Object returnValue,
 Throwable throwable)

doPreHandle

private Object doPreHandle(RequestEntity requestEntity)
                    throws Exception

执行前置拦截器

抛出:

Exception