本文试图以 KHttp 为例，简要地说明 DSL 的减负能力和 Kotlin DSL 的一般写法，希望能与读到这篇文章的您一起分享代码优化的一些感悟。通读全文大概需要花费您 2 分钟的时间。
嗯，欠下的总归是要还的。在《Kotlin 带你飞 • 实战篇》里笔者为自己立了一个实践 DSL 的 Flag，拖了近两个月，文章码起。
相关 Github 源码 • KHttp
版权声明：本文为 frendy 原创文章，可以随意转载，但请务必在明确位置注明出处。
什么是 DSL
百度百科曰：领域特定语言，domain-specific languages，简称 DSL。
维基百科曰：A domain-specific language (DSL) is a computer language specialized to a particular application domain. This is in contrast to a general-purpose language (GPL), which is broadly applicable across domains.
是不是有点抽象，其实 Html 就是 DSL 的代表，Java 就是 GPL 的代表。我们举一个来自于网上的栗子：
用自然语言来描述我们的任务是，请列出 2011 年 11 月 20 日之后商务型和个人用的 13 寸的 A 品牌笔记本的交易额，不计入价格大于 10000 的 13 寸笔记本。
那么我们可以定义一个 DSL 语言如下：
SUM (表.交易额) {
大小 : 13寸
用途 : 商务型和个人用
品牌 : A
Filter : 日期 > 2011-11-20
Without : 大小 = 13 and 价格 > 10000
}DSL 会解析这个命令，然后读取数据结构和地址等配置文件，生成数据分析的代码。
恩，这是一种简化，一种对特定处理的封装。
以《领域特定语言》的作者 Fowler 的观点，DSL 首先是一种帮助用户从一个系统中抽象出某些部分的工具。所以当你意识到你需要一个组件，或者当你已经有了一个组件而你希望简化操作它的方式的时候，DSL 是有用的。使用 DSL 确实提供了某些益处。DSL 不仅提高了代码的易读性，让开发者可以和领域专家更好的交流，而且是改变执行上下文的一种手段，例如：把逻辑从编译时切换到运行时，或者当命令式编程不是很合适的时候转用声明式计算模型。
恩，DSL 编程就是一种声明式编程，直观、容易理解和使用。
其实在使用 Android Studio 进行开发的过程中，相信大家都已经切身感受过 Gradle 的巨大威力。和 Maven 比，Gradle 的 DSL 是如此简洁，在典型的 Maven 项目里，配置代码肯定要超过上千行，所以 Kotlin DSL 是来给我们减负的。
什么是 KHttp
KHttp 是笔者实践 DSL 的一个示例，是对于第三方网络请求库 OKHttp3 的 Kotlin DSL 封装。其实网上许多朋友也都有过相关封装了，简单明了，在项目中也挺好用(捧脸)。
1. 如何使用
- 在根目录的 build.gradle 文件中添加 repositories 如下：
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
- 在使用到的模块添加依赖：
dependencies {
compile 'com.github.frendyxzc:KHttp:0.0.2'
}
- 用法如下，很像 js 是不是，更多细节可参考 README：
http {
url = url_get
method = "get"
onSuccess {
jsonStr: String ->
callback.onSuccess(gson.fromJson(jsonStr, Resp::class.java).data)
}
onFail {
e -> callback.onFail(e.message)
}
}
2. 封装原理
源码先行：
fun http(init: KRequest.() -> Unit) {
val wrap = KRequest()
wrap.init()
executeForResult(wrap)
}
class KRequest {
var url: String? = null
var method: String? = null
var body: RequestBody? = null
var timeout: Long = 10
internal var _success: (String) -> Unit = { }
internal var _fail: (Throwable) -> Unit = { }
fun onSuccess(onSuccess: (String) -> Unit) {
_success = onSuccess
}
fun onFail(onError: (Throwable) -> Unit) {
_fail = onError
}
}
这里笔者着重说明两个自认为可能存在疑问的点吧：
- fun http(init: KRequest.() -> Unit)
其中 KRequest.() -> Unit 是扩展函数的用法，也即是为 KRequest 类定义了一个名为 init() 的扩展函数，并将该函数对象作为 http() 的一个参数。
因此，下面的语句翻译成类似 Java 这种 GPL 语言的表达方式其实是这样的：
http {
url = url_get
}
KRequest().init(url_get)
class KRequest {
void init(String url) {
this.url = url;
}
}
至于 Kotlin 扩展函数，如不清楚，可参考笔者之前的 Kotlin 带你飞系列文章。这里简单举个栗子，比如给 Context 添加 toast 函数如下：
fun Context.toast(message: CharSequence, duration: Int = Toast.LENGTH_SHORT) {
Toast.makeText(this, message, duration).show()
}
可在任意地方通过 context 实例调用扩展函数如下
context.toast("Hello frendy!")
- executeForResult(wrap)
其实这里也没什么疑问了，就是调用 OKHttp3 执行网络请求，同时用 Flowable 来管理各个请求：
private fun executeForResult(wrap: KRequest) {
Flowable.create<Response>(
{ e -> e.onNext(onExecute(wrap)) },
BackpressureStrategy.BUFFER
).subscribeOn(Schedulers.io()).subscribe(
{ resp -> wrap._success(resp.body()!!.string()) },
{ e -> wrap._fail(e) }
)
}
private fun onExecute(wrap: KRequest): Response? {
var req: Request? = null
when (wrap.method) {
"get", "Get", "GET" -> req = Request.Builder().url(wrap.url).build()
"post", "Post", "POST" -> req = Request.Builder().url(wrap.url).post(wrap.body).build()
"put", "Put", "PUT" -> req = Request.Builder().url(wrap.url).put(wrap.body).build()
"delete", "Delete", "DELETE" -> req = Request.Builder().url(wrap.url).delete(wrap.body).build()
}
val http = OkHttpClient.Builder().connectTimeout(wrap.timeout, TimeUnit.SECONDS).build()
val resp = http.newCall(req).execute()
return resp
}
看到这里，有没有跃跃欲试的感觉，DSL 的写法这么干净、这么简洁，以至于不懂代码的人都可以配置一下就跑起来是吧。嗯，但是也并不是所有场景都合适，至于怎么评判，还是听 Fowler 的话吧，当你意识到你需要一个组件，或者当你已经有了一个组件而你希望简化操作它的方式的时候，DSL 是有用的，嗯，重要的话还是要重复重复的。
qrcode_card
网友评论