corebox.plugin.gradle.server.CBGServerPlugin.groovy Maven / Gradle / Ivy
The newest version!
package corebox.plugin.gradle.server
import corebox.plugin.gradle.server.extension.CBGServerExtension
import corebox.plugin.gradle.server.task.*
import org.apache.commons.lang3.StringUtils
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.file.FileCollection
import org.gradle.api.plugins.WarPlugin
import org.gradle.api.tasks.SourceSetOutput
/**
*
* 创建作者：xingxiuyi
* 创建日期：2018/3/20
* 版权所属：xingxiuyi
*/
class CBGServerPlugin implements Plugin {
static final String SERVER_EXTENSION_NAME = "cbserver"
static final String WEBAPP_EXTENSION_NAME = "cbweb"
static final String RUN_EXTENSION_NAME = "cbrun"
static final String TASK_GROUP = "corebox"
static final String TASK_EXPLODE_WAR_NAME = "explodedWar"
static final String TASK_EXPLODE_WAR_DIR = "explodedWar"
static final String EMBED_SERVER_GROUP = "com.hreeinfo.commons"
static final String EMBED_SERVER_MODULE = "commons-embed-server"
static final String EMBED_SERVER_MODULE_JETTY = "commons-embed-server-jetty"
static final String EMBED_SERVER_MODULE_JETTY_CLASS = "com.hreeinfo.commons.embed.server.support.EmbedJettyServer"
static final String EMBED_SERVER_MODULE_TOMCAT = "commons-embed-server-tomcat"
static final String EMBED_SERVER_MODULE_TOMCAT_CLASS = "com.hreeinfo.commons.embed.server.support.EmbedTomcatServer"
static final String EMBED_SERVER_MODULE_PAYARA = "commons-embed-server-payara"
static final String EMBED_SERVER_MODULE_PAYARA_CLASS = "com.hreeinfo.commons.embed.server.support.EmbedPayaraServer"
static final String DEFAULT_VERSION_EMBED_SERVER = "1.0"
static final String EMBED_SERVER_DEFAULT_TYPE = "JETTY"
static final String EMBED_SERVER_DEFAULT_TYPE_CLASS = EMBED_SERVER_MODULE_JETTY_CLASS
static final String HOT_RELOAD_TYPE_SPTRING = "spring"
static final String HOT_RELOAD_TYPE_SPTRING_LOADED = "springloaded"
static final String HOT_RELOAD_TYPE_DCEVM = "dcevm"
static final String HOT_RELOAD_TYPE_HOTSWAP = "hotswap"
static final String HOT_RELOAD_TYPE_DEFAULT = HOT_RELOAD_TYPE_HOTSWAP
static final String HOT_RELOAD_DCEVM_PROP = "cbserver.java.dcevm"
static final String HOT_RELOAD_DCEVM_PROP2 = "java.dcevm"
static final String HOT_RELOAD_DCEVM_ENV = "COREBOX_JAVA_DCEVM"
static final String HOT_RELOAD_DCEVM_ARGS_PROP = "cbserver.java.dcevm.args"
static final String HOT_RELOAD_DCEVM_ARGS_PROP2 = "java.dcevm.args"
static final String HOT_RELOAD_DCEVM_ARGS_ENV = "COREBOX_JAVA_DCEVM_ARGS"
static final String HOT_RELOAD_DCEVM_ARGS = "-XXaltjvm=dcevm"
static final String DEFAULT_VERSION_SPRINGLOADED = "1.2.8.RELEASE"
static final String RUNTIME_CONFIG_VERSION_SPRINGLOADED = "version_springloaded"
static final String DEFAULT_VERSION_HOTSWAP = "1.2.0"
static final String RUNTIME_CONFIG_VERSION_HOTSWAP = "version_hotswap"
static final String RUNTIME_CONFIG_DCEVM_JVM = "dcevm"
static final String RUNTIME_CONFIG_DCEVM_ARGS = "dcevm_args"
static final String RUNTIME_CONFIG_HOTSWAP_CONFIG = "hotswap_config"
@Override
void apply(Project project) {
if (project.plugins.findPlugin(WarPlugin) == null) project.plugins.apply(WarPlugin)
if (!project.configurations.findByName(SERVER_EXTENSION_NAME)) {
project.configurations.create(SERVER_EXTENSION_NAME).setVisible(false).setTransitive(true)
.setDescription("用于 cbserver 运行的库依赖 仅在server运行时可见")
}
if (!project.configurations.findByName(WEBAPP_EXTENSION_NAME)) {
project.configurations.create(WEBAPP_EXTENSION_NAME).setVisible(false).setTransitive(true)
.setDescription("用于 cbweb 额外 的war依赖 用于 war overlay 功能")
}
if (!project.configurations.findByName(RUN_EXTENSION_NAME)) {
project.configurations.create(RUN_EXTENSION_NAME).setVisible(false).setTransitive(true)
.setDescription("用于声明 cbserver 运行中 webapp 所额外依赖的包，但此处的依赖并不打包到目标webapp中")
}
CBGServerExtension spe = project.extensions.create(SERVER_EXTENSION_NAME, CBGServerExtension.class)
// 配置 Server
configServerTasks(project, spe)
configServerDependency(project, spe)
}
private static void configServerTasks(Project project, CBGServerExtension spe) {
project.tasks.create(name: TASK_EXPLODE_WAR_NAME, group: TASK_GROUP) {
description = "解压webapp war包（含上级所有的war包） 至目标目录 \${project.buildDir}/${TASK_EXPLODE_WAR_DIR}"
dependsOn WarPlugin.WAR_TASK_NAME
doLast {
CBGServers.explodeWebApps(project, spe)
}
}
project.tasks.withType(CBGServerBaseTask) {
conventionMapping.map("type") { spe.type }
conventionMapping.map("typeClass") { findEmbedServerTypeClass(spe.type) }
conventionMapping.map("port") { spe.port }
conventionMapping.map("daemon") { spe.daemon }
conventionMapping.map("explode") { spe.explode }
conventionMapping.map("context") { spe.context }
conventionMapping.map("workingdir") { spe.workingdir }
conventionMapping.map("configfile") { spe.configfile }
conventionMapping.map("loglevel") { spe.loglevel }
conventionMapping.map("logToConsole") { spe.logToConsole }
conventionMapping.map("jvmArgs") { spe.jvmArgs }
conventionMapping.map("blacklistJars") { spe.blacklistJars }
conventionMapping.map("classesdirs") { spe.classesdirs }
conventionMapping.map("resourcesdirs") { spe.resourcesdirs }
conventionMapping.map("jars") { spe.jars }
conventionMapping.map("serverClasspaths") { spe.serverClasspaths }
conventionMapping.map("extConfigurations") { spe.extConfigurations }
conventionMapping.map("options") { findEmbedServerTypeOptions(spe) }
conventionMapping.map("runtimeConfigs") { spe.runtimeConfigs }
// hotReload 配置
conventionMapping.map("hotReload") { spe.hot }
conventionMapping.map("hotReloadType") { spe.hottype }
conventionMapping.map("hotReloadDCEVM") { spe.runtimeConfigs.get(RUNTIME_CONFIG_DCEVM_JVM) }
conventionMapping.map("hotReloadDCEVMArgs") { spe.runtimeConfigs.get(RUNTIME_CONFIG_DCEVM_ARGS) }
}
project.tasks.create(name: CBGServerRunTask.TASK_NAME_APPRUN, group: TASK_GROUP, type: CBGServerRunTask) {
description = "运行appserver"
dependsOn TASK_EXPLODE_WAR_NAME
conventionMapping.map("webapp") { CBGServers.appRunWebappDir(project, spe) }
conventionMapping.map("classesDirectories") { getMainSourceSetOutputClassesDir(project) }
}
project.tasks.create(name: CBGServerRunDebugTask.TASK_NAME_APPRUN_DEBUG, group: TASK_GROUP, type: CBGServerRunDebugTask) {
description = "运行appserver (DEBUG模式)"
dependsOn TASK_EXPLODE_WAR_NAME
conventionMapping.map("debugPort") { spe.debugPort }
conventionMapping.map("debugConfig") { spe.debugConfig }
conventionMapping.map("webapp") { CBGServers.appRunWebappDir(project, spe) }
conventionMapping.map("classesDirectories") { getMainSourceSetOutputClassesDir(project) }
}
project.tasks.create(name: CBGServerStopTask.TASK_NAME_APPSTOP, group: TASK_GROUP, type: CBGServerStopTask) {
description = "停止appserver"
}
project.tasks.create(name: CBGServerReloadTask.TASK_NAME_APPRELOAD, group: TASK_GROUP, type: CBGServerReloadTask) {
description = "重载appserver 对应的 webapp context"
// TODO reload
}
}
private static void configServerDependency(Project project, CBGServerExtension spe) {
project.afterEvaluate { proj ->
String embedServerType = spe.type
if (!embedServerType) embedServerType = EMBED_SERVER_DEFAULT_TYPE
String embedServerVersion = spe.version
if (!embedServerVersion) {
embedServerVersion = CBGServers.getPluginProperties().getProperty('embed_server.defaultVersion')
if (!embedServerVersion) embedServerVersion = DEFAULT_VERSION_EMBED_SERVER
}
project.logger.info "启动服务器 ${embedServerType}=${embedServerVersion}"
project.dependencies.add SERVER_EXTENSION_NAME, "${EMBED_SERVER_GROUP}:${EMBED_SERVER_MODULE}:${embedServerVersion}"
switch (embedServerType.toUpperCase()) {
case "JETTY":
project.dependencies.add SERVER_EXTENSION_NAME, "${EMBED_SERVER_GROUP}:${EMBED_SERVER_MODULE_JETTY}:${embedServerVersion}"
break
case "TOMCAT":
project.dependencies.add SERVER_EXTENSION_NAME, "${EMBED_SERVER_GROUP}:${EMBED_SERVER_MODULE_TOMCAT}:${embedServerVersion}"
break
case "PAYARA":
project.dependencies.add SERVER_EXTENSION_NAME, "${EMBED_SERVER_GROUP}:${EMBED_SERVER_MODULE_PAYARA}:${embedServerVersion}"
break
default:
project.logger.error "指定的类型 ${spe.type} 无效"
break
}
if (spe.hot) { // 加入 hot reload 模式的依赖库 此处仅应有一个文件
if (CBGServers.isHotReloadTypeSprintLoaded(spe.hottype)) {
String springloadedVersion = spe.runtimeConfigs.get(RUNTIME_CONFIG_VERSION_SPRINGLOADED)
if (!springloadedVersion) {
springloadedVersion = CBGServers.getPluginProperties().getProperty('springloaded.defaultVersion')
if (!springloadedVersion) springloadedVersion = DEFAULT_VERSION_SPRINGLOADED
}
project.dependencies.add SERVER_EXTENSION_NAME, "org.springframework:springloaded:${springloadedVersion}"
} else if (CBGServers.isHotReloadTypeHotSwap(spe.hottype)) {
// HOTSWAP - https://github.com/HotswapProjects/HotswapAgent
// DCEVM - https://github.com/dcevm/dcevm
String hotswapVersion = spe.runtimeConfigs.get(RUNTIME_CONFIG_VERSION_HOTSWAP)
if (!hotswapVersion) {
hotswapVersion = CBGServers.getPluginProperties().getProperty('hotswap.defaultVersion')
if (!hotswapVersion) hotswapVersion = DEFAULT_VERSION_HOTSWAP
}
project.dependencies.add SERVER_EXTENSION_NAME, "com.hreeinfo.commons:hotswap-agent:${hotswapVersion}"
}
}
}
project.beforeEvaluate { proj ->
// TODO 增加依赖解析机制
}
}
@SuppressWarnings("GrDeprecatedAPIUsage")
private static FileCollection getMainSourceSetOutputClassesDir(Project project) {
if (!project) return null
SourceSetOutput output = project.sourceSets.main.output
if (!output) return null
String version = project.gradle.gradleVersion
String majorVersion = StringUtils.substringBefore(version, '.')
int mver = 0
try {
mver = Integer.parseInt(majorVersion)
} catch (Throwable ignored) {
}
if (mver > 0 && mver < 4) {
return project.files(output.classesDir)
} else {
return output.classesDirs.any { it.exists() } ? output.classesDirs : null
}
}
private static String findEmbedServerTypeClass(String type) {
if (!type) EMBED_SERVER_DEFAULT_TYPE_CLASS
switch (type.toUpperCase()) {
case "JETTY":
return EMBED_SERVER_MODULE_JETTY_CLASS
break
case "TOMCAT":
return EMBED_SERVER_MODULE_TOMCAT_CLASS
break
case "PAYARA":
return EMBED_SERVER_MODULE_PAYARA_CLASS
break
default:
break
}
return EMBED_SERVER_DEFAULT_TYPE_CLASS
}
private static Map findEmbedServerTypeOptions(CBGServerExtension spe) {
if (!spe) return [:]
String type = spe.type
if (!type) return [:]
Map etoptions = [:]
if (spe.options) etoptions.putAll(spe.options)
switch (type.toUpperCase()) {
case "JETTY":
// TODO 增加专用参数
break
case "TOMCAT":
// TODO 增加专用参数
break
case "PAYARA":
// TODO 增加专用参数
break
default:
break
}
return etoptions
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy