资讯专栏INFORMATION COLUMN

使用Gradle构建Java项目

xiaokai / 3099人阅读

摘要:要从头开始,请继续使用构建。文件夹应包含项目运行单元测试的报告。由于该项目尚未进行任何单元测试,因此该报告无效。使用构建项目是启动构建的首选方式。现在可用于构建项目。概要恭喜您现在已经创建了一个简单而有效的构建文件,用于构建项目。

本指南将引导您使用Gradle构建一个简单的Java项目。

你要构建什么

您将创建一个简单的应用程序,然后使用Gradle构建它。

你需要什么

大约15分钟

最喜欢的文本编辑器或IDE

JDK 6或更高版本

如何完成本指南

与大多数Spring入门指南一样,您可以从头开始并完成每个步骤,或者您可以绕过您已熟悉的基本设置步骤。无论哪种方式,您最终都会使用工作代码。

从头开始,请继续使用Gradle构建。

跳过基础知识,请执行以下操作:

下载并解压缩本指南的源存储库,或使用Git克隆它:

git clone https://github.com/spring-guides/gs-gradle.git

进入gs-gradle/initial

跳转到安装Gradle。

完成后,可以根据gs-gradle/complete中的代码检查结果。

设置项目

首先,您要为Gradle建立一个Java项目。为了保持对Gradle的关注,让项目尽可能简单。

创建目录结构

在您选择的项目目录中,创建以下子目录结构;例如,在*nix系统上使用mkdir -p src/main/java/hello:

└── src
    └── main
        └── java
            └── hello

src/main/java/hello目录中,您可以创建所需的任何Java类。为了简单起见并与本指南的其余部分保持一致,Spring建议您创建两个类:HelloWorld.javaGreeter.java

src/main/java/hello/HelloWorld.java

package hello;

public class HelloWorld {
  public static void main(String[] args) {
    Greeter greeter = new Greeter();
    System.out.println(greeter.sayHello());
  }
}

src/main/java/hello/Greeter.java

package hello;

public class Greeter {
  public String sayHello() {
    return "Hello world!";
  }
}
安装Gradle

现在您有了一个可以使用Gradle构建的项目,您就可以安装Gradle了。

强烈建议使用安装程序:

SDKMAN

Homebrew(brew install gradle)

最后,如果这些工具都不适合您的需要,您可以从http://www.gradle.org/downloads下载二进制文件。只有二进制文件是必需的,所以要查找到gradle-version-bin.zip 的链接。(您也可以选择gradle-version-all.zip以获取源代码和文档以及二进制文件。)

将文件解压缩到您的计算机,然后将bin文件夹添加到您的路径中。

要测试Gradle安装,请从命令行运行Gradle:

gradle

如果一切顺利,您会看到一条欢迎信息:

:help

Welcome to Gradle 2.3.

To run a build, run gradle  ...

To see a list of available tasks, run gradle tasks

To see a list of command-line options, run gradle --help

BUILD SUCCESSFUL

Total time: 2.675 secs

您现在安装了Gradle。

了解Gradle可以做些什么

现在已经安装了Gradle,看看它能做什么。在为项目创建build.gradle文件之前,您可以询问它可用的任务:

gradle tasks

您应该看到可用任务列表。假设您在没有build.gradle文件的文件夹中运行Gradle ,您将看到一些非常基本的任务,例如:

:tasks

== All tasks runnable from root project

== Build Setup tasks
setupBuild - Initializes a new Gradle build. [incubating]

== Help tasks
dependencies - Displays all dependencies declared in root project "gs-gradle".
dependencyInsight - Displays the insight into a specific dependency in root project "gs-gradle".
help - Displays a help message
projects - Displays the sub-projects of root project "gs-gradle".
properties - Displays the properties of root project "gs-gradle".
tasks - Displays the tasks runnable from root project "gs-gradle".

To see all tasks and more detail, run with --all.

BUILD SUCCESSFUL

Total time: 3.077 secs

即使这些任务可用,但如果没有项目构建配置,它们也不会提供太多价值。当你充实build.gradle文件时,一些任务会更有用。在添加build.gradle插件时,任务列表会增加,因此您偶尔会想要再次运行任务以查看可用的任务。

说到添加插件,接下来添加一个启用基本Java构建功能的插件。

构建Java代码

从简单的build.gradle开始,在本指南开头创建的中创建一个非常基本的文件。只给它一行

