《Kotin 极简教程》第12章 使用 Kotlin 集成Gradle 开发

第12章 使用 Kotlin 集成Gradle 开发

由于 Kotlin 具有丰富的功能,如一等函数和扩展方法等,因此它可以保留和改进 Gradle 构建脚本的最佳部分——包括简明的声明式语法以及轻松制作 DSL 的能力。

Gradle 团队与 Kotlin 团队密切合作,为 Gradle 开发了新的基于 Kotlin 脚本的构建配置语言,我们称之为 Gradle Script Kotlin,支持使用 Kotlin 编写构建和配置文件。同时,还支持在 IDE 中实现自动完成和编译检查等功能。有了Gradle Script Kotlin,我们可以使用 Kotlin 来写配置文件,就跟写普通代码一样。

我们在前面的章节中,已经有很多示例项目使用了 Gradle 来构建我们的 Kotlin 工程。本章我们将系统地来介绍一下使用 Kotlin 集成Gradle 开发的相关内容。

12.1 使用 Gradle 构建 Kotlin工程

12.1.1 kotlin-gradle 插件

为了用 Gradle 构建 Kotlin工程,我们需要设置好 kotlin-gradle 插件:

buildscript {
	ext {
		kotlinVersion = '1.1.3-2'
	}
	repositories {
		mavenCentral()
	}
	dependencies {
		classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlinVersion}")
                ...
	}
}

apply plugin: 'kotlin'

并且添加 kotlin-stdlib 依赖:

dependencies {
	compile("org.jetbrains.kotlin:kotlin-stdlib-jre8:${kotlinVersion}")
	compile("org.jetbrains.kotlin:kotlin-reflect:${kotlinVersion}")
}

当然,这些操作在我们新建项目的时候,通常我们只需要选择相应的选项, IntelliJ IDEA 就会直接帮我们完成了基本的配置了。

我们使用 kotlin-gradle-plugin 编译 Kotlin 源代码和模块。使用的 Kotlin 版本通常定义为 kotlinVersion 属性。

针对 JVM,我们需要应用 Kotlin 插件:

apply plugin: "kotlin"

12.1.2 Kotlin 与 Java 混合编程

Kotlin 源代码可以与同一个文件夹或不同文件夹中的 Java 源代码混用。默认约定是使用不同的文件夹:

sourceSets {
    
    
    main.kotlin.srcDirs += 'src/main/kotlin'
    main.java.srcDirs += 'src/main/java'
}

如果使用默认的目录,上面的配置可以省去不写。

如果不使用默认约定,那么应该更新相应的 sourceSets 属性

sourceSets {
    
    
    main.kotlin.srcDirs += 'src/main/myKotlin'
    main.java.srcDirs += 'src/main/myJava'
}

12.1.3 配置 Gradle JavaScript 项目

当针对 JavaScript 时,须应用不同的插件:

apply plugin: "kotlin2js"

除了输出的 JavaScript 文件,该插件默认会创建一个带二进制描述符的额外 JS 文件。

如果是构建其他 Kotlin 模块可以依赖的可重用库,那么该文件是必需的,并且与转换结果一起分发。

二进制描述符文件的生成由 kotlinOptions.metaInfo 选项控制:

compileKotlin2Js {
    
    
	kotlinOptions.metaInfo = true
}

提示:示例工程可以参考
https://github.com/EasyKotlin/chapter2_hello_world_kotlin2js

12.1.4 配置 Gradle Android项目

Android 的 Gradle 模型与普通 Gradle 有点不同,所以如果我们要构建一个用 Kotlin 编写的 Android 项目,我们需要用 kotlin-android 插件取代 kotlin 插件:

buildscript {
    
    
    ext.kotlin_version = '1.1.2-4'
    repositories {
    
    
        jcenter()
    }
    dependencies {
    
    
        classpath 'com.android.tools.build:gradle:2.3.1'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}

通常我们使用 Android Studio,都是生成一个带 app 子项目的工程。多项目配置的实现通常是在一个根项目路径下将所有项目作为子文件夹包含进去。例如我们在项目根路径下面的settings.gradle中如下配置:

include ':app'

每一个子项目都拥有自己的build.gradle文件来声明自己如何构建。

例如,我们在子项目app的构建配置文件 build.gradle 中一个完整的配置如下:

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'

android {
    compileSdkVersion 25
    buildToolsVersion "25.0.2"
    defaultConfig {
        applicationId "com.kotlin.easy.kotlinandroid"
        minSdkVersion 14
        targetSdkVersion 25
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
        exclude group: 'com.android.support', module: 'support-annotations'
    })
    compile 'com.android.support:appcompat-v7:25.3.1'
    compile 'com.android.support.constraint:constraint-layout:1.0.2'
    testCompile 'junit:junit:4.12'
    compile "org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlin_version"
}
repositories {
    mavenCentral()
}

