概述
家喻户晓,咱们在 Android Studio 是应用 Gradle 来编译的,Gradle 是一种基于 Groovy 语言的构建工具,咱们平时看到的 build.gradle 中的语法结构其实就是 Groovy 提供的 DSL 性能。
DSL 的全称是畛域特定语言(Domain Specific Language),它是编程语言赋予开发者的一种非凡能力,通过它咱们能够编写出一些看似脱离其原始语法结构的代码,从而构建出一种专有的语法结构。
毫无疑问,Kotlin 是反对 DSL 的,而且 Gradle 是反对用 Kotlin 语言来编写 Gradle 的构建脚本的,并且 Gradle 官网 也给出了 Groovy 迁徙 Kotlin 的领导文章。
咱们来新建一个我的项目来从 0 将 Gradle 文件革新成由 Kotlin 编写的。
Gradle 脚本革新
一个基于 Gradle 构建的 Android 我的项目,Gradle 的配置文件个别就只有以下这几种:
- setting.gradle
- app/build.gradle
- project/build.gradle
所以咱们革新无非就是对这几个文件进行革新。
革新 settings.gradle
这个文件的次要性能就是负责咱们我的项目中 Module 的申明,咱们先来看下它原先的代码,如下所示:
include ':app'rootProject.name = "KotlinGradleDSL"
这段代码很简略,就是申明了 app 这个主 Module,同时定义了咱们 project 的名称,咱们能够通过 kotlin 的语法进行改写,在改写之前咱们先将文件的名字批改成 settings.gradle.kts,革新后的代码如下所示:
include("app")rootProject.name = "KotlinGradleDSL"rootProject.buildFileName = "build.gradle.kts"
革新 project/build.gradle
同样咱们须要将 build.gradle 的文件名改成 build.gradle.kts,咱们先来看下它原先的代码,如下所示:
buildscript { ext.kotlin_version = "1.4.31" repositories { google() jcenter() } dependencies { classpath "com.android.tools.build:gradle:4.1.2" classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" }}allprojects { repositories { google() jcenter() }}task clean(type: Delete) { delete rootProject.buildDir}
革新后的代码如下所示:
buildscript { val gradle_version = "4.1.3" val kotlin_version = "1.4.31" repositories { google() jcenter() } dependencies { classpath("com.android.tools.build:gradle:$gradle_version") classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version") }}allprojects { repositories { google() jcenter() }}tasks { val clean by registering(Delete::class) { delete(buildDir) }}
在 Groovy 中,咱们有一个 ext 的扩大,然而在 Kotlin 中是没有的,所以咱们只能本人先申明一个局部变量,而后通过字符串模板引入,还有就是 classpath 引入的全局依赖,咱们是要用大括号括起来,还有一个 clean 的工作,这个也是须要改写的。
接下来,咱们来改写一下内容最多的 app/build.gradle。
革新 app/build.gradle
app/build.gradle 外面的内容很多,咱们来看每个模块应该怎么革新。
插件的引入革新
Groovy 语法的插件引入如下所示:
plugins { id 'com.android.application' id 'kotlin-android' id 'kotlin-android-extensions'}
利用 Kotlin 能够革新成上面这样:
plugins { id("com.android.application") kotlin("android") kotlin("android.extensions")}
SDK 的引入革新
Groovy 语法的 SDK 引入如下所示:
compileSdkVersion 30buildToolsVersion "30.0.3"
利用 Kotlin 能够革新成上面这样:
compileSdkVersion(30)buildToolsVersion("30.0.3")
默认配置革新
Groovy 语法的默认配置如下所示:
defaultConfig { applicationId "com.example.kotlingradledsl" minSdkVersion 23 targetSdkVersion 30 versionCode 1 versionName "1.0" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"}
利用 Kotlin 能够革新成上面这样:
defaultConfig { applicationId = "com.example.kotlingradledsl" minSdkVersion(23) targetSdkVersion(30) versionCode = 1 versionName = "1.0" testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"}
编译类型革新
Groovy 语法的编译类型如下所示:
buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile ('proguard-android-optimize.txt'), 'proguard-rules.pro' }}
利用 Kotlin 能够革新成上面这样:
buildTypes { getByName("release") { isMinifyEnabled = false proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro") }}
指定 JDK 革新
Groovy 语法的指定 JDK 如下所示:
compileOptions { sourceCompatibility JavaVersion . VERSION_1_8 targetCompatibility JavaVersion . VERSION_1_8}kotlinOptions { jvmTarget = '1.8'}
利用 Kotlin 能够革新成上面这样:
compileOptions { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8}kotlinOptions { jvmTarget = "1.8"}
依赖的革新
Groovy 语法的依赖如下所示:
dependencies { implementation "org.jetbrains.kotlin:kotlin-stdlib:1.4.31" implementation 'androidx.core:core-ktx:1.2.0' implementation 'androidx.appcompat:appcompat:1.1.0' implementation 'com.google.android.material:material:1.1.0' implementation 'androidx.constraintlayout:constraintlayout:1.1.3'}
利用 Kotlin 能够革新成上面这样:
dependencies { implementation("org.jetbrains.kotlin:kotlin-stdlib:1.4.31") implementation("androidx.core:core-ktx:1.2.0") implementation("androidx.appcompat:appcompat:1.1.0") implementation("com.google.android.material:material:1.1.0") implementation("androidx.constraintlayout:constraintlayout:1.1.3")}
残缺代码展现
到此为止,咱们曾经将主动生成 app/build.gradle 外面的内容全副革新完了,咱们来看下残缺代码,如下所示:
plugins { id("com.android.application") kotlin("android") kotlin("android.extensions")}android { compileSdkVersion(30) buildToolsVersion("30.0.3") defaultConfig { applicationId = "com.example.kotlingradledsl" minSdkVersion(23) targetSdkVersion(30) versionCode = 1 versionName = "1.0" testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" } buildTypes { getByName("release") { isMinifyEnabled = false proguardFiles( getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro" ) } } compileOptions { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 } kotlinOptions { jvmTarget = "1.8" }}dependencies { implementation("org.jetbrains.kotlin:kotlin-stdlib:1.4.31") implementation("androidx.core:core-ktx:1.2.0") implementation("androidx.appcompat:appcompat:1.1.0") implementation("com.google.android.material:material:1.1.0") implementation("androidx.constraintlayout:constraintlayout:1.1.3")}
向 app/build.gradle 退出更高级的个性
下面的 app/build.gradle 外面的内容都是最根本的,咱们还须要退出一些更高级的个性,比方主动打包、输入 apk 名称批改等,在下面这个 app/build.gradle 的根底上,咱们来开始欠缺。
主动打包
想要实现主动打包,咱们首先要新建一个签名文件,如何实现签名文件这里就不说了,有了签名文件之后,咱们就须要在 app/build.gradle 外面进行配置,咱们先来看一下 Groovy 语法是如何进行配置的,如下所示:
//签名配置signingConfigs { release { // 别名 keyAlias 'zjgsu' //别名明码 keyPassword '123456' //门路 storeFile file('../app/src/main/jks/kotlindsl.jks') //明码 storePassword '123456' }}
而后在编译类型中,release 类型里援用即可,如下所示:
signingConfig signingConfigs.release
利用 Kotlin 能够革新成上面这样:
// 签名类型signingConfigs { register("release") { // 别名 keyAlias = "zjgsu" // 别名明码 keyPassword = "123456" // 门路 storeFile = file("src/main/jks/kotlindsl.jks") // 签名文件明码 storePassword = "123456" }}
而后在编译类型中,release 类型里援用即可,如下所示:
signingConfig = signingConfigs.getByName("release")
配置完签名之后,打包 apk 能够间接用命令打包们也能够间接应用 Android studio 提供的工具打包,如下所示:
间接双击 assemble 就能够打包 apk 了,打包进去的 apk 如下所示:
输入类型配置
app-debug 和 app-release 就是咱们须要的 apk 了,然而这个名字必定不是咱们须要的,所以咱们还须要在 app/build.gradle 中对输入类型进行配置,否则咱们每次打包 apk 都得手动改一次名字,太麻烦了,咱们先来看一下 Groovy 语法是如何进行配置的,如下所示:
// 输入类型配置android.applicationVariants.all { variant -> def buildType = variant.buildType.name def fileName variant.outputs.each { if (buildType == "release") { fileName = "APP_NAMEV-${defaultConfig.versionName}.apk" } else if (buildType == "debug") { fileName = "APP_NAMEV-${defaultConfig.versionName}_${buildType}.apk" } it.outputFileName = fileName }}
利用 Kotlin 能够革新成上面这样:
// 输入类型android.applicationVariants.all { // 编译类型 val buildType = this.buildType.name outputs.all { // 判断是否是输入 apk 类型 if (this is com.android.build.gradle.internal.api.ApkVariantOutputImpl) { this.outputFileName = "KOTLIN_DSL_V${defaultConfig.versionName}_$buildType.apk" } }}
咱们再利用 assemble 来打包 apk ,打包进去的 apk 如下所示:
利用 buildSrc 来对立治理 Gradle 依赖版本
咱们在应用 Groovy 语言构建的时候,往往会抽取出一个 build_config.gradle 来作为全局的变量管制,而在 Kotlin 语言中,想要对立治理 Gradle 的依赖版本,则须要应用 buildSrc,有趣味的能够去看下官网的介绍。
咱们来看看如何应用,首先须要在根目录下创立一个 buildSrc 的文件夹,而后创立一系列目录,如下图:
目录创立好之后,就须要编写 settings.gradle.kts,如下所示:
rootProject.buildFileName = "build.gradle.kts"
settings.gradle.kts 编写实现后,再来编写 build.gradle.kts,代码如下所示:
apply { plugin("kotlin")}buildscript { repositories { gradlePluginPortal() } dependencies { classpath(kotlin("gradle-plugin", "1.4.31")) }}dependencies { implementation(gradleKotlinDsl()) implementation(kotlin("stdlib", "1.4.31"))}repositories { gradlePluginPortal()}
编译胜利之后,咱们就能够编写 KotlinConstants.kt 公共类了,具体代码如下所示:
//全局常量object KotlinConstants { //Gradle 版本 const val gradle_version = "4.1.3" //Kotlin 版本 const val kotlin_version = "1.4.31"}//利用配置object AppConfig { //依赖版本 const val compileSdkVersion = 30 //编译工具版本 const val buildToolsVersion = "30.0.3" //包名 const val applicationId = "com.example.kotlingradledsl" //最小反对SDK const val minSdkVersion = 23 //以后基于SDK const val targetSdkVersion = 30 //版本编码 const val versionCode = 1 //版本名称 const val versionName = "1.0"}//依赖配置object DependenciesConfig { //Kotlin根底库 const val STD_LIB = "org.jetbrains.kotlin:kotlin-stdlib:${KotlinConstants.kotlin_version}"}
有了 KotlinConstants.kt 之后,咱们就能够在 .gradle 文件中应用了,如 app/build.gradle.kts 代码如下所示:
// 援用插件plugins { id("com.android.application") kotlin("android") kotlin("android.extensions")}// Android 属性android { compileSdkVersion(AppConfig.compileSdkVersion) buildToolsVersion(AppConfig.buildToolsVersion) defaultConfig { applicationId = AppConfig.applicationId minSdkVersion(AppConfig.minSdkVersion) targetSdkVersion(AppConfig.targetSdkVersion) versionCode = AppConfig.versionCode versionName = AppConfig.versionName testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" } // 签名类型 signingConfigs { register("release") { // 别名 keyAlias = "zjgsu" // 别名明码 keyPassword = "123456" // 门路 storeFile = file("src/main/jks/kotlindsl.jks") // 签名文件明码 storePassword = "123456" } } // 编译类型 buildTypes { getByName("release") { isMinifyEnabled = false // 主动签名打包 signingConfig = signingConfigs.getByName("release") proguardFiles( getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro" ) } } // 输入类型 android.applicationVariants.all { // 编译类型 val buildType = this.buildType.name outputs.all { // 判断是否是输入 apk 类型 if (this is com.android.build.gradle.internal.api.ApkVariantOutputImpl) { this.outputFileName = "KOTLIN_DSL_V${defaultConfig.versionName}_$buildType.apk" } } } // 指定 JDK compileOptions { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 } kotlinOptions { jvmTarget = "1.8" }}dependencies { implementation(DependenciesConfig.STD_LIB) implementation("androidx.core:core-ktx:1.2.0") implementation("androidx.appcompat:appcompat:1.2.0") implementation("com.google.android.material:material:1.3.0") implementation("androidx.constraintlayout:constraintlayout:2.0.4")}
至此,Gradle Kotlin DSL 咱们曾经讲完了。
源码
源码 已上传至 github,有须要的自取。