从 Gradle 角度看,Android 插件是由 Google 的 Android 团队开发的一个第三方插件。
从 Android 的角度看,Android 插件是基于 Gradle 构建的,是和 Android studio 完美搭配的新一代构建系统。
使用它可以很轻松的执行以下操作:
自定义,配置和扩展编译流程。
使用相同的项目和模块为你的应用创建多个具有不同功能的 APK。
在不同源集之间重复使用代码和资源。
利用 Gradle 的灵活性,可以在不修改应用核心源文件的情况下完成以上所有操作。
Android 插件能做的还有很多,更多的可以参阅 配置构建
Android 插件的分类其实是根据 Android 工程的属性分类的。
在 Android 中有很多种工程类型,常见的有
分别对应的插件 ID 是
在创建 Module 时就可以看到很多类型
通过应用以上不同的插件就可以配置不同的 Android 工程,然后配合 Android studio 就可以分别对它们进行编译,测试,发布等操作。
在 Android studio 里创建 Module 的时候选择不同的工程会自动应用对应的插件。
如果不配合 Android studio 应用,可以在配置脚本 build.gradle 里设置对应的插件ID 。
因为 Android 插件是托管在 jcenter 仓库上的,所以必须在 repositories{} 添加 jcenter 仓库。
这样就能找到 Android 插件了,具体为什么这么做,看这里。
然后是把构件依赖添加到 classpath 。
这一步一般是在根项目的配置文件里配置的,这样就不用每一个子项目都配置了。
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.6.3'
}
}
最后就是在子项目里应用插件了。
apply plugin: 'com.android.application'
apply plugin: 'com.android.library'
Android 插件是继承自 Java 插件的,自然把 Java 的任务也继承来了,例如
除了继承 Java 插件的,Android 插件本身也添加了自己的任务,例如
除此之外还有些不太常用的任务:
一般我们常用的任务是 build、assemble、clean、check、lint等,通过这些任务可以对应用进行打包生成 APK,对现有的 Android 工程进行 lint 检查等。
还有一些其他的任务,可以通过命令查看
gradle tasks
在 Android studio 的 Gradle 窗口也可以看到所有的任务
关于 Java 插件的介绍,移步 Java 插件
Android 插件继承自 Java 插件,具备 Java 插件所有的特性,其目录结构也和 Java 差不多。
使用 Android studio 创建一个工程,可以得到以下目录:
我们的重点放在项目的配置脚本文件上,大部分的配置是在这里的。
这是一个标准的多项目的 Gradle 目录。
关于更多 Gradle 介绍,移步 Gradle 系列,在持续更新中。
settings.gradle
//项目名称,默认是目录名字
rootProject.name='AndroidGradleExample'
//导入子项目 app
include ':app'
local.properties
# 配置 SDK 在本机的目录,创建项目时,Android studio 会自动配置,如果需要自己单独设置,可以更改
sdk.dir=/Users/skymxc/Library/Android/sdk
# ndk 在本机的目录 需要时配置
##ndk.dir=/Users/skymxc/Library/Android/sdk/ndk-bundle
gradle.properties
# 使用 AndroidX 更多详细可查看 https://developer.android.com/topic/libraries/support-library/androidx-rn
android.useAndroidX=true
# 自动转换第三方库使用 androidx ;Automatically convert third-party libraries to use AndroidX
android.enableJetifier=true
# 为 JVM 守护进程指定参数;Specifies the JVM arguments used for the daemon process.
# 调整内存设置的参数;The setting is particularly useful for tweaking memory settings.
org.gradle.jvmargs=-Xmx1536m
.gitignore
*.iml
.gradle
.idea
/local.properties
/.idea/caches
/.idea/libraries
/.idea/modules.xml
/.idea/workspace.xml
/.idea/navEditor.xml
/.idea/assetWizardSettings.xml
.DS_Store
/build
/captures
.externalNativeBuild
.cxx
build.gradle 根项目的配置脚本,可以在这里配置所有项目都会用到的共性配置,例如配置所有子项目都会使用的仓库。
// Top-level build file where you can add configuration options common to all sub-projects/modules.
//顶层配置文件,这里添加的配置可选择配置到所有子项目
//配置脚本,主要是配置 Gradle 脚本执行使用的依赖。
buildscript {
//使用的插件所在的仓库,例如 Android 插件就放在了 jcenter 上
repositories {
google()
jcenter()
}
//使用的插件依赖
dependencies {
// Android 构建工具
classpath 'com.android.tools.build:gradle:3.6.3'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
//注意:不要子项目的依赖放在这里,各自项目的依赖应该放在各自项目的 build.gralde 配置脚本里。
//这里的配置会应用到所有项目。
}
}
//会遍历所有子项目,这里相当于给所有项目都配置了仓库了。
allprojects {
//给所有项目配置仓库
repositories {
google()
jcenter()
}
}
// 配置 clean 任务,删除根目录的 build 目录。
task clean(type: Delete) {
delete rootProject.buildDir
}
app/.gitignore
/build
app/build.gradle
//使用 Android 应用插件
apply plugin: 'com.android.application'
// android 是 Android插件提供的扩展类型。 Android 工程的配置都可以在这里配置。
android {
//编译的SDK 版本
compileSdkVersion 29
//构建工具版本
buildToolsVersion "29.0.2"
//默认配置,它是一个 ProductFlavor
defaultConfig {
//应用程序ID,创建时的包名,可以更改。
applicationId "cn.sintoon.androidgradleexample"
//最小支持的SDK 版本
minSdkVersion 19
//目标 SDK 版本
targetSdkVersion 29
//应用版本代码,一般用于控制APP的升级。
versionCode 1
//应用版本名称,用户可以看到。
versionName "1.0"
//配置单元测试使用的 runner
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
//构建类型
buildTypes {
//发布类型
release {
//是否启用混淆
minifyEnabled false
//proguard 规则文件;
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
}
//使用的依赖
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation 'androidx.appcompat:appcompat:1.1.0'
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
testImplementation 'junit:junit:4.12'
androidTestImplementation 'androidx.test.ext:junit:1.1.1'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
}
Android 工程的配置都在 android{} 中。通过它,可以对 Android Gradle 工程进行自定义配置。
defaultConfig{} 里是默认的配置,它是一个 ProductFlavor 。
getDefaultProguardFile 是 Android 扩展的一个方法,它可以获取你的 Android SDK 目录下默认的 proguard 配置文件。 在 android-sdk/tools/proguard/ 目录下,文件名就是传入的参数 proguard-android-optimize.txt 。
我在 github 建了一个仓库,是 Android 插件的配置示例,会持续把所有的配置和注释都记录在这里以供查阅,AndroidGradleExample。
End