如何設計出漂亮的 Ruby APIs

2023-02-25 17:23:02Python017

如何設計出漂亮的 Ruby APIs,第1张

1.Argument Processing

Ruby 使用了 Symbols 和 Hash 来达到虚拟关键字参数(Pseudo-Keyword Arguments)。这种技巧被广泛应用在 Ruby 的函式库和 Rails 中，增加了阅读性，也很容易使用。

def blah(options)

puts options[:foo]

puts options[:bar]

end

blah(:foo =>"test", :bar =>"test")

Ruby 也可以将参数列当成阵列使用：

def sum(*args)

puts args[0]

puts args[1]

puts args[2]

puts args[3]

end

sum(1,2,3)

如此就可以设计出不固定参数列、十分弹性的 API。类似於 C++ 的 function overloading。在 Rails 中也十分常见这样的 API 设计，例如 link_to 就支援了两种用法：

# USAGE-1 without block

<% link_to 'Posts list', posts_path, :class =>'posts' %>

# USAGE-2 with block

<% link_to posts_path, :class =>'posts' do %>

Posts list

<% end %>

搭配虚拟关键字参数使用的话，可以参考 ActiveSupport#extract_options! 这个小技巧取出 Hash 值。

2. Code Blocks

程式区块(Block)是 Ruby 最重要的特色，除了拿来做迭代(Iteration)之外，也可以包装前後置处理(pre- and Post-processing)，一个最基本的例子就是开档了，一般程序式的写法如下：

f = File.open("myfile.txt", 'w')

f.write("Lorem ipsum dolor sit amet")

f.close

使用 Block 之後，我们可以将 f.close 包装起来，不需要明确呼叫。只要程式区块结束，Ruby 就会自动关档。程式一来因为缩排变得有结构，二来也确定档案一定会关闭(不然就语法错误了)

# using block

File.open("myfile.txt", 'w') do |f|

f.write("Lorem ipsum dolor sit amet")

end

另一个程式区块的技法，是用来当做回呼(Dynamic Callbacks)。在 Ruby 中，程式区块也是物件，於是我们可以将程式区块如透过”注册”的方式先储存下来，之後再依照需求找出来执行。例如在 Sinatra 程式中：

get '/posts' do

#.. show something ..

end

post '/posts' do

#.. create something ..

end

我们”注册”了两个回呼：一是当浏览器送出 GET ‘/posts’ 时，会执行 show something 的程式区块，二是 POST ‘/posts’ 时。

3. Module

模组(Module)是 Ruby 用来解决多重继承问题的设计。其中有一招 Dual interface 值得一提：

module Logger

extend self

def log(message)

$stdout.puts "#{message} at #{Time.now}"

end

Logger.log("test") # as Logger’s class method

class MyClass

include Logger

end

MyClass.new.log("test") # as MyClass’s instance method

Ruby 的 extend 作用是将模组混入(mix-in)进单件类别(singleton class)，於是 log 这个方法除了可以像一般的模组被混入 MyClass 中使用，也可以直接用 Logger.log 呼叫。

要将 Ruby 模组的混入成类别方法(class method)，也有一些常见的 pattern 模式，可以将模组设计可以同时混入实例方法(instance method)和类别方法，请参阅投影片范例。这在撰写 Rails plugin 时非常常用。

4. method_missing?

Ruby 的 Missing 方法是当你呼叫一个不存在的方法时，Ruby 仍然有办法处理。它会改呼叫 method_missing 这个方法，并把这个不存在的方法名称传进去当做参数。这个技巧在 Rails 的 ActiveRecord 中拿来使用：

class Person <ActiveRecord::Base

end

p1 = Person.find_by_name("ihower")

p2 = Person.find_by_name_and_email("ihower", "[email protected]")

其中 find_by_name 和 find_by_email 就是这样的方法。不过这个技巧不是万能丹，它的执行效率并不好，所以只适合用在你没办法预先知道方法名称的情况下。不过也不是没有补救之道，如果同样的方法还会继续呼叫到，你可以在 method_missing 之中用 define_method 或 class_eval 动态定义此方法，那麼下次呼叫就不会进来 method_missing，进而获得效能的改善。事实上，ActiveRecord::Base 的 method_missing 就是这麼做的。(感谢 BigCat 留言提醒我有此补救之道)

另一个 Missing 方法的绝妙 API 设计，是拿来构建 XML 文件：

builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)

builder.person do |b|

b.name("Jim")

b.phone("555-1234")

b.address("Taipei, Taiwan")

end

# <person>

# <name>Jim</name>

# <phone>555-1234</phone>

# <address>Taipei, Taiwan</address>

# </person>

搭配了区块功能，就能用 Ruby 语法来写 XML，非常厉害。

5. const_missing

除了 method_missing，Ruby 也有 const_missing。顾名思义就是找不到此常数时，会呼叫一个叫做 const_missing 的方法。现实中的例子有 Rails 的 ActiveSupport::Dependencies，它帮助我们不需要先载入所有类别档案，而是当 Rails 碰到一个还不认识的常数时，它会自动根据惯例，找到该档案载入。

