DSL简介
DSL(Domain-Specific Language,领域特定语言)指的是专注于特定问题领域的计算机语言,不同于通用的计算机语言(GPL general purpose language),领域特定语言只用在某些特定的领域领域可能是某一种产业,保险、教育、航空、医疗;也可能是一种方法或技术。比如数据库SQL html。
DSL不是一种新的语言,只是一种编码风格。DSL的作用是提升代码的可读性,使得不懂代码的人也能看懂代码。在kotlin中构建DSL需要用到的知识点有:扩展函数、中缀调用、带接收者的函数字面值(高阶函数,Lambda表达式)。
DSL举例
标准写法
fun main(args: Array<String>) {
val address = Address("深圳市", "新安街道", 30)
val person = Person("林青霞", 50, address)
println(person)
}
data class Address(val city: String, val street: String, val number: Int)
data class Person(val name: String, val age: Int, val address: Address)
以上代码,如果让不懂代码的人看的话,是比较难看懂的。但如果用DSL写法来写的话,就能让不懂代码的人也能看得懂。
DSL写法
fun main(args: Array<String>) {
val person: Person =
person {
name = "林青霞"
age = 50
address {
city = "西虹市"
street = "土豪街道"
number = 30
}
}
println(person)
}
fun person(block: Person.() -> Unit): Person {
//新建一个person对象
val person = Person()
//执行block函数,需要传递person对象使用
person.block()
//返回person
return person
}
fun Person.address(block: Address. () -> Unit) {
//创建address对象
val address = Address()
//执行block函数
address.block()
//添加到person对象里面
this.address = address
}
data class Address(var city: String? = null, var street: String? = null, var number: Int? = null)
data class Person(var name: String? = null, var age: Int? = null, var address: Address? = null)
根据昨天学习的Apply函数,可以将代码修改为:
fun person(block: Person.() -> Unit): Person {
return Person().apply(block)
}
fun Person.address(block: Address. () -> Unit) {
this.address = Address().apply(block)
}
生成HTML标签
标准写法
fun main(args: Array<String>) {
val div = Div()
val body = Body()
val head = Head()
val html = Html()
html.addTag(head)
body.addTag(div)
html.addTag(body)
println(html)
}
class Div:Tag("div")
class Body:Tag("body")
class Head:Tag("head")
class Html:Tag("html")
/*
*标签<html></html>
*/
open class Tag(val name: String) {
//存标签
val list = ArrayList<Tag>()
//添加子标签
fun addTag(tag: Tag) {
list.add(tag)
}
//将当前标签以及字标签变成字符串html
override fun toString(): String {
val sb = StringBuilder()
sb.append("<${name}>")
//放置子标签
list.forEach {
sb.append(it.toString())
}
sb.append("<${name}>")
return sb.toString()
}
}
DSL写法
fun main(args: Array<String>) {
val result: Html =
html {
head {
//head是函数
}
body {
div {
}
}
}
println(result.toString())
}
fun Body.div(block: () -> Unit) {
//创建Div标签对象
val div = Div()
//添加到body标签对象里面
addTag(div)
}
fun Html.body(block: Body.() -> Unit) {
//创建Head标签
val body = Body()
//执行block函数
block(body)
//添加到Html标签里面
addTag(body)
}
fun Html.head(block: () -> Unit) {
//创建Head标签
val head = Head()
//添加到Html标签里面
addTag(head)
}
fun html(block: Html.() -> Unit): Html {
val html = Html()
//html.block()
block(html)
return html
}
class Div : Tag("div")
class Body : Tag("body")
class Head : Tag("head")
class Html : Tag("html")
/**
* 标签 <html></html>
*/
open class Tag(val name: String) {
//存标签
val list = ArrayList<Tag>()
//添加子标签
fun addTag(tag: Tag) {
list.add(tag)
}
/**
* 将当前标签以及子标签变成字符串 html
*/
override fun toString(): String {
val sb = StringBuilder()
sb.append("<${name}>")
//放子标签
list.forEach {
//head
sb.append(it.toString())//head
}
sb.append("</${name}>")
return sb.toString()
}
}
在以上代码中,同样可以用Apply简化:
fun Body.div(block: Div. () -> Unit) {
addTag(Div().apply(block))
}
fun Html.body(block: Body.() -> Unit) {
addTag(Body().apply(block))
}
fun Html.head(block: Head. () -> Unit) {
addTag(Head().apply(block))
}
fun html(block: Html.() -> Unit): Html {
return Html().apply(block)
}
当然,我们这段代码并不安全,比如可以在div{}中继续添加head{},如果想要避免这种情况,就需要缩小作用域。
缩小作用域
缩小作用域,只需要在代码最后增加一个注解@DslMarker,之后给每个对象都加上注解,或给父类加上注解。完整的代码为:
fun main(args: Array<String>) {
val result: Html =
html {
head {
}
body {
div {
}
}
}
println(result.toString())
}
fun Body.div(block: Div. () -> Unit) {
addTag(Div().apply(block))
}
fun Html.body(block: Body.() -> Unit) {
addTag(Body().apply(block))
}
fun Html.head(block: Head. () -> Unit) {
addTag(Head().apply(block))
}
fun html(block: Html.() -> Unit): Html {
return Html().apply(block)
}
class Div : Tag("div")
class Body : Tag("body")
class Head : Tag("head")
class Html : Tag("html")
@zyy
open class Tag(val name: String) {
val list = ArrayList<Tag>()
fun addTag(tag: Tag) {
list.add(tag)
}
override fun toString(): String {
val sb = StringBuilder()
sb.append("<${name}>")
list.forEach {
sb.append(it.toString())
}
sb.append("</${name}>")
return sb.toString()
}
}
@DslMarker
annotation class zyy
网友评论