总结android中的.gradle文件写法及含义

最新推荐文章于 2025-06-06 10:27:08 发布

冈上武松

最新推荐文章于 2025-06-06 10:27:08 发布

阅读量1.7k

点赞数

分类专栏： android

android 专栏收录该内容

52 篇文章

订阅专栏

1.项目根目录下的build.gradle文件

新建android 项目一般如下：

// Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.3'

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}


// 运行gradle clean时，执行此处定义的task。
// 该任务继承自Delete，删除根目录中的build目录。
// 相当于执行Delete.delete(rootProject.buildDir)。
// gradle使用groovy语言，调用method时可以不用加（）。
task clean(type: Delete) {
    delete rootProject.buildDir
}

内容一：

在编写Gradle脚本的时候，在build.gradle文件中经常看到这样的代码：

build.gradle

buildScript {
     repositories {
         mavenCentral()
}
}

repositories {
     mavenCentral()
}

这样子很容易让人奇怪，为什么repositories要声明两次哪？buildscript代码块中的声明与下半部分声明有什么不同？

其实答案非常简单。buildscript中的声明是gradle脚本自身需要使用的资源。可以声明的资源包括依赖项、第三方插件、maven仓库地址等。而在build.gradle文件中直接声明的依赖项、仓库地址等信息是项目自身需要的资源。

gradle是由groovy语言编写的，支持groovy语法，可以灵活的使用已有的各种ant插件、基于jvm的类库，这也是它比maven、ant等构建脚本强大的原因。虽然gradle支持开箱即用，但是如果你想在脚本中使用一些第三方的插件、类库等，就需要自己手动添加对这些插件、类库的引用。而这些插件、类库又不是直接服务于项目的，而是支持其它build脚本的运行。所以你应当将这部分的引用放置在buildscript代码块中。gradle在执行脚本时，会优先执行buildscript代码块中的内容，然后才会执行剩余的build脚本。

举个例子，假设我们要编写一个task，用于解析csv文件并输出其内容。虽然我们可以使用gradle编写解析csv文件的代码，但其实apache有个库已经实现了一个解析csv文件的库供我们直接使用。我们如果想要使用这个库，需要在gradle.build文件中加入对该库的引用。

build.gradle

buildscript {
    repositories {
        mavenLocal()
        mavenCentral()
    }

    dependencies {
        classpath 'org.apache.commons:commons-csv:1.0'
    }
}

import org.apache.commons.csv.*

task printCSV() {
    doLast {
        def records = CSVFormat.EXCEL.parse(new FileReader('config/sample.csv'))
        for (item in records) {
            print item.get(0) + ' '
            println item.get(1)
        }

    }
}

buildscript代码块中的repositories和dependencies的使用方式与直接在build.gradle文件中的使用方式几乎完全一样。唯一不同之处是在buildscript代码块中你可以对dependencies使用classpath声明。该classpath声明说明了在执行其余的build脚本时，class loader可以使用这些你提供的依赖项。这也正是我们使用buildscript代码块的目的。

而如果你的项目中需要使用该类库的话，就需要定义在buildscript代码块之外的dependencies代码块中。所以有可能会看到在build.gradle中出现以下代码：

build.gradle

repositories {
    mavenLocal()
    mavenCentral()
}

dependencies {
    compile 'org.springframework.ws:spring-ws-core:2.2.0.RELEASE',
            'org.apache.commons:commons-csv:1.0'
}


buildscript {
    repositories {
        mavenLocal()
        mavenCentral()
    }

    dependencies {
        classpath 'org.apache.commons:commons-csv:1.0'
    }
}

import org.apache.commons.csv.*

task printCSV() {
    doLast {
        def records = CSVFormat.EXCEL.parse(new FileReader('config/sample.csv'))
        for (item in records) {
            print item.get(0) + ' '
            println item.get(1)
        }

    }
}

buildscript中的声明是gradle脚本自身需要使用的资源。可以声明的资源包括依赖项、第三方插件、maven仓库地址等。而在build.gradle文件中直接声明的依赖项、仓库地址等信息是项目自身需要的资源。