我们也可以利用这个技巧，针对特定的常数规则来处理。例如以下的程式会自动将 U 开头的常数，自动转译成 Unicode 码：

class Module

original_c_m = instance_method(:const_missing)

define_method(:const_missing) do |name|

if name.to_s =~ /^U([0-9a-fA-F]{4})$/

[$1.to_i(16)].pack("U*")

else

original_c_m.bind(self).call(name)

end

puts U0123 # ģ

puts U9999 # 香

6. Methods chaining

方法串接是一个很常见的 API 设计，透过将方法的回传值设成 self，我们就可以串接起来。例如：

[1,1,2,3,3,4,5].uniq!.reject!{ |i| i%2 == 0 }.reverse

# 5,3,1

7. Core extension

Ruby 的类别是开放的，可以随时打开它新增一点程式或是修改。即使是核心类别如 Fixnum 或是 Object(这是所有类别的父类别) 都一样。例如 Rails 就定义了一些时间方法在 Fixnum 里：

class Fixnum

def hours

self * 3600 # 一小时有多少秒

end

alias hour hours

end

Time.now + 14.hours

Ruby 的物件模型与元编程(Meta-programming)

在 Ruby 中，所有东西都是物件。甚至包括类别(class)本身也是物件。这个类别物件(class object)是一个叫做 Class 的类别所实例出来的物件。而所有的物件(当然也包括类别物件)，都有一个 metaclass (又叫做 singleton, eigenclass, ghost class, virtual class 等名字)。定义在 metaclass 里的方法，只有该物件能够使用，也就是 singleton method (单件方法)，只有该物件才有的方法。

了解什麼是 metaclass 是 Ruby 元编程的一个重要前提知识。Ruby 元编程最常用的用途，就是因应需求可以动态地定义方法，例如在 Rails ActiveRecord 中常见的 Class Macro 应用。

要能随心所欲动态定义方法的关键重点，就是 variable scope (变数的作用域) 了。例如以下我们透过 class_eval 和 define_method 帮 String 定义了一个 say 方法，注意到整个 variable scope 都是通透的，没有建立新的 scope：

name = "say"

var = "it’s awesome"

String.class_eval do

define_method(name) do

puts var

end

"ihower".say # it’s awesome

class_eval 可以让我们改变 method definition 区域(又叫做 current class)。除了本投影片，建议可以阅读 Metaprogramming in Ruby: It’s Allhe Self 和 Three implicit contexts in Ruby 这两篇文章深入了解 self 和 current class。

8. Class Macro (Ruby’s declarative style)

Class Macro 是 Ruby Meta-programming 非常重要的一个应用，例如在 Rails ActiveRecord 中：

class User <ActiveRecord::Base

validates_presence_of :login

validates_length_of :login,:within =>3..40

validates_presence_of :email

belongs_to :group

has_many :posts

end

三个PHP调用系统命令函数的区别与联系

我们在执行linux系统的shell命令时，会用到PHP调用系统命令函数来实现。那么在这些函数中，主要包括了system()，exec()，passthru()这三个经常用于外部命令调用的函数。

虽然这三个命令都能执行linux系统的shell命令，但是其实他们是有区别的：

system() 输出并返回最后一行shell结果。

exec() 不输出结果，返回最后一行shell结果，所有结果可以保存到一个返回的数组里面。

passthru() 只调用命令，把命令的运行结果原样地直接输出到标准输出设备上。

相同点：都可以获得命令执行的状态码

在PHP中调用外部命令，可以用如下三种方法来实现：

用PHP提供的专门函数

PHP提供共了3个专门的执行外部命令的PHP调用系统命令函数：system()，exec()，passthru()。

system()

原型：string system (string command [, int return_var])

system()函数很其它语言中的差不多，这个PHP调用系统命令函数执行给定的命令，输出和返回结果。第二个参数是可选的，用来得到命令执行后的状态码。

例子：

system("/usr/local/bin/webalizer/webalizer")

exec()

原型：string exec(string command [, string array [, int return_var]])

exec()函数与system()这个PHP调用系统命令函数类似，也执行给定的命令，但不输出结果，而是返回结果的最后一行。虽然它只返回命令结果的最后一行，但用第二个参数array 可以得到完整的结果，方法是把结果逐行追加到array的结尾处。所以如果array不是空的，在调用之前最好用unset()最它清掉。只有指定了第二个参数时，才可以用第三个参数，用来取得命令执行的状态码。

例子：

exec("/bin/ls -l")

exec("/bin/ls -l", $res)

exec("/bin/ls -l", $res, $rc)

passthru()

原型：void passthru (string command [, int return_var])

passthru ()只调用命令，这个PHP调用系统命令函数不返回任何结果，但把命令的运行结果原样地直接输出到标准输出设备上。所以passthru()函数经常用来调用象pbmplus (Unix下的一个处理图片的工具，输出二进制的原始图片的流)这样的程序。同样它也可以得到命令执行的状态码。

例子：

header("Content-type: image/gif")

passthru("./ppmtogif hunte.ppm")

六种用ruby调用执行shell命令的方法

碰到需要调用操作系统shell命令的时候，Ruby为我们提供了六种完成任务的方法：