apply plugin: "java"

构建配置中的这一行带来了大量功率。再次运行gradle tasks,您会看到添加到列表中的新任务,包括构建项目,创建JavaDoc和运行测试的任务。

您将经常使用gradle build。此任务将代码编译,测试并组装到JAR文件中。你可以像这样运行它:

gradle build

几秒钟后,“BUILD SUCCESSFUL”表示构建已完成。

要查看构建工作的结果,请查看构建文件夹。在那里你会找到几个目录,包括这三个值得注意的文件夹:

classes:该项目已编译的.class文件。

reports:构建生成的报告(例如测试报告)。

libs:汇编的项目库(通常是JAR和/或WAR文件)。

classes文件夹具有通过编译Java代码生成的.class文件。具体来说,您应该找到HelloWorld.class和Greeter.class。

此时,项目没有任何库依赖项,因此dependency_cache文件夹中没有任何内容。

reports文件夹应包含项目运行单元测试的报告。由于该项目尚未进行任何单元测试,因此该报告无效。

libs文件夹应包含以项目文件夹命名的JAR文件。再往下,您将看到如何指定JAR的名称及其版本。

声明依赖项

简单的Hello World示例是完全独立的,不依赖于任何其他库。但是,大多数应用程序依赖于外部库来处理常见或复杂的功能。

例如,假设除了说“Hello World!”之外,您还希望应用程序打印当前日期和时间。您可以使用本机Java库中的日期和时间工具,但是通过使用Joda Time库可以使事情变得更有趣。

首先,将HelloWorld.java更改为如下所示:

package hello;

import org.joda.time.LocalTime;

public class HelloWorld {
  public static void main(String[] args) {
    LocalTime currentTime = new LocalTime();
    System.out.println("The current local time is: " + currentTime);

    Greeter greeter = new Greeter();
    System.out.println(greeter.sayHello());
  }
}

这里HelloWorld使用Joda Time的LocalTime类来获取和打印当前时间。

如果您现在运行gradle build来构建项目,那么构建将失败,因为您没有在构建中将Joda Time声明为编译依赖项。

对于初学者,您需要为第三方库添加源。

repositories {
    mavenCentral()
}

repositories块指示构建应从Maven Central存储库解析其依赖关系。Gradle严重依赖Maven构建工具建立的许多约定和工具,包括使用Maven Central作为库依赖关系源的选项。

现在我们已经为第三方库做好了准备,让我们宣布一些。

sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile "joda-time:joda-time:2.2"
    testCompile "junit:junit:4.12"
}

使用dependencies块,您可以为Joda Time声明一个依赖项。具体来说,你在joda-time组中要求(从右到左阅读)joda-time库2.2版。

关于这种依赖关系的另一个注意事项是它是一个compile依赖项,表明它应该在编译时可用(如果你正在构建一个WAR文件,包含在WAR的/WEB-INF/libs文件夹中)。其他值得注意的依赖类型包括:

providedCompile。编译项目代码所需的依赖项,但是运行代码的容器将在运行时提供该依赖项(例如,Java Servlet API)。

testCompile。用于编译和运行测试的依赖项,但不是构建或运行项目的运行时代码所必需的。

最后,让我们指定JAR工件的名称。

jar {
    baseName = "gs-gradle"
    version =  "0.1.0"
}

jar块指定如何命名JAR文件。在这种情况下,它将呈现gs-gradle-0.1.0.jar

现在,如果您运行gradle build,Gradle应该从Maven Central存储库解析Joda Time依赖项,并且构建将成功。

使用Gradle Wrapper构建项目

Gradle Wrapper是启动Gradle构建的首选方式。它由Windows的批处理脚本和OS X和Linux的shell脚本组成。这些脚本允许您运行Gradle构建,而无需在系统上安装Gradle。这曾经是添加到您的构建文件中的东西,但它已被折叠到Gradle中,因此不再需要。相反,您只需使用以下命令。

$ gradle wrapper --gradle-version 2.13

完成此任务后,您会注意到一些新文件。这两个脚本位于文件夹的根目录中,而包装jar和属性文件已添加到新gradle/wrapper文件夹中。

└── 
    └── gradlew
    └── gradlew.bat
    └── gradle
        └── wrapper
            └── gradle-wrapper.jar
            └── gradle-wrapper.properties

