Android之使用Kotlin构建Gradle

jiezi

5 年前

Android Studio	Gradle
3.4.2	5.1.1

首先 kotlin-dsl 不是什么新鲜的东西了，Gradle5.0 发布的时候就有了
Gradle Kotlin DSL 目前的版本是 1.0.2

现在是否可以抛弃 groovy 拥抱 kotlin 了呢，~~ 迁移还是有点小麻烦的！

目前在 Android Studio 中创建项目时，默认情况下使用 Groovy 创建 Gradle 脚本，那如何向 kotlin-dsl 迁移呢？

一般情况下，Groovy 中使用单引号或者双引号来表达字符串。但是 Kotlin 必须需要双引号。

对 Gradle 脚本 (以 app 目录下的 build.gralde 为例) 中的所有单引号执行查找和替换（cmd + R），并将其全部更改为双引号。
然后挨个开始转为 kotlin-dsl 中的语法

apply plugin: "com.android.application"

apply plugin: "kotlin-android"

apply plugin: "kotlin-android-extensions"

转换之后:(先不用管大量报错)

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

转换前：

android {
    compileSdkVersion 29
    buildToolsVersion "29.0.1"
    defaultConfig {
        applicationId "com.crucio.test"
        minSdkVersion 21
        targetSdkVersion 29
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro"
        }
    }
}

改为

android {compileSdkVersion (29)
    buildToolsVersion ("29.0.1")
    defaultConfig {
        applicationId = "com.crucio.test"
        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 {
    val kotlin_version = "1.3.41"
    implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.jar"))))
    implementation ("org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version")
    implementation ("androidx.appcompat:appcompat:1.0.2")
    implementation ("androidx.core:core-ktx:1.0.2")
    implementation ("androidx.constraintlayout:constraintlayout:1.1.3")
    testImplementation ("junit:junit:4.12")
    androidTestImplementation ("androidx.test:runner:1.2.0")
    androidTestImplementation ("androidx.test.espresso:espresso-core:3.2.0")
}

这时候我们修改 build.gradle 文件名称，改为 build.gradle.kts
如果语法没有错误会出现如下图所示：

提示：有新的脚本依赖项可用这时候点击 Enable auto-reload

这时候发现迁移成功了。但是 kotlin 能不能实现类似于 groovy ext 依赖呢？buildSrc登场~

自动补全 + 单击跳转来了, 无需在文件之间手动来回切换~
先看下官方对 buildSrc 介绍

在项目根目录下新建一个名为 buildSrc 的文件夹(与项目里的 app 文件夹同级)。
在 buildSrc 文件夹里创建名为 build.gradle.kts 的文件


plugins{`kotlin-dsl`}

repositories {
     // 必不可少
    jcenter()}

在 buildSrc 文件夹里创建 src/main/kotlin 文件夹，如下图所示。并在该文件夹下创建 kt 文件。

写完相关依赖代码后我们再去 build.gradle.kts 文件中进行替换

看见没? 已经可以自动提示补全了。

如果嫌弃手动 buildSrc 有点麻烦，那插件大法也是有的。

举例一个 buildSrcVersions 自动生成 buildSrc 目录不过插件会生成一个空的 settings.gradle.kts 文件，可以考虑删掉。

关于自定义构建类型
groovy 中我们自定义构件类型是这样的

buildTypes {
  release {...}
  debug {...}
}

但是在 kotlin-dsl 中 buildTypes 依赖于 NamedDomainObjectContainer

    /**
     * Encapsulates all build type configurations for this project.
     *
     * <p>For more information about the properties you can configure in this block, see {@link
     * BuildType}.
     */
    public void buildTypes(Action<? super NamedDomainObjectContainer<BuildType>> action) {checkWritability();
        action.execute(buildTypes);
    }

NamedDomainObjectContainer 以及父类 NamedDomainObjectCollection 有几个用于访问这些字符串键的函数
默认都会有 release 与 debug 我们可以用 getByName, 因为构建容器中默认是有映射的

    /**
     * Locates an object by name, failing if there is no such object. The given configure action is executed against
     * the object before it is returned from this method.
     *
     * @param name The object name
     * @param configureAction The action to use to configure the object.
     * @return The object with the given name, after the configure action has been applied to it. Never returns null.
     * @throws UnknownDomainObjectException when there is no such object in this collection.
     * @since 3.1
     */
    T getByName(String name, Action<? super T> configureAction) throws UnknownDomainObjectException;

如果想要自定义构件类型，getByName 会抛异常，我们可以用 maybeCreate

/**
     * Looks for an item with the given name, creating and adding it to this container if it does not exist.
     *
     * @param name The name to find or assign to the created object
     * @return The found or created object. Never null.
     */
    T maybeCreate(String name);

先简单说这么多,

附上根目录的 build.gradle.kts


buildscript {
    repositories {google()
        jcenter()}
    dependencies {classpath(Libs.com_android_tools_build_gradle)
        classpath(Libs.kotlin_gradle_plugin)
    }
}

allprojects {
    repositories {google()
        jcenter()}
}

tasks {val clean by registering(Delete::class) {delete(buildDir)
    }
}

Android之使用Kotlin构建Gradle

语法替换

buildSrc

buildSrc 插件

补充

结尾