其中,

apply plugin: ‘kotlin-android’ 是 Kotlin Android 插件。
compile “org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlin_version” 是 Kotlin 运行标准库。

另外, Android Studio 默认加载源码的目录是 src/main/java,如果想指定 Kotlin 代码在src/main/kotln目录,可以在 android 下添加以下内容:

android {
    
    
  ……
  sourceSets {
    
    
    main.java.srcDirs += 'src/main/kotlin'
  }
}

提示: 关于 Kotlin Android 的 Gradle 完整配置实例可参考 https://github.com/EasyKotlin/KotlinAndroid 。

12.1.5 配置Kotlin 标准库依赖

除了上面的 kotlin-gradle-plugin 依赖之外,我们还需要添加 Kotlin 标准库的依赖:

repositories {
    
    
    mavenCentral()
}

dependencies {
    
    
    compile "org.jetbrains.kotlin:kotlin-stdlib"
}

如果针对 JavaScript,使用 compile "org.jetbrains.kotlin:kotlin-stdlib-js" 替代之。

如果是针对 JDK 7 或 JDK 8,那么可以使用扩展版本的 Kotlin 标准库,其中包含为新版 JDK 增加的额外的扩展函数。使用以下依赖之一来取代 kotlin-stdlib

compile "org.jetbrains.kotlin:kotlin-stdlib-jre7"
compile "org.jetbrains.kotlin:kotlin-stdlib-jre8"

如果项目中使用 Kotlin 反射,添加反射依赖:

compile "org.jetbrains.kotlin:kotlin-reflect"

如果项目中使用测试框架,我们添加相应的测试库依赖:

testCompile "org.jetbrains.kotlin:kotlin-test"
testCompile "org.jetbrains.kotlin:kotlin-test-junit"

12.1.6 增量编译

Kotlin 支持 Gradle 中可选的增量编译。增量编译跟踪构建之间源文件的改动,因此只有受这些改动影响的文件才会被编译。从 Kotlin 1.1.1 起,默认启用增量编译。

12.1.7 编译器选项

要指定附加的编译选项,可以使用 Kotlin 编译任务compileKotlin的 kotlinOptions 属性。

配置单个任务示例:

compileKotlin {
    
    
    kotlinOptions {
    
    
        suppressWarnings = true
    }
}

12.2 使用 Kotlin 编写构建和配置文件

一个基于 Kotlin 来写 Gradle 构建脚本及插件的方式可能会是什么样的? 它对团队的帮助如何——尤其是大型团队——加快工作速度并编写结构更好、更易于维护的构建脚本?

这些可能性非常诱人。

因为 Kotlin 是一种静态类型语言,在 IDEA 和 Eclipse 中都有深入的支持,所以可以从自动补全到重构,以及其间的一切都能为 Gradle 用户提供适当的 IDE 支持。 而且由于 Kotlin 具有丰富的功能,如一等函数和扩展方法,因此它可以保留和改进 Gradle 构建脚本的最佳部分——包括简明的声明式语法以及轻松制作 DSL 的能力。

Gradle 团队认真地考察了这些可能性,与 Kotlin 团队密切合作,为 Gradle 开发一种新的基于 Kotlin 的构建语言——我们称之为 Gradle Script Kotlin。

下面我们就来简要介绍一下使用 Kotlin 脚本来编写 Gradle 的配置文件。

我们就以上一章中的 chapter11_kotlin_springboot 工程为例。

首先我们在根目录下新建一个settings.gradle 配置文件:

rootProject.name = 'chapter11_kotlin_springboot'
rootProject.buildFileName = 'build.gradle.kts'

指定 gradle 构建文件名是 ‘build.gradle.kts’ 。
然后,我们新建 ‘build.gradle.kts’ , 完整的内容如下:

