【Android Gradle 插件】Gradle 扩展属性 ④ ( 扩展属性访问方式 | 直接访问扩展属性 | 通过 ext 对象访问 | 在 gradle.properties 中定义扩展属性 )

文章目录

• ​​一、扩展属性访问方式​​

• ​​直接访问扩展属性​​
• ​​通过 ext 对象访问扩展属性​​
• ​​注意 ext 对象的从属关系​​

• ​​二、在 gradle.properties 中定义扩展属性​​

Android Plugin DSL Reference 参考文档 :

• Android Studio 构建配置官方文档 : ​​https://developer.android.google.cn/studio/build​​
• 添加构建依赖项 参考文档 : ​​https://developer.android.google.cn/studio/build/dependencies​​
• Android Gradle 插件配置与 Gradle 配置关联 : ​​【Android Gradle 插件】Gradle 依赖管理 ① ( org.gradle.api.Project 配置 | Android Gradle 插件配置与 Gradle 配置关联 ) ★​​
• Android Gradle 插件文档主页 : ​​https://google.github.io/android-gradle-dsl/2.3/​​
• BaseExtension 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.BaseExtension.html​​
• AppExtension ( build.gradle#android 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.AppExtension.html​​
• build.gradle#android 模块配置文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.AppExtension.html​​
• ProductFlavor ( build.gradle#android#defaultConfig 配置 ) 文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.ProductFlavor.html​​
• ProductFlavor#externalNativeBuild 配置 ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) : ​​com.android.build.gradle.internal.dsl.ProductFlavor:externalNativeBuild​​
• ExternalNativeBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.ExternalNativeBuildOptions.html​​
• NdkBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild#ndkBuild 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.NdkBuildOptions.html​​
• CmakeOptions ( build.gradle#android#defaultConfig#externalNativeBuild#cmake 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.CmakeOptions.html​​
• JackOptions ( build.gradle#android#defaultConfig#jackOptions 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.JackOptions.html​​
• AnnotationProcessorOptions ( 注解处理器配置 ) ( build.gradle#android#defaultConfig#javaCompileOptions配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AnnotationProcessorOptions.html​​
• NdkOptions ( build.gradle#android#defaultConfig#ndk 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.NdkOptions.html​​
• NDK 参考文档 : ​​Add C and C++ Code to Your Project.​​
• VectorDrawablesOptions ( build.gradle#android#defaultConfig#vectorDrawables 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.VectorDrawablesOptions.html​​
• BuildType ( build.gradle#android#buildTypes 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.BuildType.html​​
• SigningConfig ( build.gradle#android#signingConfigs 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.SigningConfig.html​​
• AaptOptions ( build.gradle#android#aaptOptions 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AaptOptions.html​​
• AndroidSourceSets ( build.gradle#android#sourceSets 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceSet.html​​
• AndroidSourceDirectorySet ( build.gradle#android#sourceSets#aidl/assets/java/jni/jniLibs 配置 ) 文档位置 :​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceDirectorySet.html​​
• AndroidSourceFile ( build.gradle#android#sourceSets#manifest 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceFile.html​​
• DataBindingOptions ( build.gradle#android#dataBinding ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DataBindingOptions.html​​
• DexOptions ( build.gradle#android#dexOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DexOptions.html​​
• LintOptions ( build.gradle#android#lintOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LintOptions.html​​
• PackagingOptions ( build.gradle#android#packagingOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.PackagingOptions.html​​
• Splits ( build.gradle#android#splits ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.Splits.html​​
• AbiSplitOptions ( build.gradle#android#splits#abi ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AbiSplitOptions.html​​
• LanguageSplitOptions ( build.gradle#android#splits#language ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LanguageSplitOptions.html​​
• DensitySplitOptions ( build.gradle#android#splits#density ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DensitySplitOptions.html​​
• TestOptions ( build.gradle#android#testOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.TestOptions.html​​
• Android 测试相关文档 : ​​https://developer.android.google.cn/training/testing​​
• UnitTestOptions ( build.gradle#android#testOptions#unitTests ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.TestOptions.UnitTestOptions.html​​
• org.gradle.api.tasks.testing.Test 单元测试配置类 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/testing/Test.html​​
• LibraryExtension ( Library 依赖库的 build.gradle#android 配置 ) 文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.LibraryExtension.html​​
• org.gradle.api.Project 配置 ( build.gradle 根配置 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html​​
• org.gradle.api.artifacts.dsl.DependencyHandler 配置 ( build.gradle#dependencies#implementation 配置 ) : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/artifacts/dsl/DependencyHandler.html​​
• 添加构建依赖项 参考文档 : ​​https://developer.android.google.cn/studio/build/dependencies​​

一、扩展属性访问方式

在 build.gradle 构建脚本中定义扩展属性 ,

// 为 Project 对象定义扩展属性
ext.hello = 'Hello World!'

或者

// 为 Project 对象定义扩展属性
ext {
    hello = 'Hello World!'
}

上述两种 扩展属性

在自定义任务中 , 访问上述 扩展属性 , 有如下方式 ;

直接访问扩展属性

可以 直接访问该扩展属性 :

// 为 Project 对象定义扩展属性
ext.hello = 'Hello World!'

// 自定义任务 , 输出扩展属性值
task sayHello {
    // 直接调用 hello
    println hello
}

通过 ext 对象访问扩展属性

也可以 通过 project.ext.hello 访问该扩展属性

// 为 Project 对象定义扩展属性
ext.hello = 'Hello World!'

// 自定义任务 , 输出扩展属性值
task sayHello {
    // 通过 hello.ext 调用扩展属性
    println project.ext.hello
}

注意 ext 对象的从属关系

特别注意 , 在 task 任务中 , 不能使用 ext.hello 的形式访问 扩展属性

这是因为 task 任务本身也是一个对象 , 在 task 对象中调用 ext.hello 相当于调用 task 中的扩展属性 ;

// 为 Project 对象定义扩展属性
ext.hello = 'Hello World!'

// 自定义任务 , 输出扩展属性值
task sayHello {
    // 这种用法会报错 , 因为 task 任务本身也是一个对象
    // 下面的用法是调用 task 对象中的扩展属性
    //println ext.hello
}

二、在 gradle.properties 中定义扩展属性

扩展属性 也可以定义在 gradle.properties 配置文件中 , 所有的 build.gradle 构建脚本中 , 都可以获取到该扩展属性值 ;

在 build.gradle 中的自定义任务中 , 可以直接访问定义在 gradle.properties 配置文件中的扩展属性 ;

// 自定义任务 , 输出扩展属性值
task sayHello {
    // 直接调用 hello
    println hello

    // 调用任务自身的扩展属性
    println hello2
}