Manipulation tasks(操作task)

优质
小牛编辑
114浏览
2023-12-01

基础Java项目有一组有限的task用于互相处理生成一个输出。 classes是一个编译Java源代码的task。可以在build.gradle文件中通过脚本很容易使用classes。这是project.tasks.classes的缩写。

在Android项目中,相比之下这就有点复杂。因为Android项目中会有大量相同的task,并且它们的名字基于Build TypesProduct Flavor生成。

为了解决这个问题,android对象有两个属性:

  • applicationVariants(只适用于app plugin)
  • libraryVariants(只适用于library plugin)
  • testVariants(两个plugin都适用)

这三个都会分别返回一个ApplicationVariant、LibraryVariant和TestVariant对象的DomainObjectCollection

注意使用这三个collection中的其中一个都会触发生成所有对应的task。这意味着使用collection之后不需要更改配置。

DomainObjectCollection可以直接访问所有对象,或者通过过滤器进行筛选。

android.applicationVariants.each { variant ->
    ....
}

这三个variant类都共享下面的属性:

属性名属性类型说明
nameStringVariant的名字,必须是唯一的。
descriptionStringVariant的描述说明。
dirNameStringVariant的子文件夹名,必须也是唯一的。可能也会有不止一个子文件夹,例如“debug/flavor1”
baseNameStringVariant输出的基础名字,必须唯一。
outputFileFileVariant的输出,这是一个可读可写的属性。
processManifestProcessManifest处理Manifest的task。
aidlCompileAidlCompile编译AIDL文件的task。
renderscriptCompileRenderscriptCompile编译Renderscript文件的task。
mergeResourcesMergeResources混合资源文件的task。
mergeAssetsMergeAssets混合asset的task。
processResourcesProcessAndroidResources处理并编译资源文件的task。
generateBuildConfigGenerateBuildConfig生成BuildConfig类的task。
javaCompileJavaCompile编译Java源代码的task。
processJavaResourcesCopy处理Java资源的task。
assembleDefaultTaskVariant的标志性assemble task。

ApplicationVariant类还有以下附加属性:

属性名属性类型说明
buildTypeBuildTypeVariant的BuildType。
productFlavorsListVariant的ProductFlavor。一般不为空但也允许空值。
mergedFlavorProductFlavorandroid.defaultConfig和variant.productFlavors的合并。
signingConfigSigningConfigVariant使用的SigningConfig对象。
isSigningReadyboolean如果是true则表明这个Variant已经具备了所有需要签名的信息。
testVariantBuildVariant将会测试这个Variant的TestVariant。
dexDex将代码打包成dex的task。如果这个Variant是个库,这个值可以为空。
packageApplicationPackageApplication打包最终APK的task。如果这个Variant是个库,这个值可以为空。
zipAlignZipAlignzip压缩APK的task。如果这个Variant是个库或者APK不能被签名,这个值可以为空。
installDefaultTask负责安装的task,不能为空。
uninstallDefaultTask负责卸载的task。

LibraryVariant类还有以下附加属性:

属性名属性类型说明
buildTypeBuildTypeVariant的BuildType.
mergedFlavorProductFlavorThe defaultConfig values
testVariantBuildVariant用于测试这个Variant。
packageLibraryZip用于打包库项目的AAR文件。如果是个库项目,这个值不能为空。

TestVariant类还有以下属性:

属性名属性类型说明
buildTypeBuildTypeVariant的Build Type。
productFlavorsListVariant的ProductFlavor。一般不为空但也允许空值。
mergedFlavorProductFlavorandroid.defaultConfig和variant.productFlavors的合并。
signingConfigSigningConfigVariant使用的SigningConfig对象。
isSigningReadyboolean如果是true则表明这个Variant已经具备了所有需要签名的信息。
testedVariantBaseVariantTestVariant测试的BaseVariant
dexDex将代码打包成dex的task。如果这个Variant是个库,这个值可以为空。
packageApplicationPackageApplication打包最终APK的task。如果这个Variant是个库,这个值可以为空。
zipAlignZipAlignzip压缩APK的task。如果这个Variant是个库或者APK不能被签名,这个值可以为空。
installDefaultTask负责安装的task,不能为空。
uninstallDefaultTask负责卸载的task。
connectedAndroidTestDefaultTask在连接设备上行执行Android测试的task。
providerAndroidTestDefaultTask使用扩展API执行Android测试的task。

Android task特有类型的API:

  • ProcessManifest
    • File manifestOutputFile
  • AidlCompile
    • File sourceOutputDir
  • RenderscriptCompile
    • File sourceOutputDir
    • File resOutputDir
  • MergeResources
    • File outputDir
  • MergeAssets
    • File outputDir
  • ProcessAndroidResources
    • File manifestFile
    • File resDir
    • File assetsDir
    • File sourceOutputDir
    • File textSymbolOutputDir
    • File packageOutputFile
    • File proguardOutputFile
  • GenerateBuildConfig
    • File sourceOutputDir
  • Dex
    • File outputFolder
  • PackageApplication
    • File resourceFile
    • File dexFile
    • File javaResourceDir
    • File jniDir
    • File outputFile
      • 直接在Variant对象中使用“outputFile”可以改变最终的输出文件夹。
  • ZipAlign
    • File inputFile
    • File outputFile
      • 直接在Variant对象中使用“outputFile”可以改变最终的输出文件夹。

每个task类型的API由于Gradle的工作方式和Android plugin的配置方式而受到限制。 首先,Gradle意味着拥有的task只能配置输入输出的路径和一些可能使用的选项标识。因此,task只能定义一些输入或者输出。

其次,这里面大多数task的输入都不是单一的,一般都混合了sourceSetBuild TypeProduct Flavor中的值。为了保持构建文件的简单和可读性,目标是要让开发者通过DSL语言修改这些对象来配饰构建的过程,而不是深入修改输入和task的选项。

另外需要注意,除了ZipAlign这个task类型,其它所有类型都要求设置私有数据来让它们运行。这意味着不可能自动创建这些类型的新task实例。

这些API也可能会被更改。一般来说,目前的API是围绕着给定task的输入和输出入口来添加额外的处理(如果需要的时候)。欢迎反馈意见,特别是那些没有预见过的需求。

对于Gradle的task(DefaultTask,JavaCompile,Copy,Zip),请参考Gradle文档。