【Gradle：新一代构建工具】学习笔记 3 Gradle进阶说明 3.11 Gradle中的文件操作【下】

红太狼 2024-03-23 15:37 8阅读 0赞

### 【Gradle：新一代构建工具】学习笔记 ###

#### 文章目录 ####

*   *  【Gradle：新一代构建工具】学习笔记
     *   *  3 Gradle进阶说明
         *   *  3.11 Gradle中的文件操作【下】
             *   *  3.11.1 文件树
                 *  3.11.2 文件拷贝
                 *  3.11.3 归档文件

[【【尚硅谷】Gradle教程入门到进阶（从gradle安装到项目实战）】 ][Gradle_gradle_]

![在这里插入图片描述][7584caf0e7e2495a9eb8bdfa336db164.png_pic_center]

#### 3 Gradle进阶说明 ####

##### 3.11 Gradle中的文件操作【下】 #####

几种常见的文件操作方式：

*  本地文件
 *  文件集合
 *  文件树
 *  文件拷贝
 *  归档文件

###### 3.11.1 文件树 ######

文件树是有层级结构的文件集合,一个文件树它可以代表一个目录结构或一个 ZIP 压缩包中的内容结构。

文件树是从文件集 合继承过来的,所以文件树具有文件集合所有的功能。我们可以使用 `Project.fileTree(java.util.Map)`方法来创建文件树对象， 还可以使用过虑条件来包含或排除相关文件。示例代码如下：

tree = fileTree('src/main').include('**/*.java')// 第一种方式:使用路径创建文件树对象，同时指定包含的文件
    
    //第二种方式:通过闭包创建文件树: 
    tree = fileTree('src/main') {
        
    	include '**/*.java' 
    }
    
    tree = fileTree(dir: 'src/main', include: '**/*.java') //第三种方式:通过路径和闭包创建文件树：具名参数给map传值
    
    tree = fileTree(dir: 'src/main', includes: ['**/*.java', '**/*.xml', '**/*.txt'],exclude: '**/*test*/**')
    
    tree.each {
        File file -> // 遍历文件树的所有文件
        println file 
        println file.name
    }

###### 3.11.2 文件拷贝 ######

我们可以使用 Copy 任务来拷贝文件，通过它可以过虑指定拷贝内容，还能对文件进行重命名操作等。Copy 任务必须指 定一组需要拷贝的文件和拷贝到的目录，这里使用 `CopySpec.from(java.lang.Object[])`方法指定原文件；使用 `CopySpec.into(java.lang.Object)` 方法指定目标目录。

示例代码如下

task copyTask(type: Copy) {
        
    	from 'src/main/resources' // 目录本身不复制，只复制其中的内容
        into 'build/config' 
    }

from()方法接受的参数和文件集合时 files()一样：

*  当参数为一个目录时，该目录下所有的文件都会被拷贝到指定目录下（**目 录自身不会被拷贝**）；
 *  当参数为一个文件时，该文件会被拷贝到指定目录；如果参数指定的文件不存在，**就会被忽略**【任务直接被忽略，不会报错】；
 *  当参数为一个 Zip 压缩文件，**该压缩文件的内容**【不是整个压缩包，而是里面的文件】会被拷贝到指定目录。

into()方法接受的参数与本地文件时 file()一样。 示例代码如

task copyTask(type: Copy) {
        
        // 拷贝src/main/webapp目录下所有的文件
        from 'src/main/webapp' // 拷贝单独的一个文件
        from 'src/staging/index.html' // 从Zip压缩文件中拷贝内容
        from zipTree('src/main/assets.zip')
        
        // 拷贝到的目标目录
        into 'build/explodedWar' 
    }

在拷贝文件的时候还可以添加过虑条件来指定包含或排除的文件，示例如下：

task copyTaskWithPatterns(type: Copy) {
        
        from 'src/main/webapp' 
        into 'build/explodedWar' 
        include '**/*.html' 
        include '**/*.jsp' 
        exclude {
         
            details -> details.file.name.endsWith('.html') 
        }
    }

在拷贝文件的时候还可以对文件进行重命名操作，示例如下：

task rename(type: Copy) {
        
        from 'src/main/webapp' 
        into 'build/explodedWar' 
        
        // 使用一个闭包方式重命名文件
        rename {
         String fileName ->
        	fileName.replace('-staging-', '')
        }
    }

在上面的例子中我们都是使用 Copy 任务来完成拷贝功能的，那么有没有另外一种方式呢？答案是肯定的，那就是 `Project.copy(org.gradle.api.Action)`方法。下面示例展示了 copy()方法的使用方式：

task copyMethod {
        
        doLast {
        
        copy {
        
        	from 'src/main/webapp' 
            into 'build/explodedWar' 
            include '**/*.html' 
            include '**/*.jsp' }
        }
    }

或者使用 project 对象的 copy 方法:

copy {
        
        //相对路径或者绝对路径
        from file('src/main/resources/ddd.txt') //file也可以换成new File()
        into this.buildDir.absolutePath
    }

执行 `gradle build` 指令即可。去 build 目录的本地磁盘查看，就能看到

###### 3.11.3 归档文件 ######

通常一个项目会有很多的 Jar 包，我们希望把项目打包成一个 WAR，ZIP 或 TAR 包进行发布，这时我们就可以使用 Zip，Tar，Jar，War 和 Ear 任务来实现，不过它们的用法都一样，所以在这里我们只看 Zip 任务的示例。

首先，创建一个 Zip 压缩文件,并指定压缩文件名称，如下代码所示：

apply plugin: 'java' 
    version=1.0
    
    task myZip(type: Zip) {
        
        from 'src/main'
        into 'build' // 保存到build目录中
        archiveBaseName = "MyGame"
    }
    
    println myZip.archiveBaseName

执行任务：

![在这里插入图片描述][1e184f5e39e34a18b737094702f8726c.png_pic_center]

最后，我们可以使用 `Project.zipTree(java.lang.Object)`和 `Project.tarTree(java.lang.Object)`方法来创建访问 Zip 压缩包的文 件树对象，示例代码如下：

// 使用zipTree 
    FileTree zip = zipTree('someFile.zip')
    // 使用tarTree 
    FileTree tar = tarTree('someFile.tar'

在这里，我们介绍了 Gradle 对本地文件、文件集合、文件树、文件拷贝和归档文件的操作方式。

更详细的请参考官方 文档：https://docs.gradle.org/current/userguide/working\_with\_files.html

![在这里插入图片描述][e08c117bfecf47e49621978e2180a4e3.png_pic_center]

[Gradle_gradle_]: https://www.bilibili.com/video/BV1yT41137Y7
[7584caf0e7e2495a9eb8bdfa336db164.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/95e669475a134fa98894774a55664c2c.png
[1e184f5e39e34a18b737094702f8726c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/1f62b26fce9f49aba5bebd7e7f32f3ac.png
[e08c117bfecf47e49621978e2180a4e3.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/ea0d240518364478865d3729121e62f1.png