内容二：

app module下的build.gradle文件

apply plugin: 'com.android.application'//说明module的类型，com.android.application为程序，com.android.library为库
 2 android {
 3     compileSdkVersion 22//编译的SDK版本
 4     buildToolsVersion "22.0.1"//编译的Tools版本
 5     defaultConfig {//默认配置
 6         applicationId "com.nd.famlink"//应用程序的包名
 7         minSdkVersion 8//支持的最低版本
 8         targetSdkVersion 19//支持的目标版本
 9         versionCode 52//版本号
10         versionName "3.0.1"//版本名
11     }
12     sourceSets {//目录指向配置
13         main {
14             manifest.srcFile 'AndroidManifest.xml'//指定AndroidManifest文件
15             java.srcDirs = ['src']//指定source目录
16             resources.srcDirs = ['src']//指定source目录
17             aidl.srcDirs = ['src']//指定source目录
18             renderscript.srcDirs = ['src']//指定source目录
19             res.srcDirs = ['res']//指定资源目录
20             assets.srcDirs = ['assets']//指定assets目录
21             jniLibs.srcDirs = ['libs']//指定lib库目录
22         }
23         debug.setRoot('build-types/debug')//指定debug模式的路径
24         release.setRoot('build-types/release')//指定release模式的路径
25     }
26     signingConfigs {//签名配置
27         release {//发布版签名配置
28             storeFile file("fk.keystore")//密钥文件路径
29             storePassword "123"//密钥文件密码
30             keyAlias "fk"//key别名
31             keyPassword "123"//key密码
32         }
33         debug {//debug版签名配置
34             storeFile file("fk.keystore")
35             storePassword "123"
36             keyAlias "fk"
37             keyPassword "123"
38         }
39     }

     // java版本
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_7
        targetCompatibility JavaVersion.VERSION_1_7
    }



 40     buildTypes {//build类型  打包配置41         release {//发布42             minifyEnabled true//混淆开启43             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-project.txt'//指定混淆规则文件44             signingConfig signingConfigs.release//设置签名信息45         }46         debug {//调试47             signingConfig signingConfigs.release48         }49     }50     packagingOptions {51         exclude 'META-INF/ASL2.0'52         exclude 'META-INF/LICENSE'53         exclude 'META-INF/NOTICE'54         exclude 'META-INF/MANIFEST.MF'55     }56     lintOptions {57         abortOnError false//lint时候终止错误上报,防止编译的时候莫名的失败58     }59 }60 dependencies {61     compile fileTree(dir: 'libs', exclude: ['android-support*.jar'], include: ['*.jar'])   //编译lib目录下的.jar文件62     compile project(':Easylink')//编译附加的项目63     compile project(':ImageLibrary')64     compile project(':ImageResLibrary')65     compile project(':Ofdmtransport')66     compile project(':PullToRefreshLibrary')67     compile project(':RecorderLibrary')68     compile project(':WebSocket') 69     compile project(':WidgetLibrary')70     compile 'com.nostra13.universalimageloader:universal-image-loader:1.9.3'//编译来自Jcenter的第三方开源库71 }

内容三：

settings.gradle

这个文件是全局的项目配置文件，里面主要声明一些需要加入gradle的module

include ':app', ':pickerview', ':ImageViewTouch', ':Gpu-Image'

内容四：

你在全局的gradle文件中定义一些属性，然后再模块中运用它们。比如你可以在根目录下这么定义：

 ext {
       compileSdkVersion = 22
       buildToolsVersion = "22.0.1"
}

那么你在子模块中就可以使用这些属性了：

android {
       compileSdkVersion rootProject.ext.compileSdkVersion
       buildToolsVersion rootProject.ext.buildToolsVersion
 }

比如下根目录下创建一个version.gradle文件，那么可以在别的gradle文件中引用version.gradle中设置的常量，这就是对上面内容四的示例。