详解build-gradle文件

目录

• gradle
• 两个build.gradle文件
  • 最外层目录下的build.gradle文件
    • jcenter
    • dependencies闭包
  • app目录下的build.gradle文件
    • com.android.application
    • android闭包
      • defaultConfig闭包
        • applicationId
        • minSdkVersion
        • targetSdkVersion
        • versionCode
        • versionName
      • buildTypes闭包
        • debug闭包
        • release闭包
          • minifyEnabled
          • proguardFiles
    • dependencies闭包
      • Android Studio项目的3种依赖方式
        • 本地依赖
        • 库依赖
        • 远程依赖
      • dependencies闭包中的配置
        • compile fileTree
        • compile（和书上有区别）

gradle

不同于Eclipse，Android Studio是采用Gradle来构建项目的。Gradle是一个非常先进的项目构建工具，它使用了一种基于Groovy的领域特定语言（DSL）来声明项目设置，摒弃了传统基于XML（如Ant和Maven）的各种烦琐配置。

两个build.gradle文件

一般项目中有两个build.gradle文件，一个是在最外层目录下的，一个是在app目录下的。这两个文件对构建Android Studio项目都起到了至关重要的作用，下面我们就来对这两个文件中的内容进行详细的分析。

最外层目录下的build.gradle文件

先来看一下最外层目录下的build.gradle文件，代码如下所示：

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

buildscript {
    repositories {
        google()
        jcenter()

    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.5.2'

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

allprojects {
    repositories {
        google()
        jcenter()

    }
}

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

这些代码都是自动生成的，虽然语法结构看上去可能有点难以理解，但是如果我们忽略语法结构，只看最关键的部分，其实还是很好懂的。

jcenter

首先，两处repositories的闭包中都声明了jcenter()这行配置，那么这个jcenter是什么意思呢？其实它是一个代码托管仓库，很多Android开源项目都会选择将代码托管到jcenter上，声明了这行配置之后，我们就可以在项目中轻松引用任何jcenter上的开源项目了。

dependencies闭包

接下来，dependencies闭包中使用classpath声明了一个Gradle插件。为什么要声明这个插件呢？因为Gradle并不是专门为构建Android项目而开发的，Java、C++等很多种项目都可以使用Gradle来构建。因此如果我们要想使用它来构建Android项目，则需要声明com.android.tools.build:gradle:3.5.2这个插件。其中，最后面的部分是插件的版本号，现在显示的插件版本是3.5.2。

这样我们就将最外层目录下的build.gradle文件分析完了，通常情况下你并不需要修改这个文件中的内容，除非你想添加一些全局的项目构建配置。

app目录下的build.gradle文件

下面我们再来看一下app目录下的build.gradle文件，代码如下所示：

apply plugin: 'com.android.application'

android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"
    defaultConfig {
        applicationId "com.example.myapplication"
        minSdkVersion 15
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'androidx.appcompat:appcompat:1.0.2'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'androidx.test.ext:junit:1.1.0'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1'
}

com.android.application

这个文件中的内容就要相对复杂一些了，下面我们一行行地进行分析。首先第一行应用了一个插件，一般有两种值可选：com.android.application表示这是一个应用程序模块，com.android.library表示这是一个库模块。应用程序模块和库模块的最大区别在于，一个是可以直接运行的，一个只能作为代码库依附于别的应用程序模块来运行。

android闭包

接下来是一个大的android闭包，在这个闭包中我们可以配置项目构建的各种属性。其中，compileSdkVersion用于指定项目的编译版本，这里指定成24表示使用Android7.0系统的SDK编译。buildToolsVersion用于指定项目构建工具的版本，目前最新的版本就是30.0.3，如果有更新的版本时，Android Studio会进行提示。

defaultConfig闭包

然后我们看到，这里在android闭包中又嵌套了一个defaultConfig闭包，defaultConfig闭包中可以对项目的更多细节进行配置。

applicationId

用于指定项目的包名，前面我们在创建项目的时候其实已经指定过包名了，如果你想在后面对其进行修改，那么就是在这里修改的。

minSdkVersion

用于指定项目最低兼容的Android系统版本，这里指定成15表示最低兼容到Android4.0系统。

targetSdkVersion

指定的值表示你在该目标版本上已经做过了充分的测试，系统将会为你的应用程序启用一些最新的功能和特性。比如说Android6.0系统中引入了运行时权限这个功能，如果你将targetSdkVersion指定成23或者更高，那么系统就会为你的程序启用运行时权限功能，而如果你将targetSdkVersion指定成22，那么就说明你的程序最高只在Android5.1系统上做过充分的测试，Android6.0系统中引入的新功能自然就不会启用了。

versionCode

用于指定项目的版本号

versionName

用于指定项目的版本名

buildTypes闭包

分析完了defaultConfig闭包，接下来我们看一下buildTypes闭包。buildTypes闭包中用于指定生成安装文件的相关配置，通常只会有两个子闭包，一个是debug，一个是release。另外，debug闭包是可以忽略不写的，因此我们看到上面的代码中就只有一个release闭包。

debug闭包

debug闭包用于指定生成测试版安装文件的配置

release闭包

release闭包用于指定生成正式版安装文件的配置

minifyEnabled

用于指定是否对项目的代码进行混淆，true表示混淆，false表示不混淆

proguardFiles

用于指定混淆时使用的规则文件，这里的指定了两个文件，第一个proguard-android.txt是在Android SDK目录下的，里面是所有项目通用的混淆规则，第二个proguard-rules.pro是在当前项目的根目录下的，里面可以编写当前项目特有的混淆规则。需要注意的是，通过Android Studio直接运行项目生成的都是测试版安装文件。

dependencies闭包

这样整个android闭包中的内容就都分析完了，接下来还剩一个dependencies闭包。这个闭包的功能非常强大，它可以指定当前项目所有的依赖关系。

Android Studio项目的3种依赖方式

• 本地依赖
• 库依赖
• 远程依赖

本地依赖

本地依赖可以对本地的Jar包或目录添加依赖关系

库依赖

库依赖可以对项目中的库模块添加依赖关系

远程依赖

远程依赖则可以对jcenter库上的开源项目添加依赖关系

dependencies闭包中的配置

compile fileTree

一个本地依赖声明，它表示将libs目录下所有.jar后缀的文件都添加到项目的构建路径当中。

compile（和书上有区别）

远程依赖声明，com.android.support:appcompat-v7：24.2.1就是一个标准的远程依赖库格式，其中com.android.support是域名部分，用于和其他公司的库做区分；appcompat-v7是组名称，用于和同一个公司中不同的库做区分；24.2.1是版本号，用于和同一个库不同的版本做区分。加上这句声明后，Gradle在构建项目时会首先检查一下本地是否已经有这个库的缓存，如果没有的话则会去自动联网下载，然后再添加到项目的构建路径当中。至于库依赖声明这里没有用到，它的基本格式是compile project 后面加上要依赖的库名称，比如说有一个库模块的名字叫helper，那么添加这个库的依赖关系只需要加入compile project（'：helper）这句声明即可。另外剩的一句testcompile是用于声明测试用例库的，这个我们暂时用不到，先忽略它就可以了。