gradle挂接到构建生命周期(七)
目錄
- 1. 概念
- 2. 使用gradle提供的閉包
- 3. 實現gradle API提供的監聽器接口
1. 概念
我們知道,gradle的生命周期為 初始化階段 => 配置階段 => 執行階段
我們可以在通過doFirst和doLast在來掛接到task的執行階段中,但是如果我們想在gradle 掛接到不同生命周期中,我們應該怎么做呢?
有兩種方式可以編寫這種生命周期事件: 使用gradle提供的閉包,和gradle API提供的監聽器接口來實現。
2. 使用gradle提供的閉包
我們以gradle.taskGraph.whenReady為例子,gradle.taskGraph.whenReady在配置完成階段,即task圖生成完成后,因為構建確切的知道task在得到執行之前哪些將參與構建,假設當我們的腳本文件build.gradle中如果有releaseProject 這個task的話,我們就把release 變為true。
task releaseProject << {logger.quiet 'Releasing the project...' }gradle.taskGraph.whenReady{TaskExecutionGraph taskGraph ->//注冊的生命周期鉤子在task圖生成后被調用if(taskGraph.hasTask(releaseProject)){if(!version.release){version.release=trueant.propertyfile(file:versionFile){entry(key:'release',type:'string',operation:'=',value: 'true')}}} }3. 實現gradle API提供的監聽器接口
通過監聽器掛接到構建生命周期只需要兩個簡單的步驟:
- 通過在構建腳本中編寫一個類實現特定的監聽器接口
- 注冊監聽器實現
監聽task執行圖事件的接口是由TaskExecutionGraphListener提供,里面只聲明了一個方法 graphPopulated
public interface TaskExecutionGraphListener{void graphPopulated(TaskExecutionGraph taskGraph); }我們看看傳入的參數TaskExecutionGraph 到底是何方神圣?
// TaskExecutionGraph 可以把它理解成一幅生成的task地圖 public interface TaskExecutionGraph {void addTaskExecutionGraphListener(TaskExecutionGraphListener var1);void removeTaskExecutionGraphListener(TaskExecutionGraphListener var1);void addTaskExecutionListener(TaskExecutionListener var1);void removeTaskExecutionListener(TaskExecutionListener var1);void whenReady(Closure var1);void whenReady(Action<TaskExecutionGraph> var1);void beforeTask(Closure var1);void beforeTask(Action<Task> var1);void afterTask(Closure var1);void afterTask(Action<Task> var1);boolean hasTask(String var1);boolean hasTask(Task var1);List<Task> getAllTasks(); }于是我們寫一個類去實現TaskExecutionGraphListener,然后實現graphPopulate方法就可以了,其中的參數TaskExecutionGraph可以獲得task圖生成過程中的很多信息。
class ReleaseVersionListener implements TaskExecutionGraphListener {final static String releaseTaskPath = ':releaseProject'@Overridevoid graphPopulated(TaskExecutionGraph taskGraph) {// 確定releaseProject task 是否包含在執行圖中if (taskGraph.hasTask(releaseTaskPath)) {List<Task> allTasks = taskGraph.allTasks// 從執行圖中的所有task來找到releaseProject 的 task 實例Task releaseTask = allTasks.find { it.path == releaseTaskPath }// 每個task都知道自己所屬的projectProject project = releaseTask.projectif (!project.version.release) {project.version.release = trueproject.ant.propertyfile(file: project.versionFile) {entry(key: 'release', type: 'string', operation: '=', value: 'true')}}}} }注冊監聽器到task執行圖中
// 注冊監聽器到task執行圖中 gradle.taskGraph.addTaskExecutionGraphListener(new ReleaseVersionListener())這兩種方法有什么相同之處呢,我們可以看到第一種方式中的gradle.taskGraph.whenReady中的whenReady 是第二種方法中的類TaskExecutionGraph的一個接口方法。
那么我們可以推測出gradle.taskGraph所引用的對象實際上就是TaskExecutionGraph 的一個實現。
第一種方式:閉包
- gradle.beforeProject
- gradle.taskGraph.whenReady
- grale.buildFinished
第二種方法:監聽器
- 創建監聽器,實現TaskExecutionGraphListener的graphPopulated方法
- gradle.taskGraph.addTaskExecutionGraphListener注冊監聽器
總結
以上是生活随笔為你收集整理的gradle挂接到构建生命周期(七)的全部內容,希望文章能夠幫你解決所遇到的問題。
 
                            
                        - 上一篇: gradle 的 依赖管理(八)
- 下一篇: gradle的多项目构建(九)
