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

Posted 韩曙亮

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Android Gradle 插件Gradle 构建生命周期 ② ( Gradle 类的添加构建生命周期监听器函数 | Gradle#addListener 函数 )相关的知识，希望对你有一定的参考价值。

文章目录

Android Plugin DSL Reference 参考文档 :





一、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);

以上是关于Android Gradle 插件Gradle 构建生命周期 ② ( Gradle 类的添加构建生命周期监听器函数 | Gradle#addListener 函数 )的主要内容，如果未能解决你的问题，请参考以下文章

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

Android Gradle 插件Gradle 构建机制 ⑤ ( 在 Android Studio 中查看 Android Gradle 插件源码 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ② ( buildSrc 目录中实现 Gradle 插件 | 实现 Gradle 插件代码 | 模块引入插件并编译 )

Android Gradle 插件Android Module 模块 build.gradle 构建脚本 Groovy 语法分析 ① ( Gradle 二进制插件引入 | Gradle依赖配置 )

Android Gradle 插件Android Module 模块 build.gradle 构建脚本 Groovy 语法分析 ① ( Gradle 二进制插件引入 | Gradle依赖配置 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ③ ( 自定义插件作用 | Android Gradle 插件的扩展 | 自定义 Extension 扩展 )