Gradle入门（6）：建立Web应用项目

本文由 伯乐在线 - JustinWu翻译，黄利民 校稿。未经许可，禁止转载！ 英文出处：Petri Kainulainen。欢迎加入翻译组。

若是你并不熟悉Gradle，在继续阅读本文以前，你应当先阅读如下文章。

• 《Gradle入门（1）：简介》帮助你学会安装Gradle，描述了Gradle构建的基本概念，还描述了如何使用Gradle插件在构建中添加功能。
• 《Gradle入门（2）：第一个Java项目》描述了如何经过Gradle建立Java项目，并将其打包为可执行jar文件。
• 《Gradle入门（3）：依赖管理》描述了如何管理Gradle项目的依赖。

建立Web应用项目

若是要用 Java 和 Gradle 建立一个 Web 应用项目，咱们首先须要建立一个 Java 项目，下面来看看该如何去作。

建立Java项目

咱们可使用Java插件建立一个Java项目，经过添加如下代码行到build.gradle文件中便可。

apply plugin: 'java'

扩展阅读： Java插件中加入了一些新的约定（例如：默认的目录格式）、任务和构建属性。若是你想获悉这些内容，能够阅读下面这篇文章。《Gradle入门（2）：第一个Java项目》

咱们继续探索如何打包Web应用。

打包Web应用

在咱们使用War插件打包Web应用前，须要将其加入到构建中。在应用了War插件后，build.gradle文件以下：

apply plugin: 'java'
apply plugin: 'war'

War插件在项目的目录布局下添加了一个新的目录，加入了两个新的依赖管理配置项，以及在项目中添加了一个新的任务。这些变化的详细描述以下：

• War插件在项目的目录布局下添加了src/main/webapp目录，这个目录包含Web应用的源文件（CSS文件、Javascript文件、JSP文件等）。
• War插件加入了两个新的依赖管理配置项providedCompile 和 providedRuntime.，这两个配置项与compile 和 runtime 配置项的做用域相同，可是区别是这两个配置项所属的依赖不会被添加到WAR文件中。
• War插件也会在应用项目中添加war任务，这个任务会将WAR文件置于build/libs目录中。

即使War插件在项目的目录布局下添加了src/main/webapp目录，但它实际上并无被真正建立。若是咱们须要这个目录，那就必须本身来建立。

扩展阅读： 若是你不知道compile和runtime配置项是什么，你应该阅读如下文章：《Gradle入门（3）：依赖管理》

如今，咱们能够在命令提示符下，经过gradle war命令打包Web应用。此时此刻，咱们能够看到以下输出：

> gradle war
:compileJava
:processResources
:classes
:war
 
BUILD SUCCESSFUL
 
Total time: 4.937 secs

若是一切顺利，咱们应该能够在build/libs目录下找到web-application.war文件。

扩展阅读：若是你须要关于War插件或war任务的更多信息，或者是，你想要覆盖War插件或war任务的默认配置，你能够多多关注如下网页：

• Gradle User Guide: 25. The War plugin
• Gradle DSL Reference: War

运行Web应用

咱们可使用Gretty在开发环境中运行Web应用，它支持Jetty和Tomcat，它也不会被 Gradle缺乏SLF4J绑定所致使的问题所困扰。咱们继续进行配置构建并使用Gretty运行Web应用。首先，必须配置构建脚本的依赖。能够经过如下步骤完成：

1. 使用Bintray的JCenter Maven仓库配置构建脚本，进行依赖解析。
2. 将Gretty插件的依赖加入到构建脚本的classpath中。

**扩展阅读：**若是你想了解更多关于在已经打包为jar的文件上使用的二进制插件的技巧，你能够阅读Gradle用户手册的如下章节：

• Gradle User Guide: 20.4 Applying plugins with the buildscript block
• Gradle User Guide: 59.6 External Dependencies for the build script

第二步，应用Gretty插件。作完这一步后，build.gradle文件以下：

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'org.akhikhl.gretty:gretty'
    }
}
 
apply plugin: 'java'
apply plugin: 'war'
apply plugin: 'org.akhikhl.gretty'

build.gradle的源代码以下：

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'org.akhikhl.gretty:gretty'
    }
}
 
apply plugin: 'java'
apply plugin: 'war'

第三步，按照如下步骤配置Gretty：

1. 配置Gretty，当运行Web应用时，使用Jetty 9做为servlet容器。
2. 配置Jetty，监听8080端口。
3. 配置Jetty，使用上下文路径’/’运行Web应用。

build.gradle文件的源代码以下：

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'org.akhikhl.gretty:gretty'
    }
}
 
apply plugin: 'java'
apply plugin: 'war'
apply plugin: 'org.akhikhl.gretty'
 
gretty {
    port = 8080
    contextPath = '/'
    servletContainer = 'jetty9'
}

扩展阅读：若是你想了解关于Gretty的更多内容，能够仔细看一下如下文档：

• Gretty Documentation: Getting Started
• Gretty Documentation: Gretty Configuration
• Gretty Documentation

如今，咱们能够经过在命令提示符下运行如下命令，开启或终止咱们的Web应用：

• gradle appStart命令能运行Web应用。
• gradle appStop命令能终止Web应用。

总结

这篇教程教会了咱们四项内容：

• 咱们学会了，若是要使用默认配置，就必须把Web应用的源文件置于 src/main/webapp 目录下。
• 咱们学会了，War插件会添加两个新的依赖项（providedCompile 和 providedRuntime）到构建中，还学会了这些依赖项是如何工做的。
• 咱们学会了，将Web应用打包为WAR文件。
• 咱们学会了，在开发环境中运行Web应用。

P.S. 你能够从 Github 上拿到这篇教程的演示程序。

关于做者：JustinWu