com.jfinal.server.undertow

类 UndertowServer

java.lang.Object

com.jfinal.server.undertow.UndertowServer

public class UndertowServer
extends Object

UndertowServer 官方示例：https://github.com/undertow-io/undertow/tree/master/examples/src/main/java/io/undertow/examples 注意：关闭服务时使用：kill pid，不要使用：kill -9 pid， 否则 JFinalConfig.beforeJFinalStop() 不会被回调 文档： http://undertow.io/undertow-docs/undertow-docs-2.0.0/index.html https://blog.csdn.net/zhaowen25/article/details/45324805

字段概要

字段

限定符和类型	字段和说明
protected io.undertow.Undertow.Builder	builder
protected UndertowConfig	config
protected Consumer<UndertowConfig>	configConsumer
protected DecimalFormat	decimalFormat
protected io.undertow.servlet.api.DeploymentInfo	deploymentInfo
protected io.undertow.servlet.api.DeploymentManager	deploymentManager
protected HotSwapWatcher	hotSwapWatcher
protected BiConsumer<ClassLoader,io.undertow.servlet.api.DeploymentInfo>	onDeployConsumer
protected Consumer<io.undertow.Undertow.Builder>	onStartConsumer
protected boolean	started
protected io.undertow.Undertow	undertow
String	version
protected Consumer<WebBuilder>	webBuilder

构造器概要

构造器

限定符	构造器和说明
protected	UndertowServer(UndertowConfig undertowConfig)

方法概要

