Ruby DSL 与普通 API 的区别

Question

Ruby DSL 有哪些定义特征可以将其与常规 API 区分开来？

Answer 1

当您使用 API 时，您会以命令式方式实例化对象并调用方法。另一方面，好的 DSL 应该是声明性的，代表问题域中的规则和关系，而不是要执行的指令。此外，理想情况下，DSL 应该可由非程序员读取和修改（API 则不然）。

另请记住内部 DSL 和外部 DSL 之间的区别。

• 内部领域特定语言嵌入到编程语言中（例如Ruby）。它很容易实现，但 DSL 的结构取决于它嵌入的父语言。
• 外部域特定语言是一种根据特定域设计的单独语言。它在语法方面为您提供了更大的灵活性，但您必须实现代码来解释它。它也更安全，因为编辑域规则的人无法访问母语言的所有功能。

Answer 2

DSL（领域特定语言）是一个被过度炒作的术语。如果您只是使用一种语言的子集（例如 Ruby），那么它与原始语言有何不同？答案是，不是。

但是，如果您对源文本进行一些预处理以引入核心语言中未找到的新语法或新语义，那么您确实拥有一种新语言，这可能是特定于领域的。

Answer 3

Ruby 的诗歌模式和运算符重载的结合确实提供了同时具有合法 Ruby 语法和合理 DSL 的可能性。

XML 的持续恶化确实表明，也许内置在所有这些配置文件中的简单 DSL 并没有完全被误导。

Answer 4

创建 DSL：

• 向 Object 类添加新方法，以便您可以像调用内置语言结构一样调用它们。 （请参阅 rake）

• 在自定义对象或对象集上创建方法，然后让脚本文件在顶级对象的上下文中运行语句。 （请参阅 capistrano）

API 设计：

• 在自定义对象或一组对象上创建方法，以便用户创建一个对象来使用这些方法。

• 将方法创建为类方法，以便用户在所有方法前面添加类名前缀。

  将方法创建为

• 将方法创建为用户包含或扩展以在其自定义对象中使用方法的混合。

所以，是的，他们之间的界限很窄。通过添加一个在正确上下文中运行脚本文件的方法，将一组自定义对象转换为 DSL 非常简单。

Answer 5

对我来说，DSL 和 API 之间的区别在于，如果 DSL 不是由该领域的人编写为 Ruby 的子语言，那么它至少可以被理解（并验证）。

例如，您可以让财务分析师在 Ruby DSL 中为股票交易应用程序编写规则，而他们永远不必知道自己正在使用 Ruby。

Answer 6

事实上，它们是同一件事。 DSL 通常是通过 Ruby 中的正常语言机制实现的，因此从技术上讲它们都是 API。

然而，为了让人们认识到某个东西是 DSL，它通常最终会向现有类添加看起来像声明性语句的内容。类似于 ActiveRecord 中的验证器和关系声明。

class Foo << ActiveRecord::Base
  validates_uniqueness_of :name
  validates_numericality_of :number, :integer_only => true

end

看起来像 DSL，而下面的则不是：

class Foo <<ActiveRecord::BAse
  def validate
    unless unique? name
      errors.add(:name, "must be unique")
    end

    unless number.to_s.match?(/^[-]?\d$/)
      errors.add(:number, "must be an integer")
    end
  end
end

它们都将由普通的 Ruby 代码实现。只是其中一个看起来像是有很酷的新语言结构，而另一个看起来相当平淡（并且过于冗长，等等）