Android Gradle构建流程

ゝ一纸荒年。 2022-10-14 01:21 282阅读 0赞

## 概述 ##

对于刚接触java语言的人来说，程序的入口那就是main（）函数了，这也是大家都懂的，但对于gradle而言，我们却不知道他是从何开始执行的，因为我们没有发现他的main（）函数在哪里，这里有一点需要明白，groovy是脚本语言，我们在groovy中编写一段代码，不需要写类，他就可以直接运行起来，其实，groovy在编译的时候也是会先将我们所写的代码块编译成java的类，然后在运行起来的，实际上gradle是会将我们的代码编译成class文件然后在main（）函数中运行起来，只不过这个过程全部封装了起来，我们没看到而已。

## Gradle 项目结构 ##

gradle是用来构建项目的，可以用来组织android各个module的，要想对gradle有一个比较清晰的了解，得先熟悉gradle中的几个对象：

*  1、Gradle对象；
 *  2、Settings对象；
 *  3、Project对象；

一个工程只有一个gradle对象，一个settings.gradle对应一个Settings对象，多个Project对象，每次修改了.gradle文件时，都会有**Sync Now**这样的字样要求我们同步工程，点击后其实gradle就会先创建出一个Gradle对象，这个对象会先去读取settings.gradle文件，构建Settings对象，在有了Settings对象后，根据里面的内容就可以构建出Project对象，Project对象的构建个数与Settings中配置个数有关。

说了这么多之后，可能会有有些迷糊，下面我们就在实际的工程中来看下它的执行流程，毕竟代码才能让我们更直观的了解，首先来看下工程的一个目录结构：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAxOTQyNzE_size_16_color_FFFFFF_t_70_pic_center]

## Gradle 构建生命周期 ##

Gradle build的生命周期主要分为三大部分：初始化阶段，配置阶段和执行阶段，可参考官方文档：Gradle Build Lifecycle

### 初始化阶段（Initialization） ###

Gradle支持单工程或者多工程构建，初始化阶段的任务是确定有多少工程需要构建，创建整个项目的层次结构，并且为每一个项目创建一个Project实例对象。

如果是多工程构建，一般都会在根工程目录下声明一个settings.gradle脚本，在脚本中include所有需要参与构建的子工程，通过解析settings.gradle脚本，读取include信息，确定有多少个Project需要构建。

### 配置阶段（Configuration） ###

配置阶段的主要任务是生成整个构建过程的有向无环图

确定了所有需要参与构建的工程后，通过读取解析各个工程对应的build.gradle脚本，构造Task任务，并根据Task的依赖关系，生成一个基于Task的有向无环图TaskExecutionGraph

### 执行阶段（Execution） ###

通过读取配置阶段生成有向无环图TaskExecutionGraph，按顺序依此执行各个Task，像流水线一样，一步一步构建整个工程，这也是构建过程中最耗时的阶段。

以下图片来自网络，可以看到，整个 Gradle 生命周期的流程包含如下部分。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAxOTQyNzE_size_16_color_FFFFFF_t_70_pic_center 1]

## 构建代码 ##

这里主要看的就是这些.gradle文件，首先来看settings.gradle这个文件，在这个文件里添加了一些代码，主要是用来监听gradle执行到哪了：

include ':app', ':netlib'
    gradle.addBuildListener(new BuildListener() {
        
        //Called when the build is started
        //看文档注释说这里一开始构建就会执行，但就是没看见的打印的log
        @Override
        void buildStarted(Gradle gradle) {
        
            println "gradle start ======================================== "
        }
        //Called when the build settings have been loaded and evaluated. The settings object
        // is fully configured and is ready to use to load the build projects
        //Settings对象加载和评估完成后执行这里,执行完这里即将开始构建Project对象
        @Override
        void settingsEvaluated(Settings settings) {
        
            println "setting evaluated = "+settings.rootProject.children
        }
     
        //Called when the projects for the build have been created from the settings.
        // None of the projects have been evaluated
        //当所有的Project对象构建完后会执行到这里，执行到这里时，Project还没有评估
        @Override
        void projectsLoaded(Gradle gradle) {
        
            gradle.allprojects {
         project ->
                println "project name = "+project.name
            }
            println "projects load"
        }
        //Called when all projects for the build have been evaluated. The project objects
        // are fully configured and are ready to use to populate the task graph
        //在所有的Project对象构建完并且已经评估后会执行到这里，之后就开始执行Project中的任务了
        @Override
        void projectsEvaluated(Gradle gradle) {
        
            println "projects valuated"
        }
        //Called when the build is completed. All selected tasks have been executed.
        //所有的Project（包括任务）构建完后执行这里
        @Override
        void buildFinished(BuildResult result) {
        
            println "build result = "+result
        }
    })
    gradle.addProjectEvaluationListener(new ProjectEvaluationListener() {
        
        //This method is called immediately before a project is evaluated.
        //Project开始评估执行这里
        @Override
        void beforeEvaluate(Project project) {
        
            println "before evaluated = "+project.name
        }
        // This method is called when a project has been evaluated, and before
        // the evaluated project is made available to other projects.
        // Project评估完执行这里，评估成功后就开始评估下一个Project
        @Override
        void afterEvaluate(Project project, ProjectState state) {
        
            println "after valuated = "+project.name
        }
    })

看了settings.gradle后，接下来就来看下rootProject的build.gradle的配置，就是和settings.gradle在同一目录下的那个：

buildscript {
        
        //这里的配置主要是为了构建gradle
        repositories {
        
            google()
            jcenter()
        }
        dependencies {
        
            classpath 'com.android.tools.build:gradle:3.1.0'
     
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
        }
    }
     
    allprojects {
        
        //这里是为每一个project提供相同的配置
        println "common config project name = "+project.name
        repositories {
        
            google()
            jcenter()
            maven {
         url "https://jitpack.io" }
        }
    }
     
    task clean(type: Delete) {
        
        delete rootProject.buildDir
    }

## 总结 ##

这里在总结下gradle的大体流程：

1、开始build的时，会创建一个Gradle对象，这个对象是唯一的，全局共享；

2、Gradle对象创建完后，接下来就是去怎么组合整个工程了，为了知道需要组合那些project，这时就需要去读取settings.gradle文件了，这时就会创建一个Settings对象，这个对象中就会包含组合工程所需的各个project，以及各个project的地址（其实就是在那个文件夹下），这个地址我们是可以修改的，具体怎么修改，下一遍再说；

3、在读取settings.gradle文件的同时，也是会创建相应的project，只不过这个project没有被评估（我的理解就是没被初始化），剩下的就是对每个project进行评估，最后在对整个工程进行评估，在这些都做完之后，接下来就是执行每个project的task了，等到所有任务都执行完了，整个工程也就build完了，也就可以运行起来了。  
————————————————  
版权声明：本文为CSDN博主「tangedegushi」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。  
原文链接：https://blog.csdn.net/tangedegushi/article/details/82800228

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAxOTQyNzE_size_16_color_FFFFFF_t_70_pic_center]: /images/20221014/1e674eb286c74ec99698c5b210872700.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAxOTQyNzE_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221014/c1ba283c41df4bd0ac638ca8b4d71b35.png