限定符和类型	方法和说明
UndertowServer	addHotSwapClassPrefix(String prefix) 仅用于解决项目的 JFinalConfig 继承类打成 jar 包，并且使用 undertow.devMode=true 配置 时报出的异常，以上两个条件没有同时成立时无需理会，也就是说没有报异常就无需理会 假定项目中的 JFinalConfig 的继承类 com.abc.MyConfig 被打进了 jar 包并且 undertow.devMode 设置成了 true，这里在启动项目的时候由于 ClassLoader 不同会报出以下异常： Can not create instance of class: com.abc.MyConfig.
UndertowServer	addSystemClassPrefix(String prefix)
UndertowServer	config(Consumer<UndertowConfig> configConsumer) config 便于使用 lambda 直接拿到 UndertowConfig 对象进行更多更灵活的配置， 例子： UndertowServer .create(AppConfig.class) .config( config -> { config.setHost("0.0.0.0"); config.setSessionTimeout(30 * 60); }) .start();
protected io.undertow.server.HttpHandler	configGzip(io.undertow.server.HttpHandler pathHandler)
protected io.undertow.server.HttpHandler	configHandler(io.undertow.server.HttpHandler next) 子类覆盖此方法可以添加 Handler 到 Handler 链条之中
protected void	configHttp()
protected void	configJFinalFilter()
protected void	configJFinalPathKit() 为 com.jfinal.kit.PathKit 注入值，以便支持 jfinal-undertow 的部署方式 该配置要兼顾开发与部署两种场景
protected void	configSessionPersistenceManager() 配置 SessionPersistenceManager，支持 session 热加载
protected io.undertow.server.HttpHandler	configSsl(io.undertow.server.HttpHandler httpHandler)
protected void	configUndertow()
protected void	configWeb()
UndertowServer	configWeb(Consumer<WebBuilder> webBuilder) Filter、Servlet、Listener、WebSocket 组件统一配置入口 例子： UndertowServer.create(AppConfig.class) .configWeb( builder -> { // 配置 Filter builder.addFilter("myFilter", "com.abc.MyFilter"); builder.addFilterUrlMapping("myFilter", "/*"); builder.addFilterInitParam("myFilter", "key", "value"); // 配置 Servlet builder.addServlet("myServlet", "com.abc.MyServlet"); builder.addServletMapping("myServlet", "*.do"); builder.addServletInitParam("myServlet", "key", "value"); // 配置 Listener builder.addListener("com.abc.MyListener"); // 配置 WebSocket，MyWebSocket 需使用 ServerEndpoint 注解 builder.addWebSocketEndpoint("com.abc.MyWebSocket"); }) .start(); 以上代码给出了 Filter、Servlet、Listener、WebSocket 的配置实例，其中 MyWebSocket 需要使用 ServerEndpoint 注解标识其为一个 WebSocket 组件，例如：
static UndertowServer	create(Class<? extends com.jfinal.config.JFinalConfig> jfinalConfigClass) 创建 UndertowServer 尝试使用 "undertow.txt" 以及 "undertow-pro.txt" 初始化 undertow 当配置文件不存在时不抛出异常而是使用默认值进行初始化
static UndertowServer	create(Class<? extends com.jfinal.config.JFinalConfig> jfinalConfigClass, String undertowConfig) 创建 UndertowServer 使用指定的配置文件及其生产环境配置文件初始化 undertow，假定指定的配置文件名为 "abc.txt"，其生产环境配置文件名约定为 "abc-pro.txt" 注意：指定的配置文件必须要存在，而约定的那个生产环境配置文件可以不必存在
static UndertowServer	create(String jfinalConfigClass)
static UndertowServer	create(String jfinalConfigClass, String undertowConfig)
static UndertowServer	create(UndertowConfig undertowConfig) 使用手动构建的 UndertowConfig 对象创建 UndertowServer
protected void	doStart()
protected void	doStop()
protected String	getTimeSpent(long startTime)
UndertowConfig	getUndertowConfig()
protected void	init()
boolean	isDevMode()
boolean	isStarted()
protected void	loadCommandLineParameter() 使用 System.getProperty(...)
static void	main(String[] args) jfinal.sh 脚本中的 MAIN_CLASS 始终配置为 com.jfinal.server.undertow.UndertowServer undertow.txt 中配置 configClass=jfinalConfigClass 指向 JFinalConfig 的继承类 这样就可以避免修改 jfinal.sh，只需修改 undertow.txt 此方法仅适用于无需对 UndertowServer 进行代码配置的场景，例如需要添加 servlet、websocket 的场景则不适用，因为配置文件不支持这些配置
protected boolean	notBlank(String str)
UndertowServer	onDeploy(BiConsumer<ClassLoader,io.undertow.servlet.api.DeploymentInfo> onDeployConsumer) 安插在 DeploymentManager.deploy() 前的钩子方法，目前用于支持添加 shiro 的 EnvironmentLoaderListener，支持 shiro 还需要调用： addHotSwapClassPrefix("org.apache.shiro.")
UndertowServer	onStart(Consumer<io.undertow.Undertow.Builder> onStartConsumer) 安插在启动前的钩子方法，便于用户通过 lambda 表达式进行更多个性化配置 例如以下配置： // In HTTP/1.1, connections are persistent unless declared otherwise. // Adding a "Connection: keep-alive" header to every response would only // add useless bytes.
void	restart() HotSwapWatcher 调用 restart()
UndertowServer	setContextPath(String contextPath)
UndertowServer	setDevMode(boolean devMode) 设置为 true 时支持热加载，开发环境必配置项。
UndertowServer	setGzipEnable(boolean gzipEnable)
UndertowServer	setHost(String host)
UndertowServer	setPort(int port)
UndertowServer	setResourcePath(String resourcePath)
void	start()
static void	start(Class<? extends com.jfinal.config.JFinalConfig> jfinalConfigClass)
static void	start(Class<? extends com.jfinal.config.JFinalConfig> jfinalConfigClass, int port, boolean devMode)
static void	start(String jfinalConfigClass)
static void	start(String jfinalConfigClass, int port, boolean devMode)
void	stop()
protected void	stopSilently()

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

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

字段详细资料

version

public String version

config

protected UndertowConfig config

deploymentInfo

protected io.undertow.servlet.api.DeploymentInfo deploymentInfo

deploymentManager

protected io.undertow.servlet.api.DeploymentManager deploymentManager

builder

protected io.undertow.Undertow.Builder builder

undertow

protected io.undertow.Undertow undertow

started

protected volatile boolean started

hotSwapWatcher

protected volatile HotSwapWatcher hotSwapWatcher

decimalFormat

protected DecimalFormat decimalFormat

webBuilder

protected Consumer<WebBuilder> webBuilder

configConsumer

protected Consumer<UndertowConfig> configConsumer

onDeployConsumer

protected BiConsumer<ClassLoader,io.undertow.servlet.api.DeploymentInfo> onDeployConsumer

onStartConsumer

protected Consumer<io.undertow.Undertow.Builder> onStartConsumer

构造器详细资料

UndertowServer

protected UndertowServer(UndertowConfig undertowConfig)

方法详细资料

start

public static void start(Class<? extends com.jfinal.config.JFinalConfig> jfinalConfigClass)

start

public static void start(String jfinalConfigClass)

start

public static void start(Class<? extends com.jfinal.config.JFinalConfig> jfinalConfigClass,
                         int port,
                         boolean devMode)

start

public static void start(String jfinalConfigClass,
                         int port,
                         boolean devMode)

create

public static UndertowServer create(Class<? extends com.jfinal.config.JFinalConfig> jfinalConfigClass)

创建 UndertowServer 尝试使用 "undertow.txt" 以及 "undertow-pro.txt" 初始化 undertow 当配置文件不存在时不抛出异常而是使用默认值进行初始化

create

public static UndertowServer create(String jfinalConfigClass)

create

public static UndertowServer create(Class<? extends com.jfinal.config.JFinalConfig> jfinalConfigClass,
                                    String undertowConfig)

创建 UndertowServer 使用指定的配置文件及其生产环境配置文件初始化 undertow，假定指定的配置文件名为 "abc.txt"，其生产环境配置文件名约定为 "abc-pro.txt" 注意：指定的配置文件必须要存在，而约定的那个生产环境配置文件可以不必存在

create

public static UndertowServer create(String jfinalConfigClass,
                                    String undertowConfig)

create

public static UndertowServer create(UndertowConfig undertowConfig)

使用手动构建的 UndertowConfig 对象创建 UndertowServer

start

public void start()

loadCommandLineParameter

protected void loadCommandLineParameter()

使用 System.getProperty(...) 加载命令行传入的 undertow.port 与 undertow.host 参数， 因为这两个参数最有可能在运行项目时进行变动，这个功能可以免去创建 config/undertow-pro.txt 来配置最需要变动的 port 与 host 参数，进一步节省时间 使用示例： java -Dundertow.port=8080 -Dundertow.host=0.0.0.0 -jar jfinal-club-release.jar 传参注意事项： 1：传参规则由 java 命令行给定，与 jfinal undertow 项目完全无关 2：传参以 "-D" 为前缀，并且该前缀与后方的参数名之间不能有空格 3：参数名与参数值中间用等号字符分格，且等号前后不能空格

notBlank

protected boolean notBlank(String str)

doStart

protected void doStart()

configHttp

protected void configHttp()

configSsl

protected io.undertow.server.HttpHandler configSsl(io.undertow.server.HttpHandler httpHandler)

configHandler

protected io.undertow.server.HttpHandler configHandler(io.undertow.server.HttpHandler next)

子类覆盖此方法可以添加 Handler 到 Handler 链条之中

configGzip

protected io.undertow.server.HttpHandler configGzip(io.undertow.server.HttpHandler pathHandler)

init

protected void init()

stop

public void stop()

doStop

protected void doStop()
               throws javax.servlet.ServletException

抛出:

javax.servlet.ServletException

restart

public void restart()

HotSwapWatcher 调用 restart()

getTimeSpent

protected String getTimeSpent(long startTime)

stopSilently

protected void stopSilently()

config

public UndertowServer config(Consumer<UndertowConfig> configConsumer)

config 便于使用 lambda 直接拿到 UndertowConfig 对象进行更多更灵活的配置，

 例子：
 UndertowServer
                .create(AppConfig.class)
                .config( config -> {
                        config.setHost("0.0.0.0");
          config.setSessionTimeout(30 * 60);
                })
                .start();
 

onDeploy

public UndertowServer onDeploy(BiConsumer<ClassLoader,io.undertow.servlet.api.DeploymentInfo> onDeployConsumer)

安插在 DeploymentManager.deploy() 前的钩子方法，目前用于支持添加 shiro 的 EnvironmentLoaderListener，支持 shiro 还需要调用： addHotSwapClassPrefix("org.apache.shiro.")

 支持 shiro 的例子代码如下：
 
 UndertowServer.create("com.mypackage.AppConfig")
     // .addHotSwapClassPrefix("org.apache.shiro.")
     .addHotSwapClassPrefix("org.apache.")
     .configWeb( builder -> {
         builder.addFilter("shiro", "org.apache.shiro.web.servlet.ShiroFilter");
         builder.addFilterUrlMapping("shiro", "/*");
      })
     .onDeploy((classLoader, deploymentInfo) -> {
          try {
              String classStr = "org.apache.shiro.web.env.EnvironmentLoaderListener";
              Class c = classLoader.loadClass(classStr);
              deploymentInfo.addDeploymentCompleteListener((javax.servlet.ServletContextListener)c.newInstance());
          } catch (Exception e) {
              throw new RuntimeException(e);
          }
      })
     .start();
 

onStart

public UndertowServer onStart(Consumer<io.undertow.Undertow.Builder> onStartConsumer)

安插在启动前的钩子方法，便于用户通过 lambda 表达式进行更多个性化配置 例如以下配置： // In HTTP/1.1, connections are persistent unless declared otherwise. // Adding a "Connection: keep-alive" header to every response would only // add useless bytes. builder.setServerOption(UndertowOptions.ALWAYS_SET_KEEP_ALIVE, false)

 例子：
 UndertowServer.create(AppConfig.class)
     .onStart( builder -> {
         builder.setServerOption(UndertowOptions.ALWAYS_SET_KEEP_ALIVE, false);
      })
     .start();
 

configJFinalPathKit

protected void configJFinalPathKit()

为 com.jfinal.kit.PathKit 注入值，以便支持 jfinal-undertow 的部署方式 该配置要兼顾开发与部署两种场景

configUndertow

protected void configUndertow()

configJFinalFilter

protected void configJFinalFilter()

configWeb

protected void configWeb()

configWeb

public UndertowServer configWeb(Consumer<WebBuilder> webBuilder)

Filter、Servlet、Listener、WebSocket 组件统一配置入口

 例子：
 UndertowServer.create(AppConfig.class)
     .configWeb( builder -> {
         // 配置 Filter
         builder.addFilter("myFilter", "com.abc.MyFilter");
         builder.addFilterUrlMapping("myFilter", "/*");
         builder.addFilterInitParam("myFilter", "key", "value");
         
         // 配置 Servlet
         builder.addServlet("myServlet", "com.abc.MyServlet");
         builder.addServletMapping("myServlet", "*.do");
         builder.addServletInitParam("myServlet", "key", "value");
         
         // 配置 Listener
         builder.addListener("com.abc.MyListener");
         
         // 配置 WebSocket，MyWebSocket 需使用 ServerEndpoint 注解
         builder.addWebSocketEndpoint("com.abc.MyWebSocket");
      })
     .start();
 
 
 以上代码给出了 Filter、Servlet、Listener、WebSocket 的配置实例，其中 MyWebSocket
 需要使用 ServerEndpoint 注解标识其为一个 WebSocket 组件，例如：

configSessionPersistenceManager

protected void configSessionPersistenceManager()

配置 SessionPersistenceManager，支持 session 热加载

getUndertowConfig

public UndertowConfig getUndertowConfig()

setHost

public UndertowServer setHost(String host)

setPort

public UndertowServer setPort(int port)

setGzipEnable

public UndertowServer setGzipEnable(boolean gzipEnable)

setContextPath

public UndertowServer setContextPath(String contextPath)

setResourcePath

public UndertowServer setResourcePath(String resourcePath)

setDevMode

public UndertowServer setDevMode(boolean devMode)

设置为 true 时支持热加载，开发环境必配置项。建议在配置文件中进行配置： undertow.devMode=true 配置文件中配置便于生产环境修改该项配置，提升性能 注意：undertow.devMode 与 jfinal 中的 devMode 没有任何关系

isDevMode

public boolean isDevMode()

isStarted

public boolean isStarted()

addHotSwapClassPrefix

public UndertowServer addHotSwapClassPrefix(String prefix)

仅用于解决项目的 JFinalConfig 继承类打成 jar 包，并且使用 undertow.devMode=true 配置 时报出的异常，以上两个条件没有同时成立时无需理会，也就是说没有报异常就无需理会 假定项目中的 JFinalConfig 的继承类 com.abc.MyConfig 被打进了 jar 包并且 undertow.devMode 设置成了 true，这里在启动项目的时候由于 ClassLoader 不同会报出以下异常： Can not create instance of class: com.abc.MyConfig. Please check the config in web.xml 解决办法是使用 addHotSwapClassPrefix(...) : UndertowServer.create(MyConfig.class).addHotSwapClassPrefix("com.abc.").start(); 只添加 JFinalConfig 的继承类 com.abc.MyConfig 也可以： UndertowServer.create(MyConfig.class).addHotSwapClassPrefix("com.abc.MyConfig").start(); 注意：该配置对生产环境无任何影响，在打包部署前无需删除该配置

addSystemClassPrefix

public UndertowServer addSystemClassPrefix(String prefix)

main

public static void main(String[] args)

jfinal.sh 脚本中的 MAIN_CLASS 始终配置为 com.jfinal.server.undertow.UndertowServer undertow.txt 中配置 configClass=jfinalConfigClass 指向 JFinalConfig 的继承类 这样就可以避免修改 jfinal.sh，只需修改 undertow.txt 此方法仅适用于无需对 UndertowServer 进行代码配置的场景，例如需要添加 servlet、websocket 的场景则不适用，因为配置文件不支持这些配置