【Android Gradle 插件】Gradle 构建生命周期 ② ( Gradle 类的添加构建生命周期监听器函数 | Gradle#addListener 函数 )

Android Plugin DSL Reference 参考文档 :

• Android Studio 构建配置官方文档 : https://developer.android.google.cn/studio/build

• 添加构建依赖项 参考文档 : https://developer.android.google.cn/studio/build/dependencies

• Android Gradle 插件配置与 Gradle 配置关联 : 【Android Gradle 插件】Gradle 依赖管理 ① ( org.gradle.api.Project 配置 | Android Gradle 插件配置与 Gradle 配置关联 ) ★

• Android Gradle 插件文档主页 : https://google.github.io/android-gradle-dsl/2.3/

• BaseExtension 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.BaseExtension.html

• AppExtension ( build.gradle#android 配置 ) 文档位置 : android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.AppExtension.html

• build.gradle#android 模块配置文档 : android-gradle-dsl/2.3/com.android.build.gradle.AppExtension.html

• ProductFlavor ( build.gradle#android#defaultConfig 配置 ) 文档 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.ProductFlavor.html

• ProductFlavor#externalNativeBuild 配置 ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) : com.android.build.gradle.internal.dsl.ProductFlavor:externalNativeBuild

• ExternalNativeBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) 文档位置 : android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.ExternalNativeBuildOptions.html

• NdkBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild#ndkBuild 配置 ) 文档位置 : android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.NdkBuildOptions.html

• CmakeOptions ( build.gradle#android#defaultConfig#externalNativeBuild#cmake 配置 ) 文档位置 : android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.CmakeOptions.html

• JackOptions ( build.gradle#android#defaultConfig#jackOptions 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.JackOptions.html

• AnnotationProcessorOptions ( 注解处理器配置 ) ( build.gradle#android#defaultConfig#javaCompileOptions配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AnnotationProcessorOptions.html

• NdkOptions ( build.gradle#android#defaultConfig#ndk 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.NdkOptions.html

• NDK 参考文档 : Add C and C++ Code to Your Project.

• VectorDrawablesOptions ( build.gradle#android#defaultConfig#vectorDrawables 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.VectorDrawablesOptions.html

• BuildType ( build.gradle#android#buildTypes 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.BuildType.html

• SigningConfig ( build.gradle#android#signingConfigs 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.SigningConfig.html

• AaptOptions ( build.gradle#android#aaptOptions 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AaptOptions.html

• AndroidSourceSets ( build.gradle#android#sourceSets 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceSet.html

• AndroidSourceDirectorySet ( build.gradle#android#sourceSets#aidl/assets/java/jni/jniLibs 配置 ) 文档位置 :android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceDirectorySet.html

• AndroidSourceFile ( build.gradle#android#sourceSets#manifest 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceFile.html

• DataBindingOptions ( build.gradle#android#dataBinding ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DataBindingOptions.html

• DexOptions ( build.gradle#android#dexOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DexOptions.html

• LintOptions ( build.gradle#android#lintOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LintOptions.html

• PackagingOptions ( build.gradle#android#packagingOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.PackagingOptions.html

• Splits ( build.gradle#android#splits ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.Splits.html

• AbiSplitOptions ( build.gradle#android#splits#abi ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AbiSplitOptions.html

• LanguageSplitOptions ( build.gradle#android#splits#language ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LanguageSplitOptions.html

• DensitySplitOptions ( build.gradle#android#splits#density ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DensitySplitOptions.html

• TestOptions ( build.gradle#android#testOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.TestOptions.html

• Android 测试相关文档 : https://developer.android.google.cn/training/testing

• UnitTestOptions ( build.gradle#android#testOptions#unitTests ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.TestOptions.UnitTestOptions.html

• org.gradle.api.tasks.testing.Test 单元测试配置类 : https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/testing/Test.html

• LibraryExtension ( Library 依赖库的 build.gradle#android 配置 ) 文档 : android-gradle-dsl/2.3/com.android.build.gradle.LibraryExtension.html

• org.gradle.api.Project 配置 ( build.gradle 根配置 ) 文档 : https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html

• org.gradle.api.initialization.Settings 配置 文档 : https://docs.gradle.org/current/javadoc/org/gradle/api/initialization/Settings.html

• org.gradle.api.artifacts.dsl.DependencyHandler 配置 ( build.gradle#dependencies#implementation 配置 ) : https://docs.gradle.org/current/javadoc/org/gradle/api/artifacts/dsl/DependencyHandler.html

• 添加构建依赖项 参考文档 : https://developer.android.google.cn/studio/build/dependencies

• org.gradle.api.Task 配置 ( Gradle 任务类型 ) 文档 : https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html

• org.gradle.api.tasks.TaskContainer配置 ( Gradle 任务容器类型 ) 文档 : https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/TaskContainer.html

• org.gradle.api.DefaultTask 配置 ( Gradle 自定义任务类父类 ) 文档 : https://docs.gradle.org/current/javadoc/org/gradle/api/DefaultTask.html

• org.gradle.api.tasks.Delete 自带任务 ( clean 任务类型 ) 文档 : https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Delete.html

• org.gradle.api.tasks.bundling.Zip 自带任务 ( 任务类型 ) 文档 :https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Zip.html

• Gradle 自带任务查询界面 ( 搜索 Task Types ) : https://docs.gradle.org/current/dsl/#N1045C

• org.gradle.api.invocation.Gradle 文档 ( 可设置 Gradle 构建声明周期监听器 ) : https://docs.gradle.org/current/javadoc/org/gradle/api/invocation/Gradle.html

一、Gradle#addProjectEvaluationListener 函数

---

org.gradle.api.Project 配置 ( build.gradle 根配置 ) 文档 : https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html

org.gradle.api.initialization.Settings 配置 文档 : https://docs.gradle.org/current/javadoc/org/gradle/api/initialization/Settings.html

org.gradle.api.invocation.Gradle 文档 : https://docs.gradle.org/current/javadoc/org/gradle/api/invocation/Gradle.html

Project 中可以通过调用 Project#getGradle() 方法获取 Gradle 类 ,

public interface Project extends Comparable<Project>, ExtensionAware, PluginAware {
    
    
    Gradle getGradle();
    void beforeEvaluate(Closure var1);
    void afterEvaluate(Closure var1);
}

调用 Gradle 中的 Gradle#addProjectEvaluationListener 函数 , 可以添加一个 工程分析监听器 ProjectEvaluationListener , 可以监听到 Gradle 构建生命周期 中的分析过程 , 可以

• 在 分析之前回调监听器中的 ProjectEvaluationListener#beforeEvaluate 函数 ,
• 在 分析之后会调监听器中的 ProjectEvaluationListener#afterEvaluate 函数 ;

gradle.addProjectEvaluationListener(new ProjectEvaluationListener() {
    
    
    @Override
    void beforeEvaluate(Project project) {
    
    

    }

    @Override
    void afterEvaluate(Project project, ProjectState projectState) {
    
    

    }
})

二、Gradle#addBuildListener 函数

---

在 org.gradle.api.invocation.Gradle 中 , 还定义了Gradle#addBuildListener 函数 , 用于添加监听构建过程的监听器 ;

void addBuildListener​(BuildListener buildListener)

Adds a BuildListener to this Build instance. The listener is notified of events which occur during the execution of the build.
将 BuildListener 添加到此生成实例。侦听器会收到在执行生成期间发生的事件的通知。

Parameters:
buildListener - 要添加的监听器.

上述函数原型如下 :

public interface Project extends Comparable<Project>, ExtensionAware, PluginAware {
    
    
    Gradle getGradle();
    void beforeEvaluate(Closure var1);
    void afterEvaluate(Closure var1);
    void addBuildListener(BuildListener var1);
}

代码示例 :

gradle.addBuildListener(new BuildListener() {
    
    
    @Override
    void buildStarted(Gradle gradle) {
    
    
        // 构建开始时回调该函数
    }

    @Override
    void settingsEvaluated(Settings settings) {
    
    
        // 分析 settings.gradle 函数完成后回调该函数
    }

    @Override
    void projectsLoaded(Gradle gradle) {
    
    
        
    }

    @Override
    void projectsEvaluated(Gradle gradle) {
    
    

    }

    @Override
    void buildFinished(BuildResult buildResult) {
    
    
        // 构建完成时回调的函数
    }
})

三、Gradle#addListener 函数

---

Gradle#addListener 函数 , 用于添加 任何类型的监听器 ;

void addListener​(Object listener)

Adds the given listener to this build. 
将给定的侦听器添加到此生成。

The listener may implement any of the given listener interfaces:
侦听器可以实现任何给定的侦听器接口：

BuildListener
TaskExecutionGraphListener
ProjectEvaluationListener
StandardOutputListener
DependencyResolutionListener

The following listener types can be used, 
but are not supported when configuration caching is enabled. 
Their usage is deprecated and adding a listener of these types become an error in a future Gradle version:
可以使用以下侦听器类型，
但在启用配置缓存时不受支持。
它们的用法已被弃用，在未来的Gradle版本中添加这些类型的侦听器将成为一个错误：

TaskExecutionListener
TaskActionListener
TestListener
TestOutputListener

Parameters:
listener - The listener to add. Does nothing if this listener has already been added.
           要添加的侦听器。如果已添加此侦听器，则不执行任何操作

上述函数原型如下 :

public interface Project extends Comparable<Project>, ExtensionAware, PluginAware {
    
    
    Gradle getGradle();
    void beforeEvaluate(Closure var1);
    void afterEvaluate(Closure var1);
    void addBuildListener(BuildListener var1);
    void addListener(Object var1);
}