buildscript {
    val kotlinVersion = "1.1.3-2"
    val springBootVersion = "2.0.0.M2"
    extra["kotlinVersion"] = kotlinVersion

    repositories {
        mavenCentral()
        maven { setUrl("https://repo.spring.io/snapshot") }
        maven { setUrl("https://repo.spring.io/milestone") }
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:$springBootVersion")
        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion")
        classpath("org.jetbrains.kotlin:kotlin-allopen:$kotlinVersion")
    }
}

apply {
    plugin("kotlin")
    plugin("kotlin-spring")
    plugin("eclipse")
    plugin("org.springframework.boot")
    plugin("io.spring.dependency-management")
}

version = "0.0.1-SNAPSHOT"

configure<JavaPluginConvention> {
    setSourceCompatibility(1.8)
    setTargetCompatibility(1.8)
}


repositories {
    mavenCentral()
    maven { setUrl("https://repo.spring.io/snapshot") }
    maven { setUrl("https://repo.spring.io/milestone") }
}

val kotlinVersion = extra["kotlinVersion"] as String

dependencies {
    compile("org.springframework.boot:spring-boot-starter-actuator")
    compile("org.springframework.boot:spring-boot-starter-data-jpa")
    compile("org.springframework.boot:spring-boot-starter-freemarker")
    compile("org.springframework.boot:spring-boot-starter-web")
    compile("org.jetbrains.kotlin:kotlin-stdlib-jre8:${kotlinVersion}")
    compile("org.jetbrains.kotlin:kotlin-reflect:${kotlinVersion}")
    runtime("org.springframework.boot:spring-boot-devtools")
    runtime("mysql:mysql-connector-java")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

提示: 按照上述步骤,新建完文件build.gradle.kts后,IDEA 可能识别不了这些 DSL 函数,这个时候我们重启一下 IDEA 即可(这是一个 bug,后面会修复)。

这里面的 Gradle DSL 的相关函数与类都在 Gradle 软件包的 lib 目录下: lib/gradle-script-kotlin-(版本号).jar 。我们简单用下面的表格说明:

函数(类) 对应的gradle-script-kotlin代码
buildscript open fun buildscript(@Suppress(“unused_parameter”) block: ScriptHandlerScope.() -> Unit) = Unit
repositories fun ScriptHandler.repositories(configuration: RepositoryHandler.() -> Unit) =repositories.configuration()
buildscript.dependencies DependencyHandlerScope(scriptHandler.dependencies)
configure inline fun Project.configure(noinline configuration: T.() -> Unit)
Project.dependencies DependencyHandlerScope(dependencies).configuration()

也就是说,其实这些配置函数背后都是由 Gradle 的 DSL 来实现的。

其实,这些配置语法看起跟 Groovy 的很像。例如:

Groovy :

    repositories {
        mavenCentral()
        maven { url "https://repo.spring.io/snapshot" }
        maven { url "https://repo.spring.io/milestone" }
    }

Kotlin:

repositories {
    mavenCentral()
    maven { setUrl("https://repo.spring.io/snapshot") }
    maven { setUrl("https://repo.spring.io/milestone") }
}

再例如:
Groovy:

sourceCompatibility = 1.8
targetCompatibility = 1.8

Kotlin:

configure<JavaPluginConvention> {
    setSourceCompatibility(1.8)
    setTargetCompatibility(1.8)
}

提示: 本节示例工程源码 https://github.com/EasyKotlin/chapter11_kotlin_springboot/tree/build.gradle.kts

本章小结

本章我们简要介绍了使用 Kotlin 集成 Gradle 开发过程中的一些常用的配置方法。Gradle 是一个非常好用的构建工具,当我们的 Kotlin 工程的配置文件也是 Kotlin 代码的时候,我们的工作又更加单纯了许多,只需要专注 Kotlin 即可。

在下一章中,我们将学习使用 Kotlin 和 Anko 来进行Android开发的相关内容。


Kotlin开发者社区

专注分享 Java、 Kotlin、Spring/Spring Boot、MySQL、redis、neo4j、NoSQL、Android、JavaScript、React、Node、函数式编程、编程思想、"高可用,高性能,高实时"大型分布式系统架构设计主题。

High availability, high performance, high real-time large-scale distributed system architecture design

分布式框架:Zookeeper、分布式中间件框架等
分布式存储:GridFS、FastDFS、TFS、MemCache、redis等
分布式数据库:Cobar、tddl、Amoeba、Mycat
云计算、大数据、AI算法
虚拟化、云原生技术
分布式计算框架:MapReduce、Hadoop、Storm、Flink等
分布式通信机制:Dubbo、RPC调用、共享远程数据、消息队列等
消息队列MQ:Kafka、MetaQ,RocketMQ
怎样打造高可用系统:基于硬件、软件中间件、系统架构等一些典型方案的实现:HAProxy、基于Corosync+Pacemaker的高可用集群套件中间件系统
Mycat架构分布式演进
大数据Join背后的难题:数据、网络、内存和计算能力的矛盾和调和
Java分布式系统中的高性能难题:AIO,NIO,Netty还是自己开发框架?
高性能事件派发机制:线程池模型、Disruptor模型等等。。。

合抱之木,生于毫末;九层之台,起于垒土;千里之行,始于足下。不积跬步,无以至千里;不积小流,无以成江河。

Kotlin 简介

Kotlin是一门非研究性的语言,它是一门非常务实的工业级编程语言,它的使命就是帮助程序员们解决实际工程实践中的问题。使用Kotlin 让 Java程序员们的生活变得更好,Java中的那些空指针错误,浪费时间的冗长的样板代码,啰嗦的语法限制等等,在Kotlin中统统消失。Kotlin 简单务实,语法简洁而强大,安全且表达力强,极富生产力。

Java诞生于1995年,至今已有23年历史。当前最新版本是 Java 9。在 JVM 生态不断发展繁荣的过程中,也诞生了Scala、Groovy、Clojure 等兄弟语言。

Kotlin 也正是 JVM 家族中的优秀一员。Kotlin是一种现代语言(版本1.0于2016年2月发布)。它最初的目的是像Scala那样,优化Java语言的缺陷,提供更加简单实用的编程语言特性,并且解决了性能上的问题,比如编译时间。 JetBrains在这些方面做得非常出色。

Kotlin语言的特性

用 Java 开发多年以后,能够尝试一些新的东西真是太棒了。如果您是 Java 开发人员,使用 Kotlin 将会非常自然流畅。如果你是一个Swift开发者,你将会感到似曾相识,比如可空性(Nullability)。 Kotlin语言的特性有:

1.简洁

大幅减少样板代码量。

2.与Java的100%互操作性

Kotlin可以直接与Java类交互,反之亦然。这个特性使得我们可以直接重用我们的代码库,并将其迁移到 Kotlin中。由于Java的互操作性几乎无处不在。我们可以直接访问平台API以及现有的代码库,同时仍然享受和使用 Kotlin 的所有强大的现代语言功能。

3.扩展函数

Kotlin 类似于 C# 和 Gosu, 它提供了为现有类提供新功能扩展的能力,而不必从该类继承或使用任何类型的设计模式 (如装饰器模式)。

4.函数式编程

Kotlin 语言一等支持函数式编程,就像Scala一样。具备高阶函数、Lambda 表达式等函数式基本特性。

5.默认和命名参数

在Kotlin中,您可以为函数中的参数设置一个默认值,并给每个参数一个名称。这有助于编写易读的代码。

6.强大的开发工具支持

而由于是JetBrains出品,我们拥有很棒的IDE支持。虽然Java到Kotlin的自动转换并不是100% OK 的,但它确实是一个非常好的工具。使用 IDEA 的工具转换Java代码为 Kotlin 代码时,可以轻松地重用60%-70%的结果代码,而且修改成本很小。

Kotlin 除了简洁强大的语法特性外,还有实用性非常强的API以及围绕它构建的生态系统。例如:集合类 API、IO 扩展类、反射API 等。同时 Kotlin 社区也提供了丰富的文档和大量的学习资料,还有在线REPL。

A modern programming language that makes developers happier. Open source forever

图来自《Kotlin从入门到进阶实战》 (陈光剑,清华大学出版社)

图来自《Kotlin从入门到进阶实战》 (陈光剑,清华大学出版社)

https://kotlinlang.org/

猜你喜欢

转载自blog.csdn.net/universsky2015/article/details/108669427