Fork me on GitHub

Android gradle插件基础

Posted on | In
Words count in article: 1,144 字 | Reading time ≈ 5 分钟

在项目的build.gradle文件中，我们可以看到默认的插件是这样的。

1
2
3
apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'

注意，本项目使用了kotlin，所以多用了两个插件，分别是kotlin-android和kotlin-android-extensions两个插件，如果我们需要自定义自己的插件，那么需要按照如下步骤创建

创建自定义插件

创建自定义插件项目

需要创建自定义gradle插件，第一步创建新module，但是需要注意，我们需要在项目的setting.gradle中将它去掉。

这里特别注意的是自定义插件项目的module名字是约定好的，必须为buildSrc

创建完module后目录如下：

微信图片_20190818144514.png

创建插件类

我这里是用Kotlin进行编写的，代码如下

1
2
3
4
5
6
7
8
9
10
11
12
package com.example.multilingual

import org.gradle.api.Plugin
import org.gradle.api.Project

class AutoMultilingualResourcePlugin : Plugin<Project> {
    
    override fun apply(project: Project) {
        
    }
    
}

其中的apply函数就是将插件引入到项目中的逻辑

自定义插件名字

我们的项目名是buildSrc无法自定义，但是插件的名字是我们自己定义的，定义的方法如下：

在项目的main目录下创建resources目录，再在resources目录下创建META-INF目录，META-INF目录下再创建gradle-plugins目录，再gradle-plugins目录下我们就能声明我们的自定义插件了，我们需要创建自定义插件名.properties

最后的目录结构如下

微信图片_20190818151247.png

可以看到，我自定义插件名字为cn.wongzhenyu.multilingual，这里要取自己的名字。

再这个文件中，我们还需要指定插件的入口，我这里填的如下：

1
implementation-class=com.example.multilingual.AutoMultilingualResourcePlugin

这样，我们就指定了本插件的入口，我们可以在主项目中使用了，像这样

1
apply plugin: 'cn.wongzhenyu.multilingual'

配置自定义插件

我们可以看到，Android插件需要配置很多东西，想这样

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
android {
    compileSdkVersion 29
    buildToolsVersion "29.0.0"
    defaultConfig {
        applicationId "com.example.automultilingualresourceplugin"
        minSdkVersion 15
        targetSdkVersion 29
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

自定义插件也能够实现这样，在build.gradle中配置参数，然后我们在插件中可以读取到，实现方式如下

创建扩展类

1
2
3
4
5
package com.example.multilingual

open class MultilingualPluginExtension{
     var output:Boolean = true
}

可以看到，我们创建了一个类，只有一个布尔值变量值为true

在build.gradle中配置参数

1
2
3
multilingual {
    output false
}

在自定义插件中创建扩展类并读取参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.example.multilingual

import com.example.multilingual.utils.FileUtil
import org.gradle.api.Plugin
import org.gradle.api.Project

class AutoMultilingualResourcePlugin : Plugin<Project> {
    
    private lateinit var extension: MultilingualPluginExtension

    override fun apply(project: Project) {
        extension = project.extensions.create("multilingual", MultilingualPluginExtension::class.java)
        project.afterEvaluate {
            FileUtil.INSTANCE.setIsOutput(extension.output)
        }
    }
    
}

这里需要特别注意的是，我们读取在build.gradle中配置的参数必须是在gradle的evaluate声明周期之后，否则读取的参数还是默认的，而不是在build.gradle中配置的

另一种插件:Transform

transform是插件是另一种用法，它相当于在app打包的过程中再插入了一个task，这个task会在assembleDebug之前执行，具体的代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
package com.example.multilingual

import com.android.build.api.transform.QualifiedContent
import com.android.build.api.transform.Transform
import com.android.build.api.transform.TransformInvocation
import com.android.build.gradle.internal.pipeline.TransformManager

class ShrinkResourcePlugin : Transform(){
    override fun getName(): String {
       return "Test"
    }

    override fun getInputTypes(): MutableSet<QualifiedContent.ContentType> {
        return TransformManager.CONTENT_CLASS
    }

    override fun getScopes(): MutableSet<in QualifiedContent.Scope> {
        return TransformManager.SCOPE_FULL_PROJECT
    }

    override fun isIncremental(): Boolean {
        return false
    }

    override fun transform(transformInvocation: TransformInvocation?) {
        ...//这里需要自己实现之前的逻辑，否则会打包出错，可添加自己的逻辑
    }
}

默认正确的transform函数如下，这是使用groovy实现的：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Override
   void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException, IOException {
       def inputs = transformInvocation.inputs
       def outputProvider = transformInvocation.outputProvider
       inputs.each {
           it.jarInputs.each {
               File dest = outputProvider.getContentLocation(it.name, it.contentTypes, it.scopes, Format.JAR)
               FileUtils.copyFile(it.file, dest)
           }

           it.directoryInputs.each {
               File dest = outputProvider.getContentLocation(it.name, it.contentTypes, it.scopes, Format.DIRECTORY)
               println "Dest: ${it.file}"
               FileUtils.copyDirectory(it.file, dest)
           }
       }
   }

Transform插件实现过程中需要实现的几个函数作用如下：

  • getName

返回task的名字

  • getInputTypes()

处理的文件的类型

  • getScopes()

处理的文件范围

  • isIncremental()

在transform()函数中对文件列表是否有增删改

  • transform()

具体的实现逻辑函数