cn.hutool.http.server

Class SimpleServer

java.lang.Object

cn.hutool.http.server.SimpleServer

public class SimpleServer
extends Object

简易Http服务器，基于HttpServer

Since:

5.2.5

Author:

looly

Constructor Summary

Constructors

Constructor and Description
SimpleServer(InetSocketAddress address) 构造
SimpleServer(InetSocketAddress address, com.sun.net.httpserver.HttpsConfigurator configurator) 构造
SimpleServer(int port) 构造
SimpleServer(String hostname, int port) 构造

Method Summary

Modifier and Type	Method and Description
SimpleServer	addAction(String path, Action action) 增加请求处理规则
SimpleServer	addFilter(com.sun.net.httpserver.Filter filter) 增加请求过滤器，此过滤器对所有请求有效 此方法需在以下方法前之前调用： setRoot(File) setRoot(String) createContext(String, HttpHandler) addHandler(String, HttpHandler) addAction(String, Action)
SimpleServer	addFilter(HttpFilter filter) 增加请求过滤器，此过滤器对所有请求有效 此方法需在以下方法前之前调用： setRoot(File) setRoot(String) createContext(String, HttpHandler) addHandler(String, HttpHandler) addAction(String, Action)
SimpleServer	addHandler(String path, com.sun.net.httpserver.HttpHandler handler) 增加请求处理规则
com.sun.net.httpserver.HttpContext	createContext(String path, com.sun.net.httpserver.HttpHandler handler) 创建请求映射上下文，创建后，用户访问指定路径可使用HttpHandler 中的规则进行处理
InetSocketAddress	getAddress() 获取服务器地址信息
com.sun.net.httpserver.HttpServer	getRawServer() 获得原始HttpServer对象
SimpleServer	setExecutor(Executor executor) 设置自定义线程池
SimpleServer	setRoot(File root) 设置根目录，默认的页面从root目录中读取解析返回
SimpleServer	setRoot(String root) 设置根目录，默认的页面从root目录中读取解析返回
void	start() 启动Http服务器，启动后会阻塞当前线程

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleServer

public SimpleServer(int port)

构造

Parameters:

port - 监听端口

SimpleServer

public SimpleServer(String hostname,
                    int port)

构造

Parameters:

hostname - 监听地址

port - 监听端口

SimpleServer

public SimpleServer(InetSocketAddress address)

构造

Parameters:

address - 监听地址

SimpleServer

public SimpleServer(InetSocketAddress address,
                    com.sun.net.httpserver.HttpsConfigurator configurator)

构造

Parameters:

address - 监听地址

configurator - https配置信息，用于使用自定义SSL（TLS）证书等

Method Detail

addFilter

public SimpleServer addFilter(com.sun.net.httpserver.Filter filter)

增加请求过滤器，此过滤器对所有请求有效
此方法需在以下方法前之前调用：

• setRoot(File)
• setRoot(String)
• createContext(String, HttpHandler)
• addHandler(String, HttpHandler)
• addAction(String, Action)

Parameters:

filter - Filter 请求过滤器

Returns:

this

Since:

5.5.7

addFilter

public SimpleServer addFilter(HttpFilter filter)

增加请求过滤器，此过滤器对所有请求有效
此方法需在以下方法前之前调用：

• setRoot(File)
• setRoot(String)
• createContext(String, HttpHandler)
• addHandler(String, HttpHandler)
• addAction(String, Action)

Parameters:

filter - Filter 请求过滤器

Returns:

this

Since:

5.5.7

addHandler

public SimpleServer addHandler(String path,
                               com.sun.net.httpserver.HttpHandler handler)

增加请求处理规则

Parameters:

path - 路径，例如:/a/b 或者 a/b

handler - 处理器，包括请求和响应处理

Returns:

this

See Also:

createContext(String, HttpHandler)

createContext

public com.sun.net.httpserver.HttpContext createContext(String path,
                                                        com.sun.net.httpserver.HttpHandler handler)

创建请求映射上下文，创建后，用户访问指定路径可使用HttpHandler 中的规则进行处理

Parameters:

path - 路径，例如:/a/b 或者 a/b

handler - 处理器，包括请求和响应处理

Returns:

HttpContext

Since:

5.5.7

setRoot

public SimpleServer setRoot(String root)

设置根目录，默认的页面从root目录中读取解析返回

Parameters:

root - 路径

Returns:

this

setRoot

public SimpleServer setRoot(File root)

设置根目录，默认的页面从root目录中读取解析返回

Parameters:

root - 路径

Returns:

this

addAction

public SimpleServer addAction(String path,
                              Action action)

增加请求处理规则

Parameters:

path - 路径

action - 处理器

Returns:

this

setExecutor

public SimpleServer setExecutor(Executor executor)

设置自定义线程池

Parameters:

executor - Executor

Returns:

this

getRawServer

public com.sun.net.httpserver.HttpServer getRawServer()

获得原始HttpServer对象

Returns:

HttpServer

getAddress

public InetSocketAddress getAddress()

获取服务器地址信息

Returns:

InetSocketAddress

start

public void start()

启动Http服务器，启动后会阻塞当前线程