Gradle 高级-gretty

本文作者：黄少存，叩丁狼高级讲师。原创文章，转载请注明出处。

概要:目前很多企业都开始使用Gradle 来进行项目的管理,对于 Java Web 项目来说,war 插件的出现,让项目部署只需复制粘贴即可,那有没有办法让 JavaWeb 项目的部署像PC 端软件一样双击某个执行文件即可?有没有办法自动检测项目的更新,自由编译与加载从而方便开发人员呢?答案是yes,咱们可以使用 gretty 来实现这些功能.

gretty 支持热部署,HTTPS,转发,调试,自动化运行环境等诸多特性,支持jetty,tomcat 等多种 Servlet 容器.接下来咱们就来看下 gretty 最常用的特性和使用方法.

一. 在 Gradle 中安装 gretty

gretty 安装很简单,不过需要下载的依赖比较多,刚开始会慢点.

// build.gradle
// 1 apply 安装
apply from: 'https://raw.github.com/gretty-gradle-plugin/gretty/master/pluginScripts/gretty.plugin'
// 2 plugins 安装
plugins {
    id 'java'
    id 'war'
    id "org.akhikhl.gretty" version "2.0.0"
} 
           

以上配置二选一,都可以. 如果 gradle 版本比较旧,可按以下方式来安装 gretty

// JDK6+，Gradle 1.10+
// build.gradle
buildscript {
    repositories {
         jcenter()
    }
    dependencies {
         classpath 'org.akhikhl.gretty:gretty:+'
    }
}
apply plugin: 'org.akhikhl.gretty'
           

二. 启动项目常用操作

以上3种配置按 gradle 版本和需求选一种即可,然后可以用命令,gradle appRun 即可启动.默认使用 jetty9 容器.

IDE 工具操作: idea -> Gradle -> 项目->Task->gretty下很多的操作,都是一个个的命令操作.

2.1 Run 系列

• 1 编译项目
• 2 启动 wab-app
  • gradle appRun/appRunDebug : 不依赖 war,按钮停止
  • gradle appRunWar/appRunWarDebug : 依赖 war,按钮停止
• 3 idea : gradle -> task -> gretty

  

2.2 Start 系列

• 1 编译项目
• 2 使用新线程开启服务，等待HTTP请求
  • gradle appStart/appStartDebug : 不依赖 war,用 gradle appStop 停止
  • gradle appRestart : 不依赖 war 重启
  • gradle appStartWar/appStartWarDebug : 依赖 war,用 gradle appStop 停止
• 3 idea : gradle -> task -> gretty

  

2.3 自选择容器系列

强制使用 jetty/tomcat 容器,包含Run,Start,Stop,功能和 2.1-2.2 相同.

• jettyRun / jettyRunDebug / jettyRunWar / jettyRunWarDebug
• jettyStart / jettyStartDebug / jettyStartWar / jettyStartWarDebug
• tomcatRun / tomcatRunDebug / tomcatRunWar / tomcatRunWarDebug
• tomcatStart / tomcatStartDebug / tomcatStartWar / tomcatStartWarDebug

详情查看 : gretty task

三. 默认配置修改

3.1 修改默认Servlet 容器和其常用属性

gretty {
    // 指定默认 Servlet 容器,支持 jetty7/8/9，jetty9.3/9.4(仅 jdk8),tomcat7/8
    servletContainer = 'tomcat8'
    // 修改服务器端口
    httpPort = 80
    // 修改上下文路径
    contextPath = '/'
}
           

其他默认配置修改: Gretty configuration

3.2 修改默认热部署配置

Gretty 1.0.0+ 可使用 managedClassReload=true 来启动即时重新加载已更改的class文件.也可以手动修改热部署的属性.

常用属性

• scanInterval：监听周期(秒)，设置为 0 则关闭热部署
• scanDir：需要监听的文件夹
• recompileOnSourceChange：监听源码变动，自动编译
• reloadOnClassChange：编译的类发生改变，自动加载
• reloadOnConfigChange：监听 WEB-INF 或 META-INF 发生改变
• reloadOnLibChange：监听依赖发生改变

默认值

• scanInterval = 1 // 每秒扫描加载 1 次
• scanDir 默认值
  • ${projectdir}/src/main/java
  • ${projectdir}/src/main/groovy
  • ${projectdir}/src/main/resources
  • ${projectdir}/build/classes/main
  • ${projectdir}/build/resources/main
• recompileOnSourceChange = true
• reloadOnClassChange = true
• reloadOnConfigChange = true
• reloadOnLibChange = true

3.3 gretty 对 HTTPS 支持

生成自签名证书,只能在开发中使用

// https 配置
gretty {
    //httpEnabled = false  // 禁用http
    httpsEnabled = true    // 启用https 生成自签名证书
    // httpsPort = 443 默认是 8443
}
           

证书生成位置:

• certificate -> “${project.buildDir}/ssl/cert”
• key-store -> “${project.buildDir}/ssl/keystore”
• key-store and key-manager passwords -> “${project.buildDir}/ssl/properties”

启动访问 Q GFDSAZhttps 连接,注意,此处用的是gretty自签名证书,并非指向?Certificate Authority (CA).可手动配置引用已经存在的证书.

gretty {
  sslKeyStorePath = '/some/path/keystore'
  sslKeyStorePassword = 'someKeystorePassword'
  sslKeyManagerPassword = 'someKeyManagerPassword'
  sslTrustStorePath = '/another/path/trust_keystore'
  sslTrustStorePassword = 'someTrustStorePassword'
}
           

四. 其他强大操作

4.1 gretty 的 debug 调试

在启动项目常用操作中有很多的 xxxDebug 操作,这些都是 debug 方式运行.不过在 IDE 工具中直接运行没有效果,在 idea 中可以使用远程调试来实现 debug 调试.

1. 双击某个 debug 任务,例: appStartDebug
2. 配置 idea 远程调试
3. 启动 idea 远程调试
4. debug 调试

4.1.1. 双击某个 debug 任务,例: appStartDebug\

4.1.2. 配置 idea 远程调试

4.1.3. 启动 idea 远程调试

• 选择远程调试并启动

  

• 启动后控制台信息

  

• 等待项目启动即可进行调试

  

选择控制台的 Run 选项卡,观察项目启动.启动成功后就可以请求需要 debug 的资源了.

4.1.4. debug 调试

4.2 gretty 生成可执行项目

gretty 可以类 springboot 的项目打包功能,gretty 可以把一个项目导出成拥有Servlet 容器和启动程序的项目.还可以将项目整体压缩,操作如下.

gradle buildProject

生成可执行的项目,生成目录:build/output/${project.name}

项目结构如下

• conf : 包含服务器的配置文件
• runner : 包含Servlet 容器的运行库
• starter : 包含Servlet 容器部署java程序需要的运行库
• webapps : 一个或多个你的 web 项目

gradle archiveProduct

生成可执行的项目,生成目录:build/output/ p r o j e c t . n a m e , 打 包 项 目 为 z i p 包 . 存 在 : b u i l d / o u t p u t / {project.name},打包项目为zip包.存在:build/output/ project.name,打包项目为zip包.存在:build/output/{project.name}-${project.version}.zip

以上gretty 的常用配置和操作就到这里.详情可看插件doc