Gradle Wrapper现在可用于构建项目。将它添加到您的版本控制系统,克隆项目的每个人都可以构建它。它可以与安装的Gradle版本完全相同的方式使用。运行包装器脚本来执行构建任务,就像之前一样:

./gradlew build

第一次运行指定版本的Gradle的包装器时,它会下载并缓存该版本的Gradle二进制文件。Gradle Wrapper文件旨在提交源代码控制,以便任何人都可以构建项目,而无需先安装和配置特定版本的Gradle。

在此阶段,您将构建代码。你可以在这里看到结果:

build
├── classes
│   └── main
│       └── hello
│           ├── Greeter.class
│           └── HelloWorld.class
├── dependency-cache
├── libs
│   └── gs-gradle-0.1.0.jar
└── tmp
    └── jar
        └── MANIFEST.MF

包括的是两个预期类文件GreeterHelloWorld,以及JAR文件。快速浏览一下:

$ jar tvf build/libs/gs-gradle-0.1.0.jar
  0 Fri May 30 16:02:32 CDT 2014 META-INF/
 25 Fri May 30 16:02:32 CDT 2014 META-INF/MANIFEST.MF
  0 Fri May 30 16:02:32 CDT 2014 hello/
369 Fri May 30 16:02:32 CDT 2014 hello/Greeter.class
988 Fri May 30 16:02:32 CDT 2014 hello/HelloWorld.class

类文件被捆绑在一起。值得注意的是,即使您将joda-time声明为依赖项,此处也不包含该库。并且JAR文件也不可运行。

为了使这段代码可以运行,我们可以使用gradle的application插件。将其添加到您的build.gradle文件中。

apply plugin: "application"

mainClassName = "hello.HelloWorld"

然后你可以运行该应用程序!

$ ./gradlew run
:compileJava UP-TO-DATE
:processResources UP-TO-DATE
:classes UP-TO-DATE
:run
The current local time is: 16:16:20.544
Hello world!

BUILD SUCCESSFUL

Total time: 3.798 secs

捆绑依赖关系需要更多思考。例如,如果我们构建一个WAR文件,一种通常与第三方依赖关系打包相关的格式,我们可以使用gradle的WAR插件。如果您使用的是Spring Boot并且想要一个可运行的JAR文件,那么spring-boot-gradle-plugin非常方便。在这个阶段,gradle对您的系统不了解,无法做出选择。但就目前而言,这应该足以开始使用gradle了。

要完成本指南的内容,这里是完整的build.gradle文件:

apply plugin: "java"
apply plugin: "eclipse"
apply plugin: "application"

mainClassName = "hello.HelloWorld"

// tag::repositories[]
repositories {
    mavenCentral()
}
// end::repositories[]

// tag::jar[]
jar {
    baseName = "gs-gradle"
    version =  "0.1.0"
}
// end::jar[]

// tag::dependencies[]
sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile "joda-time:joda-time:2.2"
    testCompile "junit:junit:4.12"
}
// end::dependencies[]

// tag::wrapper[]
// end::wrapper[]

此处嵌入了许多开始/结束注释。这使得可以将构建文件的位提取到本指南中,以获得上述详细说明。您在生产构建文件中不需要它们。

概要

恭喜!您现在已经创建了一个简单而有效的Gradle构建文件,用于构建Java项目。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/73181.html

相关文章

  • 慕课网_《新一代构建工具gradle》学习总结

    摘要:时间年月日星期二说明本文部分内容均来自慕课网。项目一个项目代表一个正在构建的组件比如一个文件,当构建启动后,会基于实例化一个类,并且能够通过变量使其隐式可用。任务动作定义了一个最小的工作单元。 时间:2017年05月16日星期二说明:本文部分内容均来自慕课网。@慕课网:http://www.imooc.com教学示例源码:无个人学习源码:https://github.com/zccod...

    antyiwei 评论0 收藏0
  • gradle-学习笔记(2)-多项目构建

    摘要:记得在中支持多个子项目的构建方法同样的在中也会支持多项目的构建方法还记得在中如何配置多项目工程吗这里回忆一下首先我们需要一个父元素文件比如这样而在中我们并不需要指定父元素的标签我们只需要编写好对应的文件夹名称,并且将文件夹名称和对 记得在maven中支持多个子项目的构建方法,同样的在gradle 中也会支持多项目的构建方法 还记得在maven中如何配置多项目工程吗, 这里回忆一下 首先...

    happen 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<