三次是一个咒语
在我们构建我们的堆叠文件的DSL时， 我们把问题解决了三次。 首先， 我们写了自己的语法分析器，然后发现那样的话有太多的工作要维护。不仅仅是代码，而且还有文档。因为我们的DSL 足够复杂，如果没有足够文档，没有显然的方法去使用它的所有特性。
接着，在一个短时间内，我们用 XML实现了 DSL。 这样，我们不需要去写自己的语法分析器，因为XML 有现成的分析器。但是 XML引入太多的噪声，模糊了文件的实际内容 。我们的工程师发现思维在理解堆叠文件的含义和理解XML之间进行切换很困难。由此我认识到，XML 不适合人来阅读，XML可能不是用来创建DSL 的好的选择， 尽管我们有不用开发语法分析器（parser）的好处。
最后，我们用Ruby实现了DSL。 因为利用了 Ruby 解释器的分析功能，实现起来是很快的。我们不需要写分析器（就是Ruby）的文档，因为它已经存在。而且，最终的DSL 非常容易被人理解，也很简洁灵活。
好的。 让我们用Ruby来创建一个 DSL，该DSL允许我们定义形如‘parameter = value’的语句。请考虑以下假想的DSL 文件。
% cat params_with_equal.dsl
name = fred
parameter = .55
这不是合法的Ruby代码，我们需要稍微修改一下语法使得Ruby可以接受它。让我们将它改为：
% cat params_with_equal.dsl
name = "fred"
parameter = 0.55
一旦我们让DSL 遵循Ruby的语法，Ruby 就为我们做了所有的分析工作，并且提供了一种方式访问分析的结果。 现在，让我们写一些 Ruby 代码来读DSL。
首先，我们想要将这些参数用某种方式封装起来。 一个好的方法是将它们放到一个类中。我们称这个类为 MyDSL。
% cat mydsl.rb
class MyDSL
...
end#class MyDSL
从开发者的角度看，我们需要一个简单和直接的方式来分析DSL 文件。就如下面所示：
my_dsl = MyDSL.load(filename)
接着，让我们来写类方法 load:
类方法load 产生一个MyDSL对象， 并且以DSL 文件的内容为参数调用该对象的instance_eval。Instance_eval的第二个参数是可选的， 它使得Ruby 在出现语法分析错误时可以报告文件名。 一个可选的第三个参数（没有使用）可以使Ruby 在出现分析错误时能提供错误开始的行号def self.load(filename) dsl = new dsl.instance_eval(File.read(filename), filename) dsl end
这个代码能工作吗？ 让我们看看发生了什么？
% cat dsl-loader.rb require 'mydsl' my_dsl = MyDSL.load(ARGV.shift) # put the DSL filename on the command line p my_dsl p my_dsl.instance_variables % ruby dsl-loader.rb params_with_equal.dsl #
发生了什么? name 和parameter到那里去了？ 这是因为name和parameter在等号的左侧，Ruby 认为他们是局部变量。我们可以告诉Ruby它们是实例变量。有两种方式，一种是使用 self.name = “fred” self.parameter = 0.55 ， 另一种是使用@符号。
@name = "fred"
@parameter = 0.55
但是对我来说，这样很丑陋。写成下面的形式也是一样。
$name = "fred"
$parameter = 0.55
还有一个办法让Ruby 知道这些方法（method）执行的上下文， 那就是利用块(block)和 yield self（MyDsl的对象实例） 来显式的声明作用域。 为了做到这一点，我们将加一个顶层方法来开始我们的DSL， 并且将实际内容放进所附的块(block)中。 修改过的 DSL 看起来是这样：
% cat params_with_equal2.dsl define_parameters do |p| p.name = "fred" p.parameter = 0.55 end
define_parameter 已经被定义为一个实例方法（instance method）。
% cat mydsl2.rb class MyDSL def define_parameters yield self end def self.load(filename) dsl = new dsl.instance_eval(File.read(filename), filename) dsl end end#class MyDSL
修改dsl-loader中的require，让它使用mydsl2.rb 中的新版本的MyDSL 类：
% cat dsl-loader.rb require 'mydsl2' my_dsl = MyDSL.load(ARGV.shift) p my_dsl p my_dsl.instance_variables
理论上，这可以工作， 让我们测试一下。
% ruby dsl-loader.rb params_with_equal2.dsl
params_with_equal2.dsl:2:in `load': undefined method `name=' for # (NoMethodError)
噢，我们忘记了为name 和parameter 定义访问函数（accessor）。 让我们加上它们， 然后看一下完整的程序：
% cat mydsl2.rb class MyDSL attr_accessor :name, :parameter def define_parameters yield self end def self.load(filename) # ... same as before end end
现在， 再测试一遍。
% ruby dsl-loader.rb params_with_equal2.dsl
#
["@name", "@parameter"]
成功！ 现在工作了。但是我们在DSL文件中加了额外的两行， 还有额外的 .p , 这些都引入了噪声。这样的记法（notation）更适合于当DSL文件中存在多个层次， 并且需要显式指定上下文的情况。 在我们的简单例子里，我们应该隐式的定义上下文， 且让Ruby 知道name 和parameter 是方法（method）。 让我们删掉 ‘=’ ， 将DSL 文件写成：
% cat params.dsl
name "fred"
parameter 0.55
现在，我们需要为name 和 parameter 定义新的访问方法（accessor）。这里的窍门是：不带参数的name 是@name的读方法（reader）， 带一个或多个参数的name 是@name的写方法（setter）。（注意：使用这个办法很方便，即使是DSL文件有多个层次而且上下文是显式声明的）。 我们下面为name 和parameter 定义访问方法, 删除attr_accessor那一行，加入以下代码：
% cat mydsl3.rb class MyDSL def name(*val) if val.empty? @name else @name = val.size == 1 ? val[0] : val end end def parameter(*val) if val.empty? @parameter else @parameters = val.size == 1 ? val[0] : val end end def self.load(filename) # ... same as before end end#class MyDSL
如果 name 或parameter 不带参数，它们将返回它们的值。如果带参数：
如果带一个参数，它们会被赋予该参数的值
如果带多个参数，它们会被赋予一个数组，该数组包含所有的参数值
让我们运行我们的分析器（现在是mydsl3.rb）来测试一下：
% ruby dsl-loader.rb params.dsl
#
["@parameter", "@name"]
又成功了。但是显式地定义访问方法( accessors) 很烦人。让我们定义一个定制的访问方法，并且让所有的类都可以使用它。 我们通过将此方法(method)放到 Module class 中来做到这一点。
% cat dslhelper.rb class Module def dsl_accessor(*symbols) symbols.each { |sym| class_eval %{ def #{sym}(*val) if val.empty? @#{sym} else @#{sym} = val.size == 1 ? val[0] : val end end } } end end
上面的代码简单的定义了一个 dsl_accessor 方法， 它是我们的DSL特定的访问方法。现在我们用它取代attr_accessor：
% cat mydsl4.rb require 'dslhelper' class MyDSL dsl_accessor :name, :parameter def self.load(filename) # ... same as before end end#class MyDSL
再一次，我们更新dsl-loader.rb 中的require 语句，加载mydsl4.rb， 然后运行loader:
% ruby dsl-loader.rb params.dsl
#
["@parameter", "@name"]
一切都很好。但是如果我不能事先知道参数的名字怎么办？ 在实际使用中，参数名应该可以由用户来生成。 别害怕。有Ruby 在， 我们可以使用 method_missing 的威力。给 MyDSL加一个两行的方法， 我们可以用dsl_accessor 根据需要随时定义新的属性(attribute)。 也就是说，如果一个值被赋予一个不存在的参数，method_missing 会定义一个 getter 和一个setter ，并且将该值赋予新生成的参数。
% cat mydsl5.rb require 'dslhelper' class MyDSL def method_missing(sym, *args) self.class.dsl_accessor sym send(sym, *args) end def self.load(filename) # ... Same as before end end % head -1 dsl-loader.rb require 'mydsl5' % ruby dsl-loader.rb params.dsl # ["@parameter", "@name"]
哇！是不是感觉很好？ 仅仅写了一点代码，我们有了一个可以读和定义任意数目参数的分析器。还可以吧。但是如果最终用户不知道Ruby，且使用了与现存的Ruby 方法冲突的名字，怎么办？ 举例来说，如果我们的DSL文件包含以下内容：
% cat params_with_keyword.dsl
methods %w(one two three)
id 12345
% ruby dsl-loader.rb params_with_keyword.dsl
params_with_keyword.dsl:2:in `id': wrong number of arguments (1 for 0) (ArgumentError)
噢，真不好意思。不过我们可以迅速的解决这个问题。 这里要用到一个类叫BlankSlate, 它最初是由 Jim Weirich构思出来的。 用在这的BlankSlate 和Jim 的有细微的差别，因为我们想要多保留一些功能。 我们将留下七个方法。 你可以试一试看看那些是绝对需要的，那些是用来辅助我们看MyDSL 的对象实例的内容。
% cat mydsl6.rb require 'dslhelper' class BlankSlate instance_methods.each { |m| undef_method(m) unless %w( __send__ __id__ send class inspect instance_eval instance_variables ).include?(m) } end#class BlankSlate # MyDSL now inherits from BlankSlate class MyDSL < BlankSlate # ... nothing new here, move along... end#class MyDSL
现在我们试一下加载包含关键字(keyword)的DSL 文件， 我们会看到一些更合理的东西。
% head -1 dsl-loader.rb
require 'mydsl6'
% ruby dsl-loader.rb params_with_keyword.dsl
#
["@id", "@methods"]
可以确信， 我们成功了。 这是一个好消息， 我们可以去掉那些没用的方法，给予我们的最终用户更自由的使用参数名字的权利。但是不管怎样，请注意，我们终究不能让最终用户完全自由的使用参数名。这是使用通用编程语言创建DSL的一个缺点， 但我认为，禁止最终用户使用’class’作为参数名，应该不会给我们的产品销路带来多大的风险。
