- 二、WebServer服务端类
- 2.HTTP服务类
- 2.1类路径
- 2.2 类方法说明
- 2.3 方法速查-实例化方法
- 2.4 方法速查-功能方法
- 2.HTTP服务类
二、WebServer服务端类
2.HTTP服务类
2.1类路径
org.voovan.http.server.WebServer
2.2 类方法说明
- 构造函数
public WebServer() throws IOException
构造HTTP服务对象
配置对象构造实例
public static WebServer newInstance()
- 该方法会使用系统配置文件进行 HttpServer 的初始化。
- 配置对象构造实例
public static WebServer newInstance(WebServerConfig config))
该方法会使用系统配置文件进行 HttpServer 的初始化。配置文件路径/conf目录下。-
config
HTTP服务WebServerConfig的配置对象,类似 web.json 文件中的配置。端口构造实例
public static WebServer newInstance(int port)
-port
HTTP服务监听的端口。
- 该方法会使用系统配置文件进行 HttpServer 的初始化。配置文件路径/conf目录下。
- HTTP 方法响应函数
public WebServer [Method](String routeRegexPath, HttpRouter router)
为 HTTP 方法提供服务,其中 Method 为HTTP(GET、POST等)方法。-
routeRegexPath
服务路径正则匹配,不需要正则的^和$,系统会自动处理。-handler
HttpRouter对象的实例用来支持具体的HTTP事件。自定义 HTTP 方法响应函数
public WebServer otherMethod(String method, String routeRegexPath, HttpRouter router)
为 HTTP 方法提供服务,其中 Method 为HTTP(GET、POST等)方法。-
method
自定义的 HTTP 方法,可以不用符合 HTTP 规范,注意已经实现的HTTP方法响应不会再被这个方法响应。-routeRegexPath
服务路径正则匹配,不需要正则的^和$,系统会自动处理。-handler
HttpRouter对象的实例用来支持具体的HTTP事件。WebSocket响应函数
public void socket(String routeRegexPath, WebSocketRouter router)
- 为WebSocket方法提供服务。-
routeRegexPath
服务路径正则匹配,不需要正则的^和$,系统会自动处理。-handler
WebSocketRouter对象的实例用来支持具体的WebSocket事件。
2.3 方法速查-实例化方法
WebServer:
方法名 | 说明 |
---|---|
public static WebServer newInstance(WebServerConfig config) | 构建新的 HttpServer,从配置对象读取配置 |
public static WebServer newInstance(int port) | 构建新的 HttpServer,指定服务端口 |
public static WebServer newInstance() | 构建新的 HttpServer,从配置文件读取配置 |
2.4 方法速查-功能方法
HTTPServer:
方法名 | 说明 |
---|---|
public WebServer serve() | 启动服务 |
public WebServerConfig getWebServerConfig() | 获取Http 服务配置对象 |
public WebServer get(String routeRegexPath, HttpRouter router) | 注册 get 请求路由 |
public WebServer post(String routeRegexPath, HttpRouter router) | 注册 post 请求路由 |
public WebServer head(String routeRegexPath, HttpRouter router) | 注册 head 请求路由 |
public WebServer put(String routeRegexPath, HttpRouter router) | 注册 put 请求路由 |
public WebServer delete(String routeRegexPath, HttpRouter router) | 注册 delete 请求路由 |
public WebServer trace(String routeRegexPath, HttpRouter router) | 注册 trace 请求路由 |
public WebServer connect(String routeRegexPath, HttpRouter router) | 注册 connect 请求路由 |
public WebServer options(String routeRegexPath, HttpRouter router) | 注册 options 请求路由 |
public WebServer otherMethod(String method,String routeRegexPath, HttpRouter router) | 注册 自定义请求方法 路由 |
public void socket(String routeRegexPath, WebSocketRouter router) | 注册 WebSocket 请求路由 |