秒懂Gadle之一步一步教你将Android Gradle脚本从Groovy改成Kotlin

迈不过友情╰ 2023-02-18 03:04 26阅读 0赞

> 【版权申明】非商业目的注明出处可自由转载  
> 博文地址：https://blog.csdn.net/ShuSheng0007/article/details/106763989  
> 出自：shusheng007

系列文章：  
[秒懂Gradle之从完全懵逼到是懂非懂][Gradle]

### 文章目录 ###

*  概述
 *  为什么要用Kotlin DSL写gradle脚本
 *  从Groovy到Kotlin
 *   *  第一步: 修改groovy语法到严格格式
     *  第二步：修改文件名并转换
 *  使用buildSrc改进维护性
 *  总结

# 概述 #

通过[秒懂Gradle之从完全懵逼到是懂非懂][Gradle] 熟悉了gradle，达到了是懂非懂的境地，今天让我们实战演练一下，此演练具有实际意义，如果你愿意完全可以将其用在实际项目中。

[Gradle][Gradle 1]从5.0就已经支持Kotlin DSL1.0了，说明Gadle从5.0开始已经准备好在生产上使用了，何况现在已经发展到6.5了，时机已经很成熟。

Android Studio 4.0 对应的gradle 插件为4.0，对应的Gradle为6.1.1了，所以是时候尝试一下使用kotlin DSL写gradle脚本了。

# 为什么要用Kotlin DSL写gradle脚本 #

撇开其他方面，就单从提高程序员生产效率方面就有很多优点：

*  脚本代码自动补全
 *  跳转查看源码
 *  动态显示注释
 *  支持重构（Refactoring）
 *  …

怎么样，要是你经历过groovy那令人蛋疼的体验，kotlin会让你爽的起飞，接下来让我们开始吧。

# 从Groovy到Kotlin #

让我们使用Android Studio 新建一个Android项目，AS默认会为我们生成3个gradle脚本文件。

*  settings.gradle （属于 project）
 *  build.gradle （属于 project）
 *  build.gradle （属于 module）

我们的目的就是转换这3个文件

## 第一步: 修改groovy语法到严格格式 ##

groovy既支持双引号`""`也支持单引号`''`，而kotlin只支持双引号，所以首先将所有的单引号改为双引号。  
例如 `include ':app'` \-> `include ":app"`

groovy方法调用可以不使用`()` 但是kotlin方法调用必须使用`()`,所以将所有方法调用改为`()`方式  
例如

implementation "androidx.appcompat:appcompat:1.0.2"

改为

implementation ("androidx.appcompat:appcompat:1.0.2")

groovy 属性赋值可以不使用`=`,但是kotlin属性赋值需要使用`=`，所以将所有属性赋值添加`=`.  
例如

applicationId "com.ss007.gradlewithkotlin"

改为

applicationId = "com.ss007.gradlewithkotlin"

完成以上几步，准备工作就完成了。

## 第二步：修改文件名并转换 ##

由于gradle支持groovy 与kotlin脚本混编，所以我们没转换完一个文件就同步一下，确保没有错误。

*  转换setting.gradle文件
    
    将文件名加上**kts**后缀为`setting.gradle.kts`
    
    然后将内容修改为如下所示（其实完成第一步后就不用做修改了，和groovy一毛一样，）
    
        include(":app")
        rootProject.name = "GradleWithKotlinDsl"
 *  转换project的build.gradle文件
    
    将文件名加**kts**后缀为`build.gradle.kts`
    
    然后将内容修改为如下所示：
    
        buildscript {
            var kotlinVersion: String by extra
            kotlinVersion="1.3.72"
            repositories {
                google()
                jcenter()
            }
            dependencies {
                classpath ("com.android.tools.build:gradle:4.0.0")
                classpath ("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion")
        
                // NOTE: Do not place your application dependencies here; they belong
                // in the individual module build.gradle files
            }
        }
        
        allprojects {
            repositories {
                google()
                jcenter()
            }
        }
        
        tasks.register<Delete>("clean") {
            delete(rootProject.buildDir)
        }

这个文件转换有两个地方需要注意：

第一：`buildscript{}` 里的`ext.kotlin_version'`改为 `var kotlinVersion: String by extra`  
关于`extension object` 这块，kotlin表现的不如groovy优秀，比较啰嗦。

第二：task 的申明方式变了

*  转换module的build.gradle文件

这个是我们的重点要转换的了，也最为复杂。首先将文件名加**kts**后缀为`build.gradle.kts`。

然后修改内容如下：

plugins {
        id("com.android.application")
        kotlin("android")
        kotlin("android.extensions")
    }
    
    android {
        compileSdkVersion (29)
        buildToolsVersion ("30.0.0")
    
        defaultConfig {
            applicationId = "top.ss007.gradlewithkotlindsl"
            minSdkVersion (21)
            targetSdkVersion (29)
            versionCode= 1
            versionName= "1.0"
    
            testInstrumentationRunner="androidx.test.runner.AndroidJUnitRunner"
        }
    
        buildTypes {
            getByName("release") {
                isMinifyEnabled = false
                proguardFiles (getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
            }
        }
    }
    
    dependencies {
        implementation (fileTree(mapOf("dir" to "libs", "include" to listOf("*.jar"))))
        implementation ("org.jetbrains.kotlin:kotlin-stdlib:1.3.72")
        implementation ("androidx.core:core-ktx:1.3.0")
        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")
    }

有3处需要特殊处理

第一：插件的引入方式从`apply plugin` 到声明式

plugins{
    	id(xxx)
      ...
    }

第二：`buildTypes{}` 块里面获取`buildType`的方式有变化。

因为buildTypes块里面的类型为`NamedDomainObjectCollection<BuildType>`，其不存在名为`release`的方法。而是通过`release`这个name可获取到一个BuildType类型的对象。而这个对象里面有一个方法叫`setMinifyEnabled(false)`，写成属性调用方式为`isMinifyEnabled = false`

第三：`dependencies{}` 块里面编译**lib** 文件夹中`jar`文件的内容有变化

dependencies {
        implementation (fileTree(mapOf("dir" to "libs", "include" to listOf("*.jar"))))
     }

我们看一下fileTree那个方法的签名

ConfigurableFileTree fileTree(Map<String, ?> args);

可见其需要一个Map的入参

完成以上几步后同步一下gradle脚本就ok了。

到目前为止一切都工作正常，但是在实际项目中我们经常使用project下的gradle脚本的一个extension object来统一维护版本号，如下所示：

ext{
    	// Android config
        androidBuildToolsVersion = "30.0.0"
        ...
    }

但是在kotlin里面从其他模块下访问不到project下的extra，所以需要使用buildSrc的方式

# 使用buildSrc改进维护性 #

在根目录下创建一个`buildSrc`目录，当构建时gradle会自动包括此目录下的文件，在所有gradle文件中都是可以访问到这里面的类，我们可以将版本号统一维护在这里。

其文件结构如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw_size_16_color_FFFFFF_t_70]

Config 文件内容如下

object Config {
        object Android {
            const val buildToolsVersion = "30.0.0"
            const val minSdkVersion = 21
            const val targetSdkVersion = 29
            const val compileSdkVersion = 29
            const val applicationId = "top.ss007.gradlewithkotlindsl"
            const val versionCode = 1
            const val versionName = "1.0"
        }
    
        object AndroidLib{
            const val appcompatVersion= "1.1.0"
            const val constraintLayoutVersion="1.1.3"
        }
        ...
    }

然后就可以在gradle文件中引用里面的值了，例如：

defaultConfig {
            applicationId = Config.Android.applicationId
            minSdkVersion (Config.Android.minSdkVersion)
            ...
        }
        
    dependencies {
        ...
        implementation ("androidx.appcompat:appcompat:${Config.AndroidLib.appcompatVersion}")
        implementation ("androidx.constraintlayout:constraintlayout:${Config.AndroidLib.constraintLayoutVersion}")
    }

# 总结 #

总体来说，gradle团队已经拥抱Kotlin了，教程也是groovy和kotlin共存的，相信kotlin在gradle的使用中会越来越多的，说不定哪天android studio的模板项目就会使用kotlin作为默认gradle脚本的，毕竟kotlin已经是Android开发的首推语言了。

不知不觉又快晚上12点了，我也该去睡觉了，脑中突然浮现出一种奇妙的想法：多年年以后回看自己的文章是一种什么样的感觉？觉得应该拍点视频了，多年以后回看自己的视频感觉比文章要有意思的多吧。

如果要深入了解，可以参考官网相关部分 [Gradle Kotlin DSL Primer][]

我觉得是到了点赞收藏的时候了，如果你觉得文章还行，建议关注博主。

本文源码：[GradleWithKotlinDsl][]

[Gradle]: https://blog.csdn.net/ShuSheng0007/article/details/106714278
[Gradle 1]: https://gradle.org/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200616232053224.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw==,size_16,color_FFFFFF,t_70
[Gradle Kotlin DSL Primer]: https://docs.gradle.org/current/userguide/kotlin_dsl.html
[GradleWithKotlinDsl]: https://github.com/shusheng007/GradleWithKotlinDsl