Gradle用户指南-构建Java项目

Posted 2020-08-20 夜行过客

1.构建基本的Java项目

 

---

为了使用 Java 插件，添加下面代码到构建文件：

build.gradle

    apply plugin: \'java\'

 

这个就是 定义一个 Java 项目的全部。它会将 Java 插件应用到项目中，并且添加很多 task。

Gradle 会在 src/main/java 目录下寻找产品代码，在 src/test/java 寻找测试代码 。 另外在 src/main/resources 包含了资源的 JAR 文件, src/test/resources 包含了运行测试。所有的输出都在 build 目录下，JAR 在 build/libs 目录下。

PS:一些常用的task

clean

删除 build 目录，移除所有构建的文件

assemble

编译打包代码,但不运行单元测试。其他插件带给这个 task 更多特性，比如如果你使用 War 插件，task 将给 project 构建 WAR 文件

check

编译测试你的代码。其他插件带给这个 task 提供更多检查类型。比如，你使用 checkstyle 插件, 这个 task 建辉在你的代码中 执行 Checkstyle

 

2.依赖外部jar文件

---

 

Java 项目经常会有一些外部 JAR 的依赖。为了引用这些 JAR 文件，需要在 Gradle　里面配置。在　Gradle，类似与　JAR 文件将会放在 repository 中。一个 repository 可以被依赖的项目获取到，或者提交项目的拷贝到 repository 中，或者两者都可。比如，我们使用 Maven repository :

build.gradle

    repositories {
        mavenCentral()
    }

我们添加一些依赖，声明了 编译时 需要的依赖和测试时需要的依赖

build.gradle

    dependencies {
        compile group: \'commons-collections\', name: \'commons-collections\', version: \'3.2\'
        testCompile group: \'junit\', name: \'junit\', version: \'4.+\'
    }

 

3.自定义项目属性

---

 

在 Java 插件添加属性到您的项目。这些属性通常足在启动时使用默认值。如果他们不适合你，你很容易改他们。让我们看一看我们的示例。在这里，我们将说明我们的 Java 项目的版本号，包括 Java 的版本号。我们也添加一些属性的 JAR 文件清单。

build.gradle

    sourceCompatibility = 1.5
    version = \'1.0\'
    jar {
        manifest {
            attributes \'Implementation-Title\': \'Gradle Quickstart\',
                       \'Implementation-Version\': version
        }
    }

 

4.发布jar文件

---

 

需要告诉 Gradle 要发布 JAR 的位置。在 Gradle 中， 产物 比如 JAR 文件等是发布到库中的。我们的例子中是发布到了本地路径。你也可以发布到 远程位置或者多个位置。

build.gradle

    uploadArchives {
        repositories {
           flatDir {
               dirs \'repos\'
           }
        }
    }

执行 gradle uploadArchives 来发布

 

5.创建eclipse项目

---

 

 创建 Eclipse 特点的描述文件，比如 .project，需要添加插件

build.gradle

    apply plugin: \'eclipse\'

执行 gradle eclipse 来生产 Eclipse project 文件。

总结

下面是完整的示例 build 文件

build.gradle

    apply plugin: \'java\'
    apply plugin: \'eclipse\'

    sourceCompatibility = 1.5
    version = \'1.0\'
    jar {
        manifest {
            attributes \'Implementation-Title\': \'Gradle Quickstart\',
                       \'Implementation-Version\': version
        }
    }

    repositories {
        mavenCentral()
    }

    dependencies {
        compile group: \'commons-collections\', name: \'commons-collections\', version: \'3.2\'
        testCompile group: \'junit\', name: \'junit\', version: \'4.+\'
    }

    test {
        systemProperties \'property\': \'value\'
    }

    uploadArchives {
        repositories {
           flatDir {
               dirs \'repos\'
           }
        }
    }

6.构建多个java项目

---

 

下面是一个 多 project 构建的 项目结构：

 multiproject/
      api/
      services/webservice/
      shared/
      services/shared/

里面包含 4 个 project。 api 是产生出 JAR 文件 给客户端加载提供给 Java 客户端需要的 XML webservice。webservice 是一个 web 应用返回 XML 。shared 包含了 api、webservice 使用的代码。项目 services/shared 包含了 依赖 shared 的代码。

定义 build 文件

配置文件的名字叫 settings.gradle，如下

settings.gradle

    include "shared", "api", "services:webservice", "services:shared"

常见配置

有很多常见的配置。我们的示例中使用了 configuration injection （配置注入）。在这里，根项目就像一个容器，subprojects 方法遍历容器中的元素（实例中的 project ），并将指定的配置。这样我们可以很容易地定义所有档案的 manifest 的内容，和一些常见的依赖关系：

build.gradle

    subprojects {
        apply plugin: \'java\'
        apply plugin: \'eclipse-wtp\'

        repositories {
           mavenCentral()
        }

        dependencies {
            testCompile \'junit:junit:4.11\'
        }

        version = \'1.0\'

        jar {
            manifest.attributes provider: \'gradle\'
        }
    }

注意，示例中 在 所有 子 project 中应用了 Java 插件。意思是 task 和配置属性将会出现在虽偶有 子 project 中。所以，你可以 在根 project 目录中，运行 gradle build 来编译、测试、将所有 project 打包成 JAR 。

注意，插件只应用在 subprojects 包含的区域，其他根级别的将不适用。

7.依赖外部项目

---

 

在相同的构建里，您可以添加项目之间的依存关系，这样，例如，一个项目的 JAR 文件可以用来编译另外一个项目。在api 构建文件中我们将添加对shared项目的依赖。由于这种依赖，Gradle 将确保 shared在api 之前获得构建。

api/build.gradle

    dependencies {
        compile project(\':shared\')
    }

 

8.创建发布包

---

 

 添加发布包，提供给客户端装载

api/build.gradle

    task dist(type: Zip) {
        dependsOn spiJar
        from \'src/dist\'
        into(\'libs\') {
            from spiJar.archivePath
            from configurations.runtime
        }
    }

    artifacts {
       archives dist
    }