開發效率優化之自動化構建系統Gradle（二）上篇

 

阿里P7移動互聯網架構師進階視頻（每日更新中）免費學習請點擊：https://space.bilibili.com/474380680

本篇文章將如下兩個內容來介紹自動化構建系統Gradle:

• gradle 與 android gradle 插件的關係
• Gradle Transform API 的基本使用

1、gradle 與 android gradle 插件的關係

1.1名詞解釋：

1.1.1，Gradle

Gradle是一種構建工具，它使用一種基於Groovy的特定領域語言（DSL）來構建項目。不單單用於android 工程的構建。

1.1.2，Android Plugin for Gradle

這就是爲了編譯android 工程而開發的插件。下面就是申明Android Gradle 插件的位置。（build.gradle）

buildscript {
  ...
  dependencies {
    classpath 'com.android.tools.build:gradle:2.2.0'
  }
｝

1.2 gradle 與 android gradle

1.2.1,gradle 各版本源碼地址

http://services.gradle.org/distributions/

1.2.2, google 官網 gradle 插件 與 gradle 版本對照地址

https://developer.android.google.cn/studio/releases/gradle-plugin#updating-plugin

 

 

​

 

 

1.2.3,gradle 版本與google gradle 插件版本的區別

在gradle wrapper.properties 中寫的是 gradle 版本。

distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip

在build.gradle 中依賴的是 gradle插件版本。

dependencies {
    //[this is the android gradle plugin version]
    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
}

2、Gradle Transform API 的基本使用

2.1什麼是Transform

官方API文檔: http://google.github.io/android-gradle-dsl/javadoc/2.1/com/android/build/api/transform/Transform.html

咱們編譯Android項目時，若是咱們想拿到編譯時產生的Class文件，並在生成Dex以前作一些處理，咱們能夠經過編寫一個Transform來接收這些輸入(編譯產生的Class文件),並向已經產生的輸入中添加一些東西。

咱們能夠經過Gradle插件來註冊咱們編寫的Transform。註冊後的Transform會被Gradle包裝成一個Gradle Task，這個TransForm Task會在java compile Task執行完畢後運行。

對於編寫Transform的API, 咱們能夠經過引入下面這個依賴來使用:

compile 'com.android.tools.build:gradle:2.3.3'  //版本應該在 2.x以上

先大體看一下Transform的執行流程圖:

 

​

 

2.2 Transform的使用場景

通常咱們使用Transform會有下面兩種場景

1. 咱們須要對編譯class文件作自定義的處理。
2. 咱們須要讀取編譯產生的class文件，作一些其餘事情，可是不須要修改它。

接下來咱們就來看一下這些Transform API吧 :

2.3 Transform API學習

咱們編寫一個自定義的transform須要繼承Transform,它是一個抽象類, 咱們這裏先看一下Transform的抽象方法:

public abstract class Transform {
    public abstract String getName();

    public abstract Set<ContentType> getInputTypes();

    public abstract Set<? super Scope> getScopes();

    public abstract boolean isIncremental(); // 是否支持增量編譯
}

getName()就是指定自定義的Transform的名字。

2.4 輸入的類型

Set<ContentType> getInputTypes()是指明你自定義的這個Transform處理的輸入類型，輸入類型共有如下幾種:

enum DefaultContentType implements ContentType {
        /**
         * The content is compiled Java code. This can be in a Jar file or in a folder. If
         * in a folder, it is expected to in sub-folders matching package names.
         */
        CLASSES(0x01),

        /**
         * The content is standard Java resources.
         */
        RESOURCES(0x02);
    }

即分爲class文件或者java資源。class文件來自於jar或者文件夾。資源就是標準的java資源。

2.5 輸入文件所屬的範圍 Scope

getScopes()用來指明自定的Transform的輸入文件所屬的範圍, 這是由於gradle是支持多工程編譯的。總共有如下幾種:

/**
     * This indicates what the content represents, so that Transforms can apply to only part(s)
     * of the classes or resources that the build manipulates.
     */
    enum Scope implements ScopeType {
        /** Only the project content */
        PROJECT(0x01), //只是當前工程的代碼
        /** Only the project's local dependencies (local jars) */
        PROJECT_LOCAL_DEPS(0x02), // 工程的本地jar
        /** Only the sub-projects. */
        SUB_PROJECTS(0x04),  // 只包含子工工程
        /** Only the sub-projects's local dependencies (local jars). */
        SUB_PROJECTS_LOCAL_DEPS(0x08),
        /** Only the external libraries */
        EXTERNAL_LIBRARIES(0x10),
        /** Code that is being tested by the current variant, including dependencies */
        TESTED_CODE(0x20),
        /** Local or remote dependencies that are provided-only */
        PROVIDED_ONLY(0x40);
    }

對於getScopes()的返回，其實TransformManager已經爲咱們定義了一些，好比:

public static final Set<Scope> SCOPE_FULL_PROJECT = Sets.immutableEnumSet(
            Scope.PROJECT, Scope.PROJECT_LOCAL_DEPS, Scope.SUB_PROJECTS, Scope.SUB_PROJECTS_LOCAL_DEPS, Scope.EXTERNAL_LIBRARIES);

若是一個Transform不想處理任何輸入，只是想查看輸入的內容,那麼只需在getScopes()返回一個空集合，在getReferencedScopes()返回想要接收的範圍。

public Set<? super Scope> getReferencedScopes() {
        return ImmutableSet.of();
    }

2.6 transform()

它是Transform的關鍵方法:

public void transform(@NonNull TransformInvocation transformInvocation) {}

它是一個空實現，input的內容將會打包成一個TransformInvocation對象，由於咱們要想使用input,咱們須要詳細瞭解一下TransformInvocation參數。

2.7 TransformInvocation

咱們看一下這個類相關的API:

public interface TransformInvocation {

    Collection<TransformInput> getInputs(); // 輸入做爲 TransformInput 返回

    TransformOutputProvider getOutputProvider(); //TransformOutputProvider 能夠用來建立輸出內容

    boolean isIncremental();
}

public interface TransformInput {
    Collection<JarInput> getJarInputs();
    Collection<DirectoryInput> getDirectoryInputs();
}

public interface JarInput extends QualifiedContent {

    File getFile(); //jar文件

    Set<ContentType> getContentTypes(); // 是class仍是resource

    Set<? super Scope> getScopes();  //屬於Scope：
}

DirectoryInput與JarInput定義基本相同。

public interface TransformOutputProvider {
    //根據 name、ContentType、QualifiedContent.Scope返回對應的文件( jar / directory)
    File getContentLocation(String name, Set<QualifiedContent.ContentType> types, Set<? super QualifiedContent.Scope> scopes, Format format);
}

即咱們能夠經過TransformInvocation來獲取輸入,同時也得到了輸出的功能。舉個例子，

public void transform(TransformInvocation invocation) {
        for (TransformInput input : invocation.getInputs()) {
            input.getJarInputs().parallelStream().forEach(jarInput -> {
            File src = jarInput.getFile();
            JarFile jarFile = new JarFile(file);
            Enumeration<JarEntry> entries = jarFile.entries();
            while (entries.hasMoreElements()) {
                JarEntry entry = entries.nextElement();
                //處理
            }
        }
    }

上面這段代碼就是獲取jar的輸入，而後遍歷每個jar作一些自定義的處理。

咱們在作完自定義的處理後，若是想本身輸出一些東西怎麼辦？ 好比一個class文件,就能夠經過TransformOutputProvider來完成。好比下面這段代碼:

File dest = invocation.getOutputProvider().getContentLocation("susion", TransformManager.CONTENT_CLASS, ImmutableSet.of(QualifiedContent.Scope.PROJECT), Format.DIRECTORY;

這段代碼就是在本工程(ImmutableSet.of(QualifiedContent.Scope.PROJECT))下產生一個目錄(Format.DIRECTORY), 目錄的名字是(susion),裏面的內容是TransformManager.CONTENT_CLASS。

建立這個文件夾後，咱們就能夠向其中寫入一些內容，好比class文件。

2.8 註冊Transform

咱們在瞭解transform api後，咱們能夠編寫一個自定義的Transform。可是咱們編寫的這個Transform,如何在構建過程當中生效呢？咱們須要註冊它

在自定義插件中註冊它,而後在build.gradle中apply就能夠了。

//MyCustomPlgin.groovy
public class MyCustomPlgin implements Plugin<Project> {

    @Override
    public void apply(Project project) {
        project.getExtensions().findByType(BaseExtension.class)
                .registerTransform(new MyCustomTransform());
    }
}

其實若是你包含了你編寫的transform庫，咱們也能夠直接在build.gradle中註冊:

//在build.gradle中也是能夠直接編寫 groovy代碼的。
project.extensions.findByType(BaseExtension.class).registerTransform(new MyCustomTransform());

參考：https://www.jianshu.com/p/031b62d02607
https://my.oschina.net/u/592116/blog/1851743

阿里P7移動互聯網架構師進階視頻（每日更新中）免費學習請點擊：https://space.bilibili.com/474380680

結束語

但願讀到這的您能轉發分享和關注一下我，之後還會持續分享阿里P7 Android高級架構進階知識點及解析，您的支持就是我最大的動力！！

 

​