Java Gradle入门指南之gretty插件（安装、命令与核心特性）

博客逐步迁移至极客兔兔的小站

Java Web应用开发时常使用Gradle来进行项目管理，可以十分便利地解决包依赖等问题。war插件的出现，让项目部署成为一个复制粘贴的过程，那有没有办法让Java web应用的部署，就像windows下安装软件，双击一下就可以呢？又或者Java web应用开发过程中，有没有办法自动检测项目变化，自动编译与加载呢？

gretty支持热部署、HTTPS、转发、调试、自动化运行环境等诸多特性，让开发和部署变得更加简单。本文将介绍gretty插件的最常用的几种特性和使用方法，适合对使用过Java web和Gradle的童鞋。如有错误，请不吝指出，非常感谢；如本文对你有用，右下角点个推荐吧！

1.安装gretty

// JDK6+，Gradle 1.10+

// build.gradle

buildscript {

    repositories {

         jcenter()

    }

    dependencies {

         classpath 'org.akhikhl.gretty:gretty:+'

    }

}

apply plugin: 'org.akhikhl.gretty'

或

apply from: 'https://raw.github.com/akhikhl/gretty/master/pluginScripts/gretty.plugin'

2.常用命令

2.1 gradle appRun

编译当前项目
不依赖于war任务
另有appRunWar、appRunDebug、appRunWarDebug

2.2 gradle appStart

编译当前项目
使用新java线程开启服务，监听端口，等待HTTP请求
不依赖于war任务
不主动关闭服务，即一直在运行，需用gradle appStop关闭
另有appStartWar、appStartDebug、appStartWarDebug

2.3 gradle jetty* / gradle tomcat*

包含Start、Run、Stop等，与2.1-2.2用法一致

3.核心特性

3.1 选择servlet 容器

gretty {

    // 端口默认8080

    // serlvetContainer 支持 jetty7/8/9，tomcat7/8

    // contextPath 设置根路径，默认为项目名称

    port = 8081

    serlvetContainer = 'jetty9'

    contextPath = '/'

}

3.2 热部署（Gretty 1.1.5+）

常用属性

scanInterval：监视周期，单位为秒，设置为0等于完全关闭热部署
scanDir：需要监视的文件夹
recompileOnSourceChange：监视源码变动，自动编译
reloadOnClassChange：编译的类发生改变，自动加载
reloadOnConfigChange：WEB-INF或META-INF发生改变
reloadOnLibChange：依赖发生改变

Gretty默认如下

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、reloadOnClassChange、reloadOnConfigChange 和 reloadOnLibChange默认为true

3.3 快速加载

fastReload属性，默认为true，监听webapp/中的内容，文件发生改变，无需重启。

3.4 添加新的资源目录

// 除了src/main/webapp外，可另外指定资源目录

gretty{

    // ...

    extraResourceBase 'dir1',

    extraResourceBases 'dir2','dir3'

    // ...

}

3.5 HTTPS 支持

生成自签名证书，仅在开发时使用

gretty {

    httpsEnabled = true

    // httpEnabled = false 禁用http

    // httpsPort = 443 httpsPort默认为 8443

}

certificate → "${project.buildDir}/ssl/cert"

key-store → "${project.buildDir}/ssl/keystore"

key-store and key-manager passwords→"${project.buildDir}/ssl/properties"

key-store → 配置HTTPS连接

手动配置

gretty {

    sslKeyStorePath = '/some/path/keystore'

    sslKeyStorePassword = 'someKeystorePassword'

    sslKeyManagerPassword = 'someKeyManagerPassword'

    sslTrustStorePath = '/another/path/trust_keystore'

    sslTrustStorePassword = 'someTrustStorePassword'

}

3.6 转发（Gretty 1.1.7+）

步骤1：在WEB-INF/web.xml中加入以下内容

<filter>

  <filter-name>RedirectFilter</filter-name>

  <filter-class>org.akhikhl.gretty.RedirectFilter</filter-class>

</filter>

