程序包的使用
org.redkale.net.http
-
使用org.redkale.net.http的程序包 程序包 说明 org.redkale.boot 提供Redkale服务器的启动、初始化和加载功能org.redkale.boot.watch 提供系统默认监控包org.redkale.cluster 提供注册服务与发现服务包org.redkale.cluster.spi org.redkale.mq.spi org.redkale.net.http HTTP协议包,提供HTTP协议服务器org.redkale.service Service接口和模式配置包org.redkale.watch 提供Redkale服务的监控、动态部署、数据收集功能 -
org.redkale.boot使用的org.redkale.net.http中的类 类 说明 HttpServer Http服务器WebSocket -
org.redkale.boot.watch使用的org.redkale.net.http中的类 类 说明 RestConvert 只能依附在Service实现类的public方法上, 当方法的返回值以JSON输出时对指定类型的转换设定。RestMapping 只能依附在Service实现类的public方法上，且方法如果throws只能是IOException
value默认为"/" + Service的类名去掉Service字样的小写字符串 (如HelloService，的默认路径为/hello)。RestParam 依附在RestService类的方法的参数上
name='&' 表示当前用户
name='#'表示截取uri最后一段
name='#xxx:'表示从uri中/pipes/xxx:v/截取xxx:的值RestService 只能依附在Service类上，name默认为Service的类名小写并去掉Service字样及后面的字符串 (如HelloService/HelloServiceImpl，的默认路径为 hello)。RestUploadFile 依附在RestService类的方法的参数上, 用于接收上传文件
只能标记在byte[]/File/File[] 类型的参数上 -
org.redkale.cluster使用的org.redkale.net.http中的类 类 说明 HttpResult 详情见: https://redkale.orgWebRequest HttpRequest的缩减版, 只提供部分字段 -
org.redkale.cluster.spi使用的org.redkale.net.http中的类 类 说明 HttpContext HTTP服务的上下文对象HttpDispatcherServlet HTTP Servlet的总入口，请求在HttpDispatcherServlet中进行分流。HttpHeaders Http Header ObjectHttpRequest Http请求包 与javax.servlet.http.HttpServletRequest 基本类似。HttpResponse Http响应包 与javax.servlet.http.HttpServletResponse 基本类似。HttpResult 详情见: https://redkale.orgHttpServer Http服务器HttpServlet HTTP版的Servlet， 执行顺序 execute --> preExecute --> authenticate --> HttpMapping对应的方法WebClient 简单的HttpClient实现, 存在以下情况不能使用此类:
1、使用HTTPS；
2、上传下载文件；
3、返回超大响应包；
类似JDK11的 java.net.http.HttpClientWebRequest HttpRequest的缩减版, 只提供部分字段 -
org.redkale.mq.spi使用的org.redkale.net.http中的类 类 说明 HttpContext HTTP服务的上下文对象HttpRequest Http请求包 与javax.servlet.http.HttpServletRequest 基本类似。HttpResponse Http响应包 与javax.servlet.http.HttpServletResponse 基本类似。HttpResult 详情见: https://redkale.orgHttpServlet HTTP版的Servlet， 执行顺序 execute --> preExecute --> authenticate --> HttpMapping对应的方法WebRequest HttpRequest的缩减版, 只提供部分字段 -
org.redkale.net.http使用的org.redkale.net.http中的类 类 说明 HttpContext HTTP服务的上下文对象HttpContext.HttpContextConfig HttpDispatcherServlet.MappingEntry HttpException Http自定义异常类HttpFilter HTTP 过滤器
可通过Priority进行顺序设置HttpHeaders Http Header ObjectHttpParam 配合 @HttpMapping 使用。HttpParam.HttpParameterStyle 配合 @HttpParam 使用。HttpParameters HttpRender HTTP输出引擎的基类
HttpRender主要是给HttpResponse.finish(Object obj)提供指定数据类型的输出策略。HttpRequest Http请求包 与javax.servlet.http.HttpServletRequest 基本类似。HttpResourceServlet 静态资源HttpServletHttpResourceServlet.FileEntry HttpResourceServlet.WatchThread HttpResponse Http响应包 与javax.servlet.http.HttpServletResponse 基本类似。HttpResponse.HttpResponseConfig HttpResult 详情见: https://redkale.orgHttpRpcAuthenticator rpc鉴权验证器HttpScope HTTP输出引擎的对象域
输出引擎的核心类, 业务开发人员只有通过本类对象才能调用到输出引擎功能。HttpServer Http服务器HttpServlet HTTP版的Servlet， 执行顺序 execute --> preExecute --> authenticate --> HttpMapping对应的方法MultiContext HTTP的文件上传请求的上下文对象MultiPart 详情见: https://redkale.orgRestConvert 只能依附在Service实现类的public方法上, 当方法的返回值以JSON输出时对指定类型的转换设定。RestConvertCoder 指定class某个字段的自定义序列化和反序列化策略。RestDeleteMapping DELETE方法版RestMappingRestGetMapping GET方法版RestMappingRestHeaders 用于RestService类的方法的参数获取HttpHeadersRestMapping 只能依附在Service实现类的public方法上，且方法如果throws只能是IOException
value默认为"/" + Service的类名去掉Service字样的小写字符串 (如HelloService，的默认路径为/hello)。RestParams 用于RestService类的方法的参数获取HttpParamsRestPatchMapping PATCH方法版RestMappingRestPostMapping POST方法版RestMappingRestPutMapping PUT方法版RestMappingWebClient 简单的HttpClient实现, 存在以下情况不能使用此类:
1、使用HTTPS；
2、上传下载文件；
3、返回超大响应包；
类似JDK11的 java.net.http.HttpClientWebRequest HttpRequest的缩减版, 只提供部分字段WebResult 详情见: https://redkale.orgWebSocket WebSocketAction WebSocket.broadcastAction时的参数WebSocketAddress 存放用户WS连接的SNCP地址和MQ topic， 当消息使用MQ代理时，topic才会有值WebSocketEngine 详情见: https://redkale.orgWebSocketFuture WebSocket连接的IO写线程WebSocketNode 注: 部署了WebSocketNodeService就必然要配置SNCP协议的Server，不然无法做到WebSocketNode.sendMessage方法的有效性WebSocketPacket 详情见: https://redkale.orgWebSocketPacket.FrameType WebSocketPacket.MessageType WebSocketParam 供WebSocket.preOnMessage 方法获取RestWebSocket里OnMessage方法的参数WebSocketRange WebSocket.broadcastMessage时的过滤条件WebSocketServlet WebSocketUserAddress userid 与 sncpaddress组合对象WebSocketWriteHandler.WebSocketFuture -
org.redkale.service使用的org.redkale.net.http中的类 类 说明 WebSocketNode 注: 部署了WebSocketNodeService就必然要配置SNCP协议的Server，不然无法做到WebSocketNode.sendMessage方法的有效性WebSocketNodeService 详情见: https://redkale.org -
org.redkale.watch使用的org.redkale.net.http中的类 类 说明 HttpFilter HTTP 过滤器
可通过Priority进行顺序设置HttpServlet HTTP版的Servlet， 执行顺序 execute --> preExecute --> authenticate --> HttpMapping对应的方法