模块 org.redkale
程序包 org.redkale.net.http
HTTP协议包,提供HTTP协议服务器
-
接口概要 接口 说明 HttpRender HTTP输出引擎的基类
HttpRender主要是给HttpResponse.finish(Object obj)提供指定数据类型的输出策略。HttpRpcAuthenticator rpc鉴权验证器RestHeaders 用于RestService类的方法的参数获取HttpHeadersRestParams 用于RestService类的方法的参数获取HttpParamsWebSocketParam 供WebSocket.preOnMessage 方法获取RestWebSocket里OnMessage方法的参数WebSocketUserAddress userid 与 sncpaddress组合对象 -
类概要 类 说明 HttpContext HTTP服务的上下文对象HttpContext.HttpContextConfig HttpContext.UriPathNode HttpDispatcherServlet HTTP Servlet的总入口，请求在HttpDispatcherServlet中进行分流。HttpDispatcherServlet.MappingEntry HttpFilter HTTP 过滤器
可通过Priority进行顺序设置HttpHeaders Http Header ObjectHttpParameters HttpRequest Http请求包 与javax.servlet.http.HttpServletRequest 基本类似。HttpResourceServlet 静态资源HttpServletHttpResourceServlet.FileEntry HttpResponse Http响应包 与javax.servlet.http.HttpServletResponse 基本类似。HttpResponse.HttpResponseConfig HttpResult<T> 详情见: https://redkale.orgHttpRpcSecretAuthenticator rpc鉴权验证器Secret key的实现类HttpScope HTTP输出引擎的对象域
输出引擎的核心类, 业务开发人员只有通过本类对象才能调用到输出引擎功能。HttpServer Http服务器HttpServlet HTTP版的Servlet， 执行顺序 execute --> preExecute --> authenticate --> HttpMapping对应的方法HttpServlet.ActionEntry MimeType MimeTypeMultiContext HTTP的文件上传请求的上下文对象MultiPart 详情见: https://redkale.orgRest 详情见: https://redkale.orgWebClient 简单的HttpClient实现, 存在以下情况不能使用此类:
1、使用HTTPS；
2、上传下载文件；
3、返回超大响应包；
类似JDK11的 java.net.http.HttpClientWebRequest HttpRequest的缩减版, 只提供部分字段WebResult<T> 详情见: https://redkale.orgWebSocket<G extends Serializable,T> WebSocketAction WebSocket.broadcastAction时的参数WebSocketAddress 存放用户WS连接的SNCP地址和MQ topic， 当消息使用MQ代理时，topic才会有值WebSocketEngine 详情见: https://redkale.orgWebSocketFuture WebSocket连接的IO写线程WebSocketNode 注: 部署了WebSocketNodeService就必然要配置SNCP协议的Server，不然无法做到WebSocketNode.sendMessage方法的有效性WebSocketNodeService 详情见: https://redkale.orgWebSocketPacket 详情见: https://redkale.orgWebSocketRange WebSocket.broadcastMessage时的过滤条件WebSocketReadHandler WebSocketServlet WebSocketUserAddress.SimpleWebSocketUserAddress WebSocketWriteHandler WebSocketWriteHandler.WebSocketFuture<T> -
枚举概要 枚举 说明 HttpParam.HttpParameterStyle 配合 @HttpParam 使用。WebSocketPacket.FrameType WebSocketPacket.MessageType -
异常错误概要 异常错误 说明 HttpException Http自定义异常类RestException Rest自定义异常类 -
注释类型概要 注释类型 说明 HttpMapping 配合 HttpServlet 使用。HttpParam 配合 @HttpMapping 使用。HttpParam.HttpParams HttpUserType 配合 HttpServlet 使用 用于指定HttpRequest.currentUser的数据类型
注意： 数据类型是JavaBean， 不能是基本数据类型、String、byte[]、File等Java内置的数据类型Rest.RestDyn 用于标记由Rest.createRestServlet 方法创建的RestServletRest.RestDynSourceType 用于标记由Rest.createRestServlet 方法创建的RestServletRestAddress 只能注解于Service类的方法的String参数或参数内的String字段RestBody 只能注解于RestService类的方法的String/byte[]/JavaBean参数或参数内的String/byte[]/JavaBean字段RestConvert 只能依附在Service实现类的public方法上, 当方法的返回值以JSON输出时对指定类型的转换设定。RestConvert.RestConverts RestConvertCoder 指定class某个字段的自定义序列化和反序列化策略。RestConvertCoder.RestConvertCoders RestCookie 只能注解于RestService类的方法的String参数或参数内的String字段RestDeleteMapping DELETE方法版RestMappingRestDeleteMapping.RestDeleteMappings RestGetMapping GET方法版RestMappingRestGetMapping.RestGetMappings RestHeader 只能注解于RestService类的方法的参数或参数内的String、java.net.InetSocketAddress字段RestLocale 只能注解于Service类的方法的String参数或参数内的String字段RestMapping 只能依附在Service实现类的public方法上，且方法如果throws只能是IOException
value默认为"/" + Service的类名去掉Service字样的小写字符串 (如HelloService，的默认路径为/hello)。RestMapping.RestMappings RestOnMessage 标记在RestWebSocket的接收消息方法上;
注意：被标记的方法必须同时符合以下条件:
1、必须修饰为public 2、不能修饰为final和static 3、返回值必须是void 4、不能throws检查型异常RestParam 依附在RestService类的方法的参数上
name='&' 表示当前用户
name='#'表示截取uri最后一段
name='#xxx:'表示从uri中/pipes/xxx:v/截取xxx:的值RestPatchMapping PATCH方法版RestMappingRestPatchMapping.RestPatchMappings RestPath 只能注解于Service类的方法的String参数或参数内的String字段RestPostMapping POST方法版RestMappingRestPostMapping.RestPostMappings RestPutMapping PUT方法版RestMappingRestPutMapping.RestPutMappings RestService 只能依附在Service类上，name默认为Service的类名小写并去掉Service字样及后面的字符串 (如HelloService/HelloServiceImpl，的默认路径为 hello)。RestSessionid 只能注解于Service类的方法的参数或参数内的String字段RestUploadFile 依附在RestService类的方法的参数上, 用于接收上传文件
只能标记在byte[]/File/File[] 类型的参数上RestUserid 只能注解于Service类的方法的参数或参数内的Serializable字段RestWebSocket 只能依附在WebSocket类上，name默认为Service的类名小写并去掉Service字样及后面的字符串 (如HelloWebSocket/HelloWebSocketImpl，的默认路径为 hello)。WebServlet 功能同JSR 315 (java-servlet 3.0) 规范中的 @WebServlet