com.jfinal.server.undertow

类 PathKitExt

java.lang.Object

com.jfinal.server.undertow.PathKitExt

public class PathKitExt
extends Object

PathKitExt 用于扩展 com.jfinal.kit.PathKit，同时支持开发环境与部署环境 解决 PathKit.getWebRootPath()/getRootClassPath() 在部署环境下无法正常 工作的问题 一、问题描述 1：jfinal-undertow 打包部署启动时在 com.jfinal.core.Config.initEngine() 中 调用 PathKit.getWebRootPath()/detectWebRootPath() 会抛出 NPE 引起异常的原因应该是 JFinal.initPathKit() 中的 servletContext.getRealPath("/") 得到的是一个 null 值，造成 PathKit.setWebRootPath(null) 注入的是 null 值，从而后续 Config.initEngine() 间接调用 PathKit.detectWebRootPath() 引发 NPE 在部署环境之下，由于 servletContext.getRealPath("/") 返回 null，而且 PathKit 中的 ClassLoader.getResource("")、PathKit.class.getResource("/") 也不能正常工作 合力引发 NPE 2：jfinal-undertow 部署方式之下 PathKit.getWebRootPath()、getRootClassPath() 都会报出异常，为 PathKit 的 rootClassPath、webRootPath 事先注入值，避免抛出异常 3：由于 com.jfinal.kit.PathKit 历史久远，为兼容性起见不便进行改造 二、解决方案 1：一种手动处理的办法是用户在 JFinalConfig 继承类中的 configConstant(Constants me) 中调用 PathKit.setWebRootPath()、PathKit.setRootClassPath() 注入值 在该处手动注入的时机处于 JFinal.initPathKit() 之后与 Config.initEngine() 之前 这两个值可以配置在外部配置文件中便于修改，但此法增加了配置工作量 2：通过 PathKitExt 生成合理的 rootClassPath、webRootPath 并通过反射的方式 注入到 com.jfinal.kit.PathKit 之中两个对应的变量之中 关键在于生成的 rootClassPath、webRootPath 值需要同时满足开发环境与打包部署环境 具体的生成逻辑放在 buildRootClassPath()、buildWebRootPath() 的注释中 3：要兼顾三种情况：开发环境、fatjar 部署、"非fatjar" 部署

构造器概要

构造器

构造器和说明
PathKitExt()

方法概要

限定符和类型	方法和说明
static String	getLocationPath() 1：获取 PathKitExt 类文件所处 jar 包文件所在的目录，注意在 "非部署" 环境中获取到的 通常是 maven 本地库中的某个目录，因为在开发时项目所依赖的 jar 包在 maven 本地库中 这种情况不能使用 2：PathKitExt 自身在开发时，也就是未打成 jar 包时，获取到的是 APP_BASE/target/classes 这种情况多数不必关心，因为 PathKitExt 在使用时必定处于 jar 包之中 3：获取到的 locationPath 目录用于生成部署时的 config 目录，该值只会在 "部署" 环境下被获取 也用于生成 webRootPath、rootClassPath，这两个值也只会在 "部署" 时被获取 这样就兼容了部署与非部署两种场景 注意：该路径尾部的 "/" 或 "\\" 已被去除
static String	getRootClassPath()
static String	getWebRootPath()
static String	removeSlashEnd(String path)
static void	setRootClassPath(String rootClassPath) 用途与使用方式与 setWebRootPath(...)
static void	setWebRootPath(String webRootPath) 如果 jfinal-undertow 生成的 path 仍然不能满足需要，可以在 UndertowServer 启动之前 先手动注入值，例如： PathKitExt.setWebRootPath(...); UndertowServer.start(...); 注意：建议优先通过配置 undertow.resourcePath 的方式来解决，例如： undertow.resourcePath = IDEA开发时的module名称/src/main/webapp, src/main/webapp, webapp 上述配置适合于 IDEA 下在 maven module 中启动项目时使用 TODO: 未来在 IDEA 的 maven module 中启动项目的场景下解决一下自动探测该目录的适配问题

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

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

构造器详细资料

PathKitExt

public PathKitExt()

方法详细资料

getLocationPath

public static String getLocationPath()

1：获取 PathKitExt 类文件所处 jar 包文件所在的目录，注意在 "非部署" 环境中获取到的 通常是 maven 本地库中的某个目录，因为在开发时项目所依赖的 jar 包在 maven 本地库中 这种情况不能使用 2：PathKitExt 自身在开发时，也就是未打成 jar 包时，获取到的是 APP_BASE/target/classes 这种情况多数不必关心，因为 PathKitExt 在使用时必定处于 jar 包之中 3：获取到的 locationPath 目录用于生成部署时的 config 目录，该值只会在 "部署" 环境下被获取 也用于生成 webRootPath、rootClassPath，这两个值也只会在 "部署" 时被获取 这样就兼容了部署与非部署两种场景 注意：该路径尾部的 "/" 或 "\\" 已被去除

getRootClassPath

public static String getRootClassPath()

removeSlashEnd

public static String removeSlashEnd(String path)

getWebRootPath

public static String getWebRootPath()

setWebRootPath

public static void setWebRootPath(String webRootPath)

如果 jfinal-undertow 生成的 path 仍然不能满足需要，可以在 UndertowServer 启动之前 先手动注入值，例如： PathKitExt.setWebRootPath(...); UndertowServer.start(...); 注意：建议优先通过配置 undertow.resourcePath 的方式来解决，例如： undertow.resourcePath = IDEA开发时的module名称/src/main/webapp, src/main/webapp, webapp 上述配置适合于 IDEA 下在 maven module 中启动项目时使用 TODO: 未来在 IDEA 的 maven module 中启动项目的场景下解决一下自动探测该目录的适配问题

setRootClassPath

public static void setRootClassPath(String rootClassPath)

用途与使用方式与 setWebRootPath(...) 类似，一般不用