<filter-mapping>

  <filter-name>RedirectFilter</filter-name>

  <url-pattern>/*</url-pattern>

  <dispatcher>REQUEST</dispatcher>

  <dispatcher>FORWARD</dispatcher>

</filter-mapping>

步骤2：创建WEB-INF/filter.groovy，设置转发规则

// 根地址转发到 index.html

filter relPath: '/', {

  forward 'index.html'

}

// 旧地址转发到新地址

filter relPath: '/old/path', {

  redirect contextPath + '/new/path'

}

// 地址参数转为查询参数

filter relPath: ~'/path/(.*)', { matches ->

  redirect new URIBuilder(requestURI).setPath(contextPath + '/anotherPath')

       .setQuery(matches.relPath[0][1])

}

// 将HTTP流量全部转发至HTTPS

filter scheme: 'http', {

  redirect new URIBuilder(requestURI).setScheme('https').setPort(httpsPort)

}

3.7 调试（Debug）

// 为所有的debug命令配置参数

gretty {

  debugPort = 5005      // 默认

  debugSuspend = true   // 默认

}

// 仅针对appRunDebug

gretty {

  afterEvaluate {

    appRunDebug {

      debugPort = 5005

      debugSuspend = true

    }

  }

}

4.产品生成

4.1 gradle buildProduct

生成安装文件
生成目录位于 build/output/${project.name}
结构如下

--build/output/${project.name}

    |--conf/     => 配置文件

    |--runner/  => servlet container 所需库

    |--starter/

    |--webapps/   => java web 应用

    |--restart.bat/sh

    |--run.bat/sh

    |--start.bat/sh

    |--stop.bat/sh

多应用，需在build.gradle中配置 product，例如

product {

  webapp project // include this project

  webapp ':ProjectA'

  webapp ':ProjectB'

}

4.2 gradle archiveProduct

打包生成的安装文件
生成目录位于 build/output/${project.name}

本文同步发布在 Github，后期将不断更新，欢迎关注。

Java Gradle入门指南之gretty插件（安装、命令与核心特性）的更多相关文章

Java Gradle入门指南之简介、安装与任务管理
这是一篇Java Gradle入门级的随笔,主要介绍Gradle的安装与基本语法,这些内容是理解和创建build.gradle的基础,关于Gradle各种插件的使用将会在其他随笔中介绍. ...
Java Gradle入门指南之插件管理（类型、导入及java plugin使用）
上一篇随笔介绍了如何使用Gradle内建任务,介绍了自定义Gradle任务类的三种方法(build文件,buildSrc文件夹.新建groovy项目),一个任务是一个原子操作,即不可分割的.项 ...
Java Gradle入门指南之内建与定制任务类（buildSrc、Groovy等）
上一篇随笔介绍了Gradle的安装与任务管理,这篇着重介绍Gradle的内建任务(in-built tasks)与自定义任务(custom tasks),借助Gradle提供的众多内建任务类型 ...
Java Gradle入门指南之依赖管理（添加依赖、仓库、版本冲突）
开发任何软件,如何管理依赖是一道绕不过去的坎,软件开发过程中,我们往往会使用这样那样的第三方库,这个时候,一个好的依赖管理就显得尤为重要了.作为一个自动构建工作,Gradle对依赖管理有着很好 ...
【OpenCV入门指南】第一篇安装OpenCV
http://blog.csdn.net/morewindows/article/details/8225783/ win10下vs2015配置Opencv3.1.0过程详解(转) http://ww ...
webpack常用的插件安装命令
webpack常用的插件安装命令:1:npm install html-webpack-plugin --save-dev //自动快速的帮我们生成HTML.2:npm install css-loa ...
ElasticSearch之常用插件安装命令
#head监控安装,推荐 bin/plugin -install mobz/elasticsearch-head #bigdesk集群状态,推荐 bin/plugin -install lukas-v ...
Redis入门指南之二（安装及配置）
本节主要内容 1. 前言2. redis安装3. 启动和停止Redis 1. 前言安装Redis需要知道自己需要哪个版本,有针对性的安装,比如如果需要redis GEO这个地理集合的特性,那么red ...
java RMI入门指南
感觉这篇文章不错,直接转了 RMI全称是Remote Method Invocation-远程方法调用,Java RMI在JDK1.1中实现的,其威力就体如今它强大的开发分布式网络应用的能力上,是纯J ...

随机推荐

C#中考虑为大对象使用弱引用
1.无论怎样尽力,我们总是会使用到某些需要大量内存的数据,而这些内存并不需要经常访问.或许你需要从一个大文件中查找某个特定的值,或者算法需要一个较大的查询表.这时,你也许会采用2中不太好做法:第一种是 ...
点击页面任何位置隐藏div
<include file="Public:header" /> <style type="text/css"> table{width ...
How do you install mysql-connector-python (development version) through pip?
12down votefavorite 8 http://stackoverflow.com/questions/31748278/how-do-you-install-mysql-connector ...
PHP程序员7小时学会Kotlin 第二小时
Kotlin中,一切皆对象:PHP则并非一切皆对象,甚至不需要对象的存在即可完成系统功能开发,我们现在可以接触到的旧的系统都可以说明这一点. 基本数据类型数值型类型位长双精度浮点型Double ...
Java就业指导
想要成为合格的Java程序员或工程师到底需要具备哪些专业技能,面试者在面试之前到底需要准备哪些东西呢?本文陈列的这些内容既可以作为个人简历中的内容,也可以作为面试的时候跟面试官聊的东西,你可以把这些内 ...
[小北De编程手记] : Lesson 06 玩转 xUnit.Net 之定义自己的FactAttribute
xUnit.Net本身提供了标记测试方法的标签Fact和Theory.在前面的文章<Lesson 02 玩转 xUnit.Net 之基本UnitTest & 数据驱动>中,也对它 ...
Python多线程学习
一.Python中的线程使用: Python中使用线程有两种方式:函数或者用类来包装线程对象. 1. 函数式:调用thread模块中的start_new_thread()函数来产生新线程.如下例: ...
ios svn无法连接xp或者win7系统svn的解决方法
找到服务器svn的安装目录,或者直接查找httpd.conf,找到端口号,复制到ios系统的svn端口号,就ok了,如图这是其他人的解决方法 Subversion有两种不同的配置方式,一种基于它自带 ...
Unsupported configuration attributes: [FILE_UPLOAD]
Caused by: java.lang.IllegalArgumentException: Unsupported configuration attributes: [FILE_UPLOAD] 情 ...
css知多少（3）——样式来源与层叠规则
上一节<css知多少(2)——学习css的思路>有几个人留言表示思路很好.继续期待,而且收到了9个赞,我还是比较欣慰的.没看过的朋友建议先去看看上一节. 这一节就开始实践上一节的思路! 1 ...