Groovy探索之Builder 一
Groovy语言的builder,或者说Builder模式,可以说是DSL的核心,在Groovy语言中的使用到处都是。对于我们来说,使用builder是相当容易的,这当然是DSL带来的好处,使得编码相当简单和直观。但另一方面,写出自己的builder又相当的不容易,虽然Groovy语言为我们提供了
BuilderSupport基类,但是要熟练使用它却是相当的困难。本系列《Groovy探索之Builder》打算分四个部分来谈谈这个方面的问题。
我最早进入Groovy语言,就是因为在一个项目中需要大量生成xml文件。我们知道,在Java中使用DOM或其他一些API生成xml文件都相当的麻烦;而我前不久又恰恰在一篇文档中看到过使用Groovy语言生成xml文件的简单。所以我就正儿八经的进入到了Groovy的世界,当然,首次接触到Groovy语言,就是它的builder了。
我在项目中需要生成的xml文件形式如下(当然实际的xml文件比它麻烦得多):
<person>
<name>Tom</name>
<age>33</age>
<addr>Shenzhen</addr>
</person>
要生成上面的xml文件,使用Java语言的DOM的难度就不需要我多说,使用过该API的人都知道。我们现在来看看如何使用Groovy语言来生成它。
def
out =
new
StringWriter()
def
xml =
new
MarkupBuilder(out)
xml.person {
name
'Tom'
age
'33'
addr
'shenzhen'
}
println
out.toString()
见识到了
DSL
的威力了吧?跟我们的
DOM
比比看,哪个更简单,哪个更直观?可以看到,在
Groovy
中,我们只需要生成一个
MarkupBuilder
对象,就可以很直观的组织
xml
文件了。记得要把“
import
groovy.xml.MarkupBuilder
”引入。上面代码的结果为:
<person>
<name>Tom</name>
<age>33</age>
<addr>shenzhen</addr>
</person>
你把两者结合起来一对比就知道
builder
的
DSL
编码是怎么组织的,不需要我多费口舌了。
当然,你可能为认为上面的
xml
文件太过于简单。好,我们就来一个复杂一点的。
<person>
<name type="givenname">Tom</name>
<age>33</age>
<addr>
<province>Guangdong</province>
<city>Shenzhen</city>
</addr>
</person>
生成上面的xml文件,Groovy代码为:
def
out =
new
StringWriter()
def
xml =
new
MarkupBuilder(out)
xml.person {
name(type:
'givenname'
,
'Tom'
)
age
'33'
addr{
province
'Guangdong'
city
'Shenzhen'
}
}
println
out.toString()
如果你对有时候是大括号,有时候是小括号,还有空格这些符号感到疑惑。这是使用
Groovy
语言一段时间来能明白的东西。大括号的一段代码当然是指闭包,而小括号的一段代码代表的是方法,而空格,像“
age
'33'
”这样的代码,其实和“
age(
'33')
”是等价的,也就是说也是一个方法。
像:
addr{
province
'Guangdong'
city
'Shenzhen'
}
其实和下面的代码等价:
Addr({
province
'Guangdong'
city
'Shenzhen'
})
当然也是一个方法,只不过方法的参数是一个闭包。
回到我在项目中遇到的生成xml文件的问题,上面的person是我的问题的一个简化版本。为了描述的方便,我准备继续使用下去。往下的问题是,我有很多的person,这些数据都从数据库取,然后来生成一个xml文件。形如:
<persons>
<person>
<name>Tom</name>
<age>33</age>
<addr>Shenzhen</addr>
</person>
<person>
<name>Alice</name>
<age>22</age>
<addr>Taibei</addr>
</person>
</persons>
这样的问题又该如何解决呢?我最初的思路是这样的:
def
out =
new
StringWriter()
def
xml =
new
MarkupBuilder(out)
def
list = [
new
Person(name:
'Tom'
,age:
'33'
,addr:
'Shenzhen'
),
new
Person(name:
'Alice'
,age:
'22'
,addr:
'Taibei'
)]
xml.persons{
for
(p
in
list){
person{
for
(prop
in
p.properties)
{
if
(prop.key!=
'metaClass'
&&prop.key!=
'class'
)
{
prop.key prop.value
}
}
}
}
}
println
out.toString()
其中Person类如下:
class
Person
{
String name
String age
String addr
}
这种思路很直接,首先对list对象循环,然后再对Person的属性做循环,依次取属性名和值。为什么要对Person对象的属性做循环呢?因为在我的项目中,需要生成xml文件的,不止是Person类,还有其他的domain类对象。
但是,你运行上面的代码,结果就是出错了。这个错误我当时没有找到解决的办法,只能放弃了这种解决思路。后来深入的学习了Groovy语言,才知道Gstring对象能解决这个问题。代码如下:
def
out =
new
StringWriter()
def
xml =
new
MarkupBuilder(out)
def
list = [
new
Person(name:
'Tom'
,age:
'33'
,addr:
'Shenzhen'
),
new
Person(name:
'Alice'
,age:
'22'
,addr:
'Taibei'
)]
xml.persons{
for
(p
in
list){
person{
for
(prop
in
p.properties)
{
if
(prop.key!=
'metaClass'
&&prop.key!=
'class'
)
{
"$prop.key"
prop.value
}
}
}
}
}
println
out.toString()
运行的结果为:
<persons>
<person>
<age>33</age>
<addr>Shenzhen</addr>
<name>Tom</name>
</person>
<person>
<age>22</age>
<addr>Taibei</addr>
<name>Alice</name>
</person>
</persons>
这又让我们看到了
Gstring
的强大功能,我前面说过,
Gstring
是
Groovy
动态性的基础,果然在很多方面得到了体现。