AndroidPlugin源码解析-(六)

上篇提到，我们这篇研究的是接下来三个过程, 分别是:

createBuildConfigTask
createApkProcessResTask
createProcessJavaResTasks

接下来，我们一个一个来看

createBuildConfigTask

这个 task 实际执行如下方法:

// must clear the folder in case the packagename changed, otherwise,
// there'll be two classes.
File destinationDir = getSourceOutputDir();
FileUtils.cleanOutputDir(destinationDir);

BuildConfigGenerator generator = new BuildConfigGenerator(
       getSourceOutputDir(),
       getBuildConfigPackageName());

// Hack (see IDEA-100046): We want to avoid reporting "condition is always true"
// from the data flow inspection, so use a non-constant value. However, that defeats
// the purpose of this flag (when not in debug mode, if (BuildConfig.DEBUG && ...) will
// be completely removed by the compiler), so as a hack we do it only for the case
// where debug is true, which is the most likely scenario while the user is looking
// at source code.
//map.put(PH_DEBUG, Boolean.toString(mDebug));
generator.addField("boolean", "DEBUG",
       isDebuggable() ? "Boolean.parseBoolean(\"true\")" : "false")
       .addField("String", "APPLICATION_ID", '"' + getAppPackageName() + '"')
       .addField("String", "BUILD_TYPE", '"' + getBuildTypeName() + '"')
       .addField("String", "FLAVOR", '"' + getFlavorName() + '"')
       .addField("int", "VERSION_CODE", Integer.toString(getVersionCode()))
       .addField("String", "VERSION_NAME", '"' + Strings.nullToEmpty(getVersionName()) + '"')
       .addItems(getItems());

List<String> flavors = getFlavorNamesWithDimensionNames();
int count = flavors.size();
if (count > 1) {
   for (int i = 0; i < count; i += 2) {
       generator.addField(
               "String", "FLAVOR_" + flavors.get(i + 1), '"' + flavors.get(i) + '"');
   }
}

generator.generate();

这个方法的结果是build/generated/source/${buildTypes}/${packageName}目录下生成BuildConfig.java文件。这个我相信大家都很熟悉了。

我们可以看到, 即使我们在 build.gradle 中不填任何buildConfigField，也会生成这样一个文件，这个文件里的内容一定有 DEBUG, APPLICATION_ID, BUILD_TYPE, FLAVOR, VERSION_CODE, VERSION_NAME 字段。

DEBUG 这个字段是由 isDebuggable 这个方法决定的。也就是我们平时会在 debug{}或者 release{}中写的debuggable true。

getItems不用说，就是把我们用buildConfigField声明的参数转化为Field。

最后的generate方法就不看具体实现了，就是按照 Java 文件格式，将这些内容写入BuildConfig.java文件中。

好了，这个BuildConfigTask到这里就分析完成了。

我们来看下一个方法

createApkProcessResTask

// we have to clean the source folder output in case the package name changed.
File srcOut = getSourceOutputDir();
if (srcOut != null) {
    FileUtils.cleanOutputDir(srcOut);
}

@Nullable
// 对于application来说，这个文件是`build/intermediates/res/resources-${buildType}.ap_
// 对于library来说，为null
// 这个是aapt执行完成后输出的压缩文件，里面包含了所有资源文件，和最终的`resources.arsc`
File resOutBaseNameFile = getPackageOutputFile();

File manifestFileToPackage = getManifestFile();

AndroidBuilder builder = getBuilder();
MergingLog mergingLog = new MergingLog(getMergeBlameLogFolder());
ProcessOutputHandler processOutputHandler = new ParsingProcessOutputHandler(
        new ToolOutputParser(new AaptOutputParser(), getILogger()), // 处理执行完的log
        new MergingLogRewriter(mergingLog, builder.getErrorReporter()));
        // merge后的log位于
        // build/intermediates/blame/res/${buildConfig}/

// 生成对应的Aapt对象
Aapt aapt = AaptGradleFactory.make(
        getBuilder(),
        processOutputHandler,
        true,
        true,
        variantScope.getGlobalScope().getProject(),
        variantScope.getVariantConfiguration().getType(),
        FileUtils.mkdirs(new File(getIncrementalFolder(), "aapt-temp")),
        aaptOptions.getCruncherProcesses());
// 给Aapt设置参数
AaptPackageConfig.Builder config = new AaptPackageConfig.Builder()
        .setManifestFile(manifestFileToPackage)
        .setOptions(getAaptOptions())
        .setResourceDir(getResDir())
        .setLibraries(getLibraries())
        .setCustomPackageForR(getPackageForR())
        .setSymbolOutputDir(getTextSymbolOutputDir())
        .setSourceOutputDir(srcOut)
        .setResourceOutputApk(resOutBaseNameFile)
        .setProguardOutputFile(getProguardOutputFile())
        .setMainDexListProguardOutputFile(getMainDexListProguardOutputFile())
        .setVariantType(getType())
        .setDebuggable(getDebuggable())
        .setPseudoLocalize(getPseudoLocalesEnabled())
        .setResourceConfigs(getResourceConfigs())
        .setSplits(getSplits())
        .setPreferredDensity(getPreferredDensity());

builder.processResources(aapt, config, getEnforceUniquePackageName());

if (resOutBaseNameFile != null && LOG.isInfoEnabled()) {
    LOG.info("Aapt output file {}", resOutBaseNameFile.getAbsolutePath());
}

大概看一下，这里其实就是执行 aapt 的过程。

大家应该没有手动执行过 aapt 的命令，那么跟着我一起看一下 aapt 命令是如何执行的。

这里和前面提到的一样，只分析 Aapt1，至于 Aapt2，在这个版本还未成熟，还不能使用。

那么，我们来看builder.processResources(aapt, config, getEnforceUniquePackageName());这个方法:

AaptPackageConfig aaptConfig = aaptConfigBuilder.build();
try {
    aapt.link(aaptConfig).get();
} catch (Exception e) {
    throw new ProcessException("Failed to execute aapt", e);
}

这个方法我没有贴完，先看aapt.link(aaptConfig)方法，然后再继续往下看

AbstractAapt link

public ListenableFuture<Void> link(@NonNull AaptPackageConfig config)
        throws AaptException {
    validatePackageConfig(config); // 做一些校验
    return makeValidatedPackage(config);
}

这个方法很简单，就两个方法，validatePackageConfig(config);这个方法就是做一些校验，这里就不关心了。

makeValidatedPackage(config);其实就是执行 aapt 命令。

那么如何执行命令呢，就是由其中的ProcessInfoBuilder builder = makePackageProcessBuilder(config);方法创建的，这里其实就是构成了执行 aapt 的命令，这个命令是:

aapt package -v -f --no-crunch -i ${android.jarPath} -M ${ManifestPath} -S ${resourcesDir} -m -J ${sourceOutputDir} -F ${resourceOutputApkPath} -G ${proguardOutputPath} -D ${mainDexClassListFilePath} --debug-mode -0 apk --output-text-symbols ${symbolOutputDirPath}

如果是 Android Library,则会添加--non-constant-id选项，看到这个选项应该能了解为何 Library 的 R 文件不是public static final了。

如果 buildTools >= 23，则会添加--no-version-vectors。

这个时候，apk 的压缩等级为 0。

我们关注一下 aapt 命令中的各个路径:

android.jarPath = ${sdk}/platforms/android-${compileSdk}/android.jar
ManifestPath:
- library 中 manifestFile 路径为:build/intermediates/manifests/aapt/${buildConfig}/AndroidManifest.xml
- app 中 manifestFile 路径为: build/intermediates/manifests/full/${buildConfig}/AndroidManifest.xml
resourcesDir = build/intermediates/res/merged/${buildConfig}/
sourceOutputDir = build/generated/source/r/${buildTypes}/${packageName}
resourceOutputApkPath
- 对于 application 来说，这个文件是`build/intermediates/res/resources-${buildType}.ap_
- 对于 library 来说，为 null
proguardOutputPath = build/intermediates/proguard-rules/${buildType}/aapt_rules.txt
mainDexClassListFilePath = build/intermediates/multi-dex/${buildTypes}/manifest_keep.txt
symbolOutputDirPath = build/intermediates/symbols/${buildTypes}

这里有两个文件夹的生成是有条件的，首先当然是 proguardOutputPath，只有设置了minifyEnabled true，才会生成。

第二，是 mainDexClassListFilePath, 只有minSdk < 21 && buildTools > 24.0.0才会生成。

这样，aapt 这个命令操作了哪些参数就很明显了，至于 aapt 对这些参数是如何处理的，这就不是我这篇博客的内容了，想了解这方面的内容，请到老罗的博客继续了解。

好了，aapt.link方法分析完了，我们继续看builder.processResources(aapt, config, getEnforceUniquePackageName());这个方法剩下的内容，

剩下的代码结果就是build/generated/source/r/${buildTypes}/${packageName}目录下的各个R.java文件，根据最终结果反推这些代码的含义还是很容易的，所以这里就不仔细分析了。

这样，ProcessResTask 就分析完毕了。

我们来看下一个方法

createProcessJavaResTasks

public void createProcessJavaResTasks(
        @NonNull TaskFactory tasks,
        @NonNull VariantScope variantScope) {
    TransformManager transformManager = variantScope.getTransformManager();

    // now copy the source folders java resources into the temporary location, mainly to
    // maintain the PluginDsl COPY semantics.
    AndroidTask<Sync> processJavaResourcesTask =
            androidTasks.create(tasks, new ProcessJavaResConfigAction(variantScope));
    variantScope.setProcessJavaResourcesTask(processJavaResourcesTask);

    // create the stream generated from this task
    variantScope.getTransformManager().addStream(OriginalStream.builder()
            .addContentType(DefaultContentType.RESOURCES)
            .addScope(Scope.PROJECT)
            .setFolder(variantScope.getSourceFoldersJavaResDestinationDir())
            .setDependency(processJavaResourcesTask.getName())
            .build());

    // compute the scopes that need to be merged.
    Set<Scope> mergeScopes = getResMergingScopes(variantScope);

    // Create the merge transform
    MergeJavaResourcesTransform mergeTransform = new MergeJavaResourcesTransform(
            variantScope.getGlobalScope().getExtension().getPackagingOptions(),
            mergeScopes, DefaultContentType.RESOURCES, "mergeJavaRes");

    variantScope.setMergeJavaResourcesTask(
            transformManager.addTransform(tasks, variantScope, mergeTransform));
}

这个方法的作用就像名字说的，处理 Java 的资源，通常我们不会遇到 Java 的资源。

但是有几种情况会出现 Java 资源：

比如，使用 RxJava 的时候，使用 okhttp 的时候，这些库都带着 Java 的资源；还有 Java Doc， LICENSE 之类的资源。

这里的资源根据你在 packageOptions{}中设置的选项，最后 merge 成一个 jar 包或者一个文件夹，文件夹的情况我没见到过，这里就不分析了。

Jar 包的路径为: build/intermediates/transforms/mergeJavaRes/${buildType}/jars/${TypeValue}/${ScopesValue}/main.jar

至于 TypeValue 和 ScopesValue，这其实是QualifiedContent内部的DefaultContentType和Scope两个枚举类的 value 值。

这里就是Transform Api的一些用法，看这个代码可以学习Transform Api，对于写Gradle plugin很有用。

好了，这里的处理过程不是重点，我们了解生成什么就可以了，所以，ProcessJavaResTasks 到这里就结束了。

文章目录

createBuildConfigTask

createApkProcessResTask

AbstractAapt link

createProcessJavaResTasks