第十六章. 使用文件

build.gradle

// Using a relative path

File configFile = file('src/config.xml')

// Using an absolute path

configFile = file(configFile.absolutePath)

// Using a File object with a relative path

configFile = file(new File('src/config.xml'))

build.gradle

FileCollection collection = files('src/file1.txt', new File('src/file2.txt'), ['src/file3.txt', 'src/file4.txt'])

build.gradle

// Iterate over the files in the collection

collection.each {File file ->

    println file.name

}

// Convert the collection to various types

Set set = collection.files

Set set2 = collection as Set

List list = collection as List

String path = collection.asPath

File file = collection.singleFile

File file2 = collection as File

// Add and subtract collections

def union = collection + files('src/file3.txt')

def different = collection - files('src/file3.txt')

build.gradle

task list << {

    File srcDir

    // Create a file collection using a closure

    collection = files { srcDir.listFiles() }

    srcDir = file('src')

    println "Contents of $srcDir.name"

    collection.collect { relativePath(it) }.sort().each { println it }

    srcDir = file('src2')

    println "Contents of $srcDir.name"

    collection.collect { relativePath(it) }.sort().each { println it }

}

gradle
-q list的输出结果

> gradle -q list

Contents of src

src/dir1

src/file1.txt

Contents of src2

src2/dir1

src2/dir2

build.gradle

// Create a file tree with a base directory

FileTree tree = fileTree(dir: 'src/main')

// Add include and exclude patterns to the tree

tree.include '**/*.java'

tree.exclude '**/Abstract*'

// Create a tree using path

tree = fileTree('src').include('**/*.java')

// Create a tree using closure

tree = fileTree('src') {

    include '**/*.java'

}

// Create a tree using a map

tree = fileTree(dir: 'src', include: '**/*.java')

tree = fileTree(dir: 'src', includes: ['**/*.java', '**/*.xml'])

tree = fileTree(dir: 'src', include: '**/*.java', exclude: '**/*test*/**')

build.gradle

// Iterate over the contents of a tree

tree.each {File file ->

    println file

}

// Filter a tree

FileTree filtered = tree.matching {

    include 'org/gradle/api/**'

}

// Add trees together

FileTree sum = tree + fileTree(dir: 'src/test')

// Visit the elements of the tree

tree.visit {element ->

    println "$element.relativePath => $element.file"

}

build.gradle

// Create a ZIP file tree using path

FileTree zip = zipTree('someFile.zip')

// Create a TAR file tree using path

FileTree tar = tarTree('someFile.tar')

//tar tree attempts to guess the compression based on the file extension

//however if you must specify the compression explicitly you can:

FileTree someTar = tarTree(resources.gzip('someTar.ext'))

build.gradle

// Use a File object to specify the source directory

compile {

    source = file('src/main/java')

}

// Use a String path to specify the source directory

compile {

    source = 'src/main/java'

}

// Use a collection to specify multiple source directories

compile {

    source = ['src/main/java', '../shared/java']

}

// Use a FileCollection (or FileTree in this case) to specify the source files

compile {

    source = fileTree(dir: 'src/main/java').matching { include 'org/gradle/api/**' }

}

// Using a closure to specify the source files.

compile {

    source = {

        // Use the contents of each zip file in the src dir

        file('src').listFiles().findAll {it.name.endsWith('.zip')}.collect { zipTree(it) }

    }

}

build.gradle

compile {

    // Add some source directories use String paths

    source 'src/main/java', 'src/main/groovy'

    // Add a source directory using a File object

    source file('../shared/java')

    // Add some source directories using a closure

    source { file('src/test/').listFiles() }

}

build.gradle

task copyTask(type: Copy) {

    from 'src/main/webapp'

    into 'build/explodedWar'

}

build.gradle

task anotherCopyTask(type: Copy) {

    // Copy everything under src/main/webapp

    from 'src/main/webapp'

    // Copy a single file

    from 'src/staging/index.html'

    // Copy the output of a task

    from copyTask

    // Copy the output of a task using Task outputs explicitly.

    from copyTaskWithPatterns.outputs

    // Copy the contents of a Zip file

    from zipTree('src/main/assets.zip')

    // Determine the destination directory later

    into { getDestDir() }

}

build.gradle

task copyTaskWithPatterns(type: Copy) {

    from 'src/main/webapp'

    into 'build/explodedWar'

    include '**/*.html'

    include '**/*.jsp'

    exclude { details -> details.file.name.endsWith('.html') && details.file.text.contains('staging') }

}

build.gradle

task copyMethod << {

    copy {

        from 'src/main/webapp'

        into 'build/explodedWar'

        include '**/*.html'

        include '**/*.jsp'

    }

}

build.gradle

task copyMethodWithExplicitDependencies{

    inputs.file copyTask // up-to-date check for inputs, plus add copyTask as dependency

    outputs.dir 'some-dir' // up-to-date check for outputs

    doLast{

        copy {

            // Copy the output of copyTask

            from copyTask

            into 'some-dir'

        }

    }

}

演示样例 16.15. 重命名复制的文件

task rename(type: Copy) {

    from 'src/main/webapp'

    into 'build/explodedWar'

    // Use a closure to map the file name

    rename { String fileName ->

        fileName.replace('-staging-', '')

    }

    // Use a regular expression to map the file name

    rename '(.+)-staging-(.+)', '$1$2'

    rename(/(.+)-staging-(.+)/, '$1$2')

}

演示样例 16.16. 过滤要复制的文件

import org.apache.tools.ant.filters.FixCrLfFilter

import org.apache.tools.ant.filters.ReplaceTokens

task filter(type: Copy) {

    from 'src/main/webapp'

    into 'build/explodedWar'

    // Substitute property references in files

    expand(copyright: '2009', version: '2.3.1')

    expand(project.properties)

    // Use some of the filters provided by Ant

    filter(FixCrLfFilter)

    filter(ReplaceTokens, tokens: [copyright: '2009', version: '2.3.1'])

    // Use a closure to filter each line

    filter { String line ->

        "[$line]"

    }

}

演示样例 16.17. 嵌套的复制规范

task nestedSpecs(type: Copy) {

    into 'build/explodedWar'

    exclude '**/*staging*'

    from('src/dist') {

        include '**/*.html'

    }

    into('libs') {

        from configurations.runtime

    }

}

build.gradle

task libs(type: Sync) {

    from configurations.runtime

    into "$buildDir/libs"

}

build.gradle

apply plugin: 'java'

task zip(type: Zip) {

    from 'src/dist'

    into('libs') {

        from configurations.runtime

    }

}

演示样例 16.20. 创建 ZIP 文件

apply plugin: 'java'

version = 1.0

task myZip(type: Zip) {

    from 'somedir'

}

println myZip.archiveName

println relativePath(myZip.destinationDir)

println relativePath(myZip.archivePath)

> gradle -q myZip

zipProject-1.0.zip

build/distributions

build/distributions/zipProject-1.0.zip

演示样例 16.21. 配置归档任务-自己定义归档名称

apply plugin: 'java'

version = 1.0

task myZip(type: Zip) {

    from 'somedir'

    baseName = 'customName'

}

println myZip.archiveName

> gradle -q myZip

customName-1.0.zip

演示样例 16.22. 配置归档任务 - appendix & classifier

apply plugin: 'java'

archivesBaseName = 'gradle'

version = 1.0

task myZip(type: Zip) {

    appendix = 'wrapper'

    classifier = 'src'

    from 'somedir'

}

println myZip.archiveName

> gradle -q myZip

gradle-wrapper-1.0-src.zip

表 16.1. 归档任务-命名属性