gradle迁移到gradle.kts(复制可用)

最新推荐文章于 2025-10-10 04:02:39 发布

原创最新推荐文章于 2025-10-10 04:02:39 发布 · 6.1k 阅读

15 ·

CC 4.0 BY-SA版权

文章标签：

#.kts #gradle.kts #android #kotlin #task

Android 同时被 2 个专栏收录

41 篇文章

订阅专栏

Gradle

4 篇文章

订阅专栏

本文介绍了如何将Android Studio的构建脚本从gradle迁移到带有提示功能的gradle.kts。涉及文件包括setting.gradle.kts、build.gradle.kts和Module的build.gradle.kts。主要变更包括方法调用方式、字符串引用及任务定义等，例如include变为include()，task定义改为task(“名称”, 类型::class)。升级过程简单，但能提升开发效率。

为什么要升级到gradle.kts? 很简单，就是因为gradle.kts带提示功能。这里将针对AndroidStudio的默认构建脚本进行升级。

环境

Android Studio: Android Studio Arctic Fox | 2020.3.1 Patch 2
gradle: 7.0.2
gradle-plugin: 7.0.2

迁移

整个工程一共有3个gradle文件，setting.gradle、Project的build.gradle和Moudle的build.gradle，升级哪个文件就需要在文件名后添加kts, 如：setting.gradle.kts、build.gradle.kts。下面将依次对这几个文件的文件内容进行修改。

setting.gradle

原文件：

pluginManagement {
    repositories {
        gradlePluginPortal()
        google()
        mavenCentral()
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
    }
}
rootProject.name = "Test"
include ':app'

修改后的文件：

pluginManagement {
    repositories {
        gradlePluginPortal()
        google()
        mavenCentral()
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
    }
}
rootProject.name = "Test"
include ("app")

总结：基本无变化，只是将最后 include ':app’变成了include (“app”)，其中include是个方法名，"app"是参数，因此这里可以总结出两个知识点:

1 .字符串使用必须使用双引号
2. 方法的调用由原来的方法名参数 变成了 方法名(参数)

Project的build.gradle

原文件：

plugins {
     id 'com.android.application' version '7.0.2' apply false
     id 'com.android.library' version '7.0.2' apply false
     id 'org.jetbrains.kotlin.android' version '1.6.20' apply false
 }

 task clean (type: Delete) {
     delete rootProject.buildDir
 }

修改后的文件：

plugins {
    id("com.android.application") version "7.0.2" apply false
    id("com.android.library") version "7.0.2" apply false
    id("org.jetbrains.kotlin.android") version "1.6.20" apply false
}

task("clean", Delete::class) {
    delete(rootProject.buildDir)
}

总结：

buildscript ->dependencies ->classpath 的赋值使用添加了"()"，由此可见kts中字符串赋值需要将 'xxx’或"xxx"更改为(“xxx”)
task定义更改，由 task 名称(type 类型)更改为task(“名称”，类型::class)

Module的build.gradle

原文件：

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
}

android {
    compileSdk 32

    defaultConfig {
        applicationId "com.secoo.trytry"
        minSdk 17
        targetSdk 32
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "android.support.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 'com.android.support:appcompat-v7:28.0.0'
    implementation 'com.android.support.constraint:constraint-layout:2.0.4'
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

修改后的文件：

plugins {
    id("com.android.application")
    id("org.jetbrains.kotlin.android")
}

android {
    compileSdk = 32

    defaultConfig {
        applicationId = "com.secoo.trytry"
        minSdk = 17
        targetSdk = 32
        versionCode = 1
        versionName = "1.0"

        testInstrumentationRunner = "android.support.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("com.android.support:appcompat-v7:28.0.0")
    implementation("com.android.support.constraint:constraint-layout:2.0.4")
    testImplementation("junit:junit:4.13.2")
    androidTestImplementation("com.android.support.test:runner:1.0.2")
    androidTestImplementation("com.android.support.test.espresso:espresso-core:3.0.2")
}