Gradle使用Day04-Gradle构建实践

缺乏、安全感 2022-12-04 09:12 142阅读 0赞

### Gradle构建实践 ###

*  Gradle构建Java项目
 *   *  Java插件
     *  Java项目
     *  构建Java项目
     *  外部依赖
     *  自定义项目
     *  添加test系统属性
     *  发布jar包
     *  示例
 *  Gradle多项目构建
 *   *  配置文件settings.gradle
     *  公共配置build.gradle
     *  工程依赖
     *  打包发布

# Gradle构建Java项目 #

## Java插件 ##

*  **Gradle**是一个通用工具,在脚本中编写好代码就可以通过脚本构建任何想要实现的操作,真正实现开箱即用
 *  **Java**项目基本流程:
    
     *  编译源文件
     *  进行单元测试
     *  创建**jar**包
 *  **Gradle**提供插件扩展来解决**Java**项目基本流程问题
    
     *  为**Java**项目添加默认配置
     *  **Gradle**自带很多插件,并且可以自定义插件
     *  **Gradle**中的**Java**插件**Java plugin**提供编译,测试,打包等功能
 *  **Java**插件为工程定义了许多默认值,比如**Java**源文件位置.如果遵循这些默认规则,就无需在脚本文件中书写太多代码
 *  **Gradle**允许自定义项目中的规则.实际上,由于对**Java**工程的构建是基于插件的,也可以完全不用插件而编写脚本代码来进行构建

## Java项目 ##

*  引用**Java**插件,在**build.gradle**中添加:

apply plugin: 'java'

*  可以通过运行命令查看**Java**插件添加的运行任务:

gradle tasks

*  **Java**插件默认的**Java**标准项目目录结构:
    
        project  
          - build  
          - src/main/java  
          - src/main/resources  
          - src/test/java  
          - src/test/resources
    
     *  **Gradle**默认会从**src/main/java**寻找打包源码
     *  **Gradle**默认会从**src/test/java**下寻找测试源码
     *  **src/main/resources**下的所有文件都会被打包
     *  **src/test/resources**下的所有文件都会被添加到类路径执行测试
     *  所有文件都会输出到**build**文件夹中,打包的文件输出到**build/libs**文件夹中
 *  **Java**插件添加了很多任务,但是只是在需要构建项目的时候才会作用
 *  通过**build**进行项目构建,执行构建命令:

gradle build

*  **Gradle**会编译并执行单元测试,并且将**src/main/**\* 下面的**class**和资源文件打包

## 构建Java项目 ##

*  执行构建项目命令:

gradle build

*  输出:

:compileJava
    :processResources
    :classes
    :jar
    :assemble
    :compileTestJava
    :processTestResources
    :testClasses
    :test
    :check
    :build
    BUILD SUCCESSFUL
    Total time: 1 secs

*  常用的**Java**项目任务命令:
    
     *  **clean:** 删除build目录以及所有构建完成的文件
     *  **assemble:** 编译并打包**jar**文件,但不执行单元测试. 可以使用其余插件增强这个任务的功能,比如采用**war**插件,可以为项目打出**war**包
     *  **check:** 编译并测试代码. 可以使用其余插件增强这个任务的功能,比如采用**code-quality**插件,可以额外执行**checkstyle**

## 外部依赖 ##

*  一个**Java**项目拥有许多外部依赖
 *  需要配置**Gradle**如何找到并引用这些外部依赖
 *  在**Gradle**中通常**jar**包都存在于仓库中,仓库可以用来寻找依赖和发布项目**jar**包
 *  **在build.gradle文件中添加Maven仓库:**

repositories { 
        mavenCentral()
    }

*  **在build.gradle文件中添加外部依赖:** 声明依赖**commons-collections**和**junit**

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

## 自定义项目 ##

*  **在build.gradle文件中自定义MANIFEST.MF:** 指定**JDK**版本号和**Java**项目版本号,并且在**mainfest**添加属性

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

*  可以执行**gradle propertie s**获取项目的属性列表
    
     *  查看添加的属性以及默认值

## 添加test系统属性 ##

*  配置**build.gradle**文件:

test { 
        systemProperties 'property': 'value'
    }

## 发布jar包 ##

*  发布jar时要在Gradle中配置jar包发布位置,既可以是本地目录,也可以是远程仓库或者多个远程仓库中
 *  在**build.gradle**文件中添加发布**jar**包配置:

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

*  执行发布**jar**包命令来发布**jar**包:

gradle uploadArchives

>  *  如果需要将项目导入**Eclipse**中,需要配置**Eclipse**插件: 在**build.gradle**文件中配置
> 
>     apply plugin: 'eclipse'
> 
>  *  执行命令生成**Eclipse**项目文件:
> 
>     gradle eclipse

## 示例 ##

*  一个完整的**Java**项目构建**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'
           }
        }
    }

# Gradle多项目构建 #

*  **项目结构:**

>  *  multiproject/
>     
>      *  api/ : 用来生成给客户端用的jar文件,这个jar文件可以为XML webservice提供Java客户端
>      *  services/webservice/ : 一个web应用,生成XML
>      *  shared/ : 包含前两个工程中的共用代码

## 配置文件settings.gradle ##

*  定义一个多项目构建工程需要在根目录同级创建一个**settings.gradle**配置文件来指明构建包含哪些项目

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

## 公共配置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'
        }
    }

## 工程依赖 ##

*  同一个构建中可以建立工程依赖,一个工程的**jar**包可以提供给另外一个工程使用
    
     *  可以让**api**工程以依赖于**shared**工程的**jar**包.这样**Gradle**在构建**api**之前总是会先构建**shared**工程
 *  **api/build.gradle:**

dependencies { 
        compile project(':shared')
    }

## 打包发布 ##

*  **api/build.gradle:**

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