com.byhealth.h5.core

类 HttpService<T extends BaseModel>

java.lang.Object

com.byhealth.h5.core.HttpService<T>

类型参数:

T - 数据模型（泛型输入参数对象）

所有已实现的接口:

ApiInterface<T>, BridgeListenner

public abstract class HttpService<T extends BaseModel>
extends java.lang.Object
implements BridgeListenner, ApiInterface<T>

Http服务类，对http请求进行拦截，转换输入格式，并转发给相应的Restful服务对象。 不包括文件上传接口。

作者:

fanx

字段概要

字段

限定符和类型	字段和说明
private WebService	webServer WebService实例

构造器概要

构造器

构造器和说明
HttpService(WebService webServer) 构造方法

方法概要

限定符和类型	方法和说明
abstract void	doService(T t, io.vertx.ext.web.RoutingContext rc) 处理业务逻辑
WebService	getWebServer() 获取WebServer对象
private void	handleFormat(java.lang.String jsonStr, io.vertx.ext.web.RoutingContext rc) 处理格式转换，把JSON格式的字符串转换成JSON对象(数据模型)。
private void	handleGetRequest(io.vertx.ext.web.RoutingContext rc) 处理GET请求参数
static void	handleHttpResult(ApiReturnObject result, io.vertx.ext.web.RoutingContext rc) 处理http请求结果，返回相应的数据并关闭http连接。
private void	handleRequestBody(io.vertx.ext.web.RoutingContext rc) 处理PUT，DELETE，POST请求参数。
boolean	hasPriority2InvokeApi(io.vertx.ext.web.RoutingContext rc) 是否拥有接口调用的权限, 默认都拥有接口调用权限
private boolean	isValidClientRequest(io.vertx.ext.web.RoutingContext rc) 是否是合法的客户端请求。
void	onFail(int code, java.lang.String errorMsg, io.vertx.ext.web.RoutingContext rc) 错误处理方法
void	onSuccess(ApiReturnObject result, io.vertx.ext.web.RoutingContext rc) 成功处理方法
void	onSuccess(java.lang.String msg, ApiReturnObject result, io.vertx.ext.web.RoutingContext rc) 成功处理方法
void	onSuccess(java.lang.String msg, io.vertx.ext.web.RoutingContext rc) 成功处理方法
private void	routeRestfulPath() 对Restfull风格的路径做路由。

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

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

从接口继承的方法 com.byhealth.h5.core.ApiInterface

getApiPath, getHttpMethod, logInputParameters, returnClass

字段详细资料

webServer

private WebService webServer

WebService实例

构造器详细资料

HttpService

public HttpService(WebService webServer)

构造方法

参数:

webServer - webServer实例

方法详细资料

getWebServer

public WebService getWebServer()

获取WebServer对象

返回:

WebServer对象

onFail

public void onFail(int code,
                   java.lang.String errorMsg,
                   io.vertx.ext.web.RoutingContext rc)

从接口复制的说明: BridgeListenner

错误处理方法

指定者:

onFail 在接口中 BridgeListenner

参数:

code - 错误代码

errorMsg - 错误提示信息

rc - 路由上下文

onSuccess

public void onSuccess(java.lang.String msg,
                      io.vertx.ext.web.RoutingContext rc)

从接口复制的说明: BridgeListenner

成功处理方法

指定者:

onSuccess 在接口中 BridgeListenner

参数:

msg - 提示信息

rc - 路由上下文

onSuccess

public void onSuccess(ApiReturnObject result,
                      io.vertx.ext.web.RoutingContext rc)

从接口复制的说明: BridgeListenner

成功处理方法

指定者:

onSuccess 在接口中 BridgeListenner

参数:

result - 返回结果

rc - 路由上下文

onSuccess

public void onSuccess(java.lang.String msg,
                      ApiReturnObject result,
                      io.vertx.ext.web.RoutingContext rc)

从接口复制的说明: BridgeListenner

成功处理方法

指定者:

onSuccess 在接口中 BridgeListenner

参数:

msg - 提示信息

result - 返回结果

rc - 路由上下文

hasPriority2InvokeApi

public boolean hasPriority2InvokeApi(io.vertx.ext.web.RoutingContext rc)

从接口复制的说明: ApiInterface

是否拥有接口调用的权限, 默认都拥有接口调用权限

指定者:

hasPriority2InvokeApi 在接口中 ApiInterface<T extends BaseModel>

参数:

rc - 路由上下文

返回:

拥有接口调用权限返回true, 否则返回false

doService

public abstract void doService(T t,
                               io.vertx.ext.web.RoutingContext rc)

处理业务逻辑

参数:

t - 泛型(前端传入的参数对象)

rc - 路由上下文

routeRestfulPath

private void routeRestfulPath()

对Restfull风格的路径做路由。

isValidClientRequest

private boolean isValidClientRequest(io.vertx.ext.web.RoutingContext rc)

是否是合法的客户端请求。 必须开启isOpenRequestSourceProtection配置项，才会做客户端合法与否的检查。

参数:

rc - 路由上下文

返回:

客户端合法返回true

handleGetRequest

private void handleGetRequest(io.vertx.ext.web.RoutingContext rc)

处理GET请求参数

参数:

rc - 路由上下文

handleRequestBody

private void handleRequestBody(io.vertx.ext.web.RoutingContext rc)

处理PUT，DELETE，POST请求参数。

参数:

rc - 路由上下文

handleFormat

private void handleFormat(java.lang.String jsonStr,
                          io.vertx.ext.web.RoutingContext rc)

处理格式转换，把JSON格式的字符串转换成JSON对象(数据模型)。

参数:

jsonStr - JSON格式的字符串

rc - 路由上下文

handleHttpResult

public static void handleHttpResult(ApiReturnObject result,
                                    io.vertx.ext.web.RoutingContext rc)

处理http请求结果，返回相应的数据并关闭http连接。

参数:

rc - 路由上下文

result - 返回结果