使用Kotlin DSL 来编写Gradle脚本，替换Groovy

小咪咪 2023-10-10 12:57 11阅读 0赞

平时我们使用的Gradle文件，使用的语言是Groovy，现在，我们可以使用Kotlin来编写Gradle脚本了，优势如下。

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>Kotlin</th> 
   <th>Groovy</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>自动代码补全</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
  <tr> 
   <td>是否类型安全</td> 
   <td>是</td> 
   <td>不是</td> 
  </tr> 
  <tr> 
   <td>源码导航</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
  <tr> 
   <td>重构</td> 
   <td>自动关联</td> 
   <td>手动修改</td> 
  </tr> 
 </tbody> 
</table>

接下来让我们新建一个项目，然后配置为kotlin脚本吧。

#### 1.将单引号替换为双引号 ####

在新建的项目中，直接用`Android Studio`的替换功能，将gradle文件中的将`'`替换为`"`

#### 2.修改Gradle文件扩展名 ####

app的`build.gradle`修改为`build.gradle.kts`

修改完扩展名后，`Android Studio`就认为这是使用的Kotlin语法的了。  
接着同步代码，这个时候会报错，没关系，我们接着下一步。

#### 3.将groovy语法改为kotlin语法 ####

修改前

plugins {
        
        id("com.android.application")
        id("kotlin-android")
    }
    
    android {
        
        compileSdkVersion 30
    
        defaultConfig {
        
            applicationId "com.heiko.mykotlindlstest"
            minSdkVersion 21
            targetSdkVersion 30
            versionCode 1
            versionName "1.0"
    
            testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
        }
    
        buildTypes {
        
            release {
        
                minifyEnabled 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:$kotlin_version"
        implementation "androidx.core:core-ktx:1.3.1"
        implementation "androidx.appcompat:appcompat:1.2.0"
        implementation "com.google.android.material:material:1.2.1"
        implementation "androidx.constraintlayout:constraintlayout:2.0.1"
        testImplementation "junit:junit:4.+"
        androidTestImplementation "androidx.test.ext:junit:1.1.2"
        androidTestImplementation "androidx.test.espresso:espresso-core:3.3.0"
    }

修改后

plugins {
        
        id("com.android.application")
        id("kotlin-android")
        //kotlin("android")
        //kotlin("kapt")
    }
    
    android {
        
        compileSdkVersion(30)
    
        defaultConfig {
        
            applicationId("com.heiko.mykotlindlstest")
            minSdkVersion(21)
            targetSdkVersion(30)
            versionCode(1)
            versionName("1.0")
    
            testInstrumentationRunner("androidx.test.runner.AndroidJUnitRunner")
        }
    
        buildTypes {
        
            named("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 {
        
        val kotlin_version = "1.5.10"
        implementation("org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version")
        implementation("androidx.core:core-ktx:1.3.1")
        implementation("androidx.appcompat:appcompat:1.2.0")
        implementation("com.google.android.material:material:1.2.1")
        implementation("androidx.constraintlayout:constraintlayout:2.0.1")
        testImplementation("junit:junit:4.+")
        androidTestImplementation("androidx.test.ext:junit:1.1.2")
        androidTestImplementation("androidx.test.espresso:espresso-core:3.3.0")
    }

接着，我们运行项目，可以发现可以正常运行了。

#### 4.修改其他gradle文件 ####

同理，我们也可以修改其他文件。

修改前的根目录的`build.gradle`

// Top-level build file where you can add configuration options common to all sub-projects/modules.
    buildscript {
        
        ext.kotlin_version = "1.5.10"
        repositories {
        
            google()
            mavenCentral()
        }
        dependencies {
        
            classpath "com.android.tools.build:gradle:4.2.1"
            classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
        }
    }
    
    allprojects {
        
        repositories {
        
            google()
            mavenCentral()
            jcenter()
        }
    }
    
    task clean(type: Delete) {
        
        delete rootProject.buildDir
    }

修改后的更目录`build.gradle`，改名为修改为`build.gradle.kts`

// Top-level build file where you can add configuration options common to all sub-projects/modules.
    buildscript {
        
        val kotlin_version = "1.5.10"
        repositories {
        
            google()
            mavenCentral()
        }
        dependencies {
        
            classpath("com.android.tools.build:gradle:4.2.1")
            classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version")
    
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
        }
    }
    
    allprojects {
        
        repositories {
        
            google()
            mavenCentral()
            jcenter()
            //maven(url = "https://jitpack.io")
        }
    }
    
    tasks {
        
        val clean by registering(Delete::class) {
        
            delete(buildDir)
        }
    }

修改前的`settings.gradle`

rootProject.name = "MyKotlinDLSTest"
    include ':app'

修改后的`settings.gradle`，更名为`settings.gradle.kts`

rootProject.name = "MyKotlinDLSTest"
    include(":app")

再次运行，可以发现也正常运行 !

#### 其他 ####

感谢 [Kotlin Jetpack 实战 | 02. Gradle Kotlin DSL][Kotlin Jetpack _ _ 02. Gradle Kotlin DSL]

[Kotlin Jetpack _ _ 02. Gradle Kotlin DSL]: https://zhuanlan.zhihu.com/p/166216956