適配器模式
適配器模式可以用于對(duì)不同的接口進(jìn)行包裝以及提供統(tǒng)一的接口，或者是讓某一個(gè)對(duì)象看起來像是另一個(gè)類型的對(duì)象。在靜態(tài)類型的編程語言里，我們經(jīng)常使用它去滿足類型系統(tǒng)的特點(diǎn)，但是在類似Ruby這樣的弱類型編程語言里，我們并不需要這么做。盡管如此，它對(duì)于我們來說還是有很多意義的。
當(dāng)使用第三方類或者庫的時(shí)候，我們經(jīng)常從這個(gè)例子開始（start out fine）：

def find_nearest_restaurant(locator)
 locator.nearest(:restaurant, self.lat, self.lon)
end

我們假設(shè)有一個(gè)針對(duì)locator的接口，但是如果我們想要find_nearest_restaurant能夠支持另一個(gè)庫呢？這個(gè)時(shí)候我們可能就會(huì)去嘗試添加新的特殊的場景的處理：

def find_nearest_restaurant(locator)
 if locator.is_a? GeoFish
  locator.nearest(:restaurant, self.lat, self.lon)
 elsif locator.is_a? ActsAsFound
  locator.find_food(:lat => self.lat, :lon => self.lon)
 else
  raise NotImplementedError, "#{locator.class.name} is not supported."
 end
end

這是一個(gè)比較務(wù)實(shí)的解決方案?；蛟S我們也不再需要考慮去支持另一個(gè)庫了。也或許find_nearest_restaurant就是我們使用locator的唯一場景。
那假如你真的需要去支持一個(gè)新的locator，那又會(huì)是怎么樣的呢？那就是你有三個(gè)特定的場景。再假如你需要實(shí)現(xiàn)find_nearest_hospital方法呢？這樣你就需要在維護(hù)這三種特定的場景時(shí)去兼顧兩個(gè)不同的地方。當(dāng)你覺得這種解決方案不再可行的時(shí)候，你就需要考慮適配器模式了。
在這個(gè)例子中，我們可以為GeoFish以及ActsAsFound編寫適配器，這樣的話，在我們的其他代碼中，我們就不需要了解我們當(dāng)前正在使用的是哪個(gè)庫了：

def find_nearest_hospital(locator)
 locator.find :type => :hospital,
        :lat => self.lat,
        :lon => self.lon
end

locator = GeoFishAdapter.new(geo_fish_locator)
find_nearest_hospital(locator)

特意假設(shè)的例子就到此為止，接下來讓我們看看真實(shí)的代碼。

實(shí)例
今天一大早，你的leader就匆匆忙忙跑過來找到你：“快，快，緊急任務(wù)！最近ChinaJoy馬上就要開始了，老板要求提供一種直觀的方式，可以查看到我們新上線的游戲中每個(gè)服的在線人數(shù)?！?br /> 你看了看日期，不是吧！這哪里是馬上要開始了，分明是已經(jīng)開始了！這怎么可能來得及呢？
“沒關(guān)系的。”你的leader安慰你道：“功能其實(shí)很簡單的，接口都已經(jīng)提供好了，你只需要調(diào)用一下就行了?！?br /> 好吧，你勉為其難地接受了，對(duì)于這種突如其來的新需求，你早已習(xí)慣。
你的leader向你具體描述了一下需求，你們的游戲目前有三個(gè)服，一服已經(jīng)開放一段時(shí)間了，二服和三服都是新開的服。設(shè)計(jì)的接口非常輕便，你只需要調(diào)用Utility.online_player_count(Fixnum)，傳入每個(gè)服對(duì)應(yīng)的數(shù)值就可以獲取到相應(yīng)服在線玩家的數(shù)量了，如一服傳入1，二服傳入2，三服則傳入3。如果你傳入了一個(gè)不存在的服，則會(huì)返回-1。然后你只要將得到的數(shù)據(jù)拼裝成XML就好，具體的顯示功能由你的leader來完成。
好吧，聽起來功能并不是很復(fù)雜，如果現(xiàn)在就開始動(dòng)工好像還來得及，于是你馬上敲起了代碼。
首先定義一個(gè)用于統(tǒng)計(jì)在線人數(shù)的父類PlayerCount，代碼如下：

class PlayerCount 
 
  def server_name 
    raise "You should override this method in subclass." 
  end 
   
  def player_count 
    raise "You should override this method in subclass." 
  end 
 
end 

接著定義三個(gè)統(tǒng)計(jì)類繼承PlayerCount，分別對(duì)應(yīng)了三個(gè)不同的服，如下所示：

class ServerOne < PlayerCount 
 
  def server_name 
    "一服" 
  end 
   
  def player_count 
    Utility.online_player_count(1) 
  end 
 
end 

class ServerTwo < PlayerCount 
 
  def server_name 
    "二服" 
  end 
   
  def player_count 
    Utility.online_player_count(2) 
  end 
 
end 

class ServerThree < PlayerCount 
 
  def server_name 
    "三服" 
  end 
   
  def player_count 
    Utility.online_player_count(3) 
  end 
 
end 

然后定義一個(gè)XMLBuilder類，用于將各服的數(shù)據(jù)封裝成XML格式，代碼如下：

class XMLBuilder 
 
  def self.build_xml player 
    builder = "" 
    builder << "<root>" 
    builder << "<server>" << player.server_name << "</server>" 
    builder << "<player_count>" << player.player_count.to_s << "</player_count>" 
    builder << "</root>" 
  end 
 
end 

這樣的話，所有代碼就完工了，如果你想查看一服在線玩家數(shù)只需要調(diào)用:

XMLBuilder.build_xml(ServerOne.new) 

查看二服在線玩家數(shù)只需要調(diào)用：

XMLBuilder.build_xml(ServerTwo.new) 

查看三服在線玩家數(shù)只需要調(diào)用：

XMLBuilder.build_xml(ServerThree.new) 

咦？你發(fā)現(xiàn)查看一服在線玩家數(shù)的時(shí)候，返回值永遠(yuǎn)是-1，查看二服和三服都很正常。
你只好把你的leader叫了過來：“我感覺我寫的代碼沒有問題，但是查詢一服在線玩家數(shù)總是返回-1，為什么會(huì)這樣呢？”
“哎呀！”你的leader猛然想起，“這是我的問題，前面沒跟你解釋清楚。由于我們的一服已經(jīng)開放一段時(shí)間了，查詢在線玩家數(shù)量的功能早就有了，使用的是ServerFirst這個(gè)類。當(dāng)時(shí)寫Utility.online_player_count()這個(gè)方法主要是為了針對(duì)新開的二服和三服，就沒把一服的查詢功能再重復(fù)做一遍。這種情況下可以使用適配器模式，這個(gè)模式就是為了解決接口之間不兼容的問題而出現(xiàn)的。”
其實(shí)適配器模式的使用非常簡單，核心思想就是只要能讓兩個(gè)互不兼容的接口能正常對(duì)接就行了。上面的代碼中，XMLBuilder中使用PlayerCount來拼裝XML，而ServerFirst并沒有繼承PlayerCount，這個(gè)時(shí)候就需要一個(gè)適配器類來為XMLBuilder和ServerFirst之間搭起一座橋梁，毫無疑問，ServerOne就將充當(dāng)適配器類的角色。修改ServerOne的代碼，如下所示：

class ServerOne < PlayerCount 
 
  def initialize 
    @serverFirst = ServerFirst.new 
  end 
 
  def server_name 
    "一服" 
  end 
   
  def player_count 
    @serverFirst.online_player_count 
  end 
 
end 

 
這樣通過ServerOne的適配，XMLBuilder和ServerFirst之間就成功完成對(duì)接了！使用的時(shí)候我們甚至無需知道有ServerFirst這個(gè)類，只需要正常創(chuàng)建ServerOne的實(shí)例就行了。
需要值得注意的一點(diǎn)是，適配器模式不并是那種會(huì)讓架構(gòu)變得更合理的模式，更多的時(shí)候它只是充當(dāng)救火隊(duì)員的角色，幫助解決由于前期架構(gòu)設(shè)計(jì)不合理導(dǎo)致的接口不匹配的問題。更好的做法是在設(shè)計(jì)的時(shí)候就盡量把以后可能出現(xiàn)的情況多考慮一些，在這個(gè)問題上不要向你的leader學(xué)習(xí)。

MultiJSON
ActiveSupport在做JSON格式的解碼時(shí)，用到的是MultiJSON，這是一個(gè)針對(duì)JSON庫的適配器。每一個(gè)庫都能夠解析JSON，但是做法卻不盡相同。讓我們分別看看針對(duì)oj和yajl的適配器。 (提示: 可在命令行中輸入qw multi_json查看源碼。)

module MultiJson
 module Adapters
  class Oj < Adapter
   #...
   def load(string, options={})
    options[:symbol_keys] = options.delete(:symbolize_keys)
    ::Oj.load(string, options)
   end
   #...

Oj的適配器修改了options哈希表，使用Hash#delete將:symbolize_keys項(xiàng)轉(zhuǎn)換為Oj的:symbol_keys項(xiàng)：

options = {:symbolize_keys => true}
options[:symbol_keys] = options.delete(:symbolize_keys) # => true
options                         # => {:symbol_keys=>true}

接下來MultiJSON調(diào)用了::Oj.load(string, options)。MultiJSON適配后的API跟Oj原有的API非常相似，在此不必贅述。不過你是否注意到，Oj是如何引用的呢？::Oj引用了頂層的Oj類，而不是MultiJson::Adapters::Oj。
現(xiàn)在讓我們看看MultiJSON又是如何適配Yajl庫的：

module MultiJson
 module Adapters
  class Yajl < Adapter
   #...
   def load(string, options={})
    ::Yajl::Parser.new(:symbolize_keys => options[:symbolize_keys]).parse(string)
   end
   #...

這個(gè)適配器從不同的方式實(shí)現(xiàn)了load方法。Yajl的方式是先創(chuàng)建一個(gè)解析器的實(shí)力，然后將傳入的字符串string作為參數(shù)調(diào)用Yajl::Parser#parse方法。在options哈希表上的處理也略有不同。只有:symbolize_keys項(xiàng)被傳遞給了Yajl。
這些JSON的適配器看似微不足道，但是他們卻可以讓你隨心所欲地在不同的庫之間進(jìn)行切換，而不需要在每一個(gè)解析JSON的地方更新代碼。
ActiveRecord
很多JSON庫往往都遵從相似的模式，這讓適配工作變得相當(dāng)輕松。但是如果你是在處理一些更加復(fù)雜的情況時(shí)，結(jié)果會(huì)是怎樣？ActiveRecord包含了針對(duì)不同數(shù)據(jù)庫的適配器。盡管PostgreSQL和MySQL都是SQL數(shù)據(jù)庫，但是他們之間還是有很多不同之處，而ActiveRecord通過使用適配器模式屏蔽了這些不同。(提示: 命令行中輸入qw activerecord查看ActiveRecord的代碼)
打開ActiveRecord代碼庫中的lib/connection_adapters目錄，里邊會(huì)有針對(duì)PostgreSQL,MySQL以及SQLite的適配器。除此之外，還有一個(gè)名為AbstractAdapter的適配器，它作為每一個(gè)具體的適配器的基類。AbstractAdapter實(shí)現(xiàn)了在大部分?jǐn)?shù)據(jù)庫中常見的功能，這些功能在其子類比如PostgreSQLAdapter以及AbstractMysqlAdapter中被重新定制，而其中AbstractMysqlAdapter則是另外兩個(gè)不同的MySQL適配器——MysqlAdapter以及Mysql2Adapter——的父類。讓我們通過一些真實(shí)世界中的例子來看看他們是如何一起工作的。
PostgreSQL和MySQL在SQL方言的實(shí)現(xiàn)稍有不同。查詢語句SELECT * FROM users在這兩個(gè)數(shù)據(jù)庫都可以正常執(zhí)行，但是它們在一些類型的處理上會(huì)稍顯不同。在MySQL和PostgreSQL中，時(shí)間格式就不盡相同。其中，PostgreSQL支持微秒級(jí)別的時(shí)間，而MySQL只是到了最近的一個(gè)穩(wěn)定發(fā)布的版本中才支持。那這兩個(gè)適配器又是如何處理這種差異的呢？
ActiveRecord通過被混入到AbstractAdapter的ActiveRecord::ConnectionAdapters::Quoting中的quoted_date引用日期。而AbstractAdapter中的實(shí)現(xiàn)僅僅只是格式化了日期：

def quoted_date(value)
 #...
 value.to_s(:db)
end

Rails中的ActiveSupport擴(kuò)展了Time#to_s，使其能夠接收一個(gè)代表格式名的符號(hào)類型參數(shù)。:db所代表的格式就是%Y-%m-%d %H:%M:%S：

# Examples of common formats:
Time.now.to_s(:db)   #=> "2014-02-19 06:08:13"
Time.now.to_s(:short)  #=> "19 Feb 06:08"
Time.now.to_s(:rfc822) #=> "Wed, 19 Feb 2014 06:08:13 +0000"

MySQL的適配器都沒有重寫quoted_date方法，它們自然會(huì)繼承這種行為。另一邊，PostgreSQLAdapter則對(duì)日期的處理做了兩個(gè)修改：

def quoted_date(value)
 result = super
 if value.acts_like?(:time) && value.respond_to?(:usec)
  result = "#{result}.#{sprintf("%06d", value.usec)}"
 end

 if value.year < 0
  result = result.sub(/^-/, "") + " BC"
 end
 result
end

它在一開始便調(diào)用super方法，所以它也會(huì)得到一個(gè)類似MySQL中格式化后的日期。接下來，它檢測value是否像是一個(gè)具體時(shí)間。這是一個(gè)ActiveSupport中擴(kuò)展的方法，當(dāng)一個(gè)對(duì)象類似Time類型的實(shí)例時(shí)，它會(huì)返回true。這讓它更容易表明各種對(duì)象已被假設(shè)為類似Time的對(duì)象。（提示: 對(duì)acts_like?方法感興趣？請?jiān)诿钚兄袌?zhí)行qw activesupport，然后閱讀core_ext/object/acts_like.rb）
第二部分的條件檢查value是否有用于返回毫秒的usec方法。如果可以求得毫秒數(shù)，那么它將通過sprintf方法被追加到result字符串的末尾。跟很多時(shí)間格式一樣，sprintf也有很多不同的方式用于格式化數(shù)字：

sprintf("%06d", 32) #=> "000032"
sprintf("%6d", 32) #=> "  32"
sprintf("%d",  32) #=> "32"
sprintf("%.2f", 32) #=> "32.00"

最后，假如日期是一個(gè)負(fù)數(shù)，PostgreSQLAdapter就會(huì)通過加上”BC”去重新格式化日期，這是PostgreSQL數(shù)據(jù)庫的實(shí)際要求：

SELECT '2000-01-20'::timestamp;
-- 2000-01-20 00:00:00
SELECT '2000-01-20 BC'::timestamp;
-- 2000-01-20 00:00:00 BC
SELECT '-2000-01-20'::timestamp;
-- ERROR: time zone displacement out of range: "-2000-01-20"

這只是ActiveRecord適配多個(gè)API時(shí)的一個(gè)極小的方式，但它卻能幫助你免除由于不同數(shù)據(jù)庫的細(xì)節(jié)所帶來的差異和煩惱。
另一個(gè)體現(xiàn)SQL數(shù)據(jù)庫的不同點(diǎn)是數(shù)據(jù)庫表被創(chuàng)建的方式。MySQL以及PostgreSQL中對(duì)主鍵的處理各不相同：

# AbstractMysqlAdapter
NATIVE_DATABASE_TYPES = {
 :primary_key => "int(11) DEFAULT NULL auto_increment PRIMARY KEY",
 #...
}

# PostgreSQLAdapter
NATIVE_DATABASE_TYPES = {
 primary_key: "serial primary key",
 #...
}

這兩種適配器都能夠明白ActiveRecord中的主鍵的表示方式，但是它們會(huì)在創(chuàng)建新表的時(shí)候?qū)⒋朔g為不同的SQL語句。當(dāng)你下次在編寫一個(gè)migration或者執(zhí)行一個(gè)查詢的時(shí)候，思考一下ActiveRecord的適配器以及它們?yōu)槟阕龅乃形⑿〉氖虑椤?br /> DateTime和Time
當(dāng)MultiJson以及ActiveRecord實(shí)現(xiàn)了傳統(tǒng)的適配器的時(shí)候，Ruby的靈活性使得另一種解決方案成為可能。DateTime以及Time都用于表示時(shí)間，但是它們在內(nèi)部的處理上是不同的。雖然有著這些細(xì)微的差異，但是它們所暴露出來的API卻是極其類似的（提示：命令行中執(zhí)行qw activesupport查看此處相關(guān)代碼）：

t = Time.now
t.day   #=> 19     (Day of month)
t.wday  #=> 3     (Day of week)
t.usec  #=> 371552   (Microseconds)
t.to_i  #=> 1392871392 (Epoch secconds)

d = DateTime.now
d.day   #=> 19     (Day of month)
d.wday  #=> 3     (Day of week)
d.usec  #=> NoMethodError: undefined method `usec'
d.to_i  #=> NoMethodError: undefined method `to_i'

ActiveSupport通過添加缺失的方法來直接修改DateTime和Time，進(jìn)而抹平了兩者之間的差異。從實(shí)例上看，這里就有一個(gè)例子演示了ActiveSupport如何定義DateTime#to_i：

class DateTime
 def to_i
  seconds_since_unix_epoch.to_i
 end

 def seconds_since_unix_epoch
  (jd - 2440588) * 86400 - offset_in_seconds + seconds_since_midnight
 end

 def offset_in_seconds
  (offset * 86400).to_i
 end

 def seconds_since_midnight
  sec + (min * 60) + (hour * 3600)
 end
end

每一個(gè)用于支持的方法，seconds_since_unix_epoch，offset_in_seconds，以及seconds_since_midnight都使用或者擴(kuò)展了DateTime中已經(jīng)存在的API去定義與Time中匹配的方法。
假如說我們前面所看到的適配器是相對(duì)于被適配對(duì)象的外部適配器，那么我們現(xiàn)在所看到的這個(gè)就可以被稱之為內(nèi)部適配器。與外部適配器不同的是，這種方法受限于已有的API，并且可能導(dǎo)致一些麻煩的矛盾問題。舉例來說，DateTime和Time在一些特殊的場景下就有可能出現(xiàn)不一樣的行為：

datetime == time #=> true
datetime + 1   #=> 2014-02-26 07:32:39
time + 1     #=> 2014-02-25 07:32:40

當(dāng)加上1的時(shí)候，DateTime加上了一天，而Time則是加上了一秒。當(dāng)你需要使用它們的時(shí)候，你要記住ActiveSupport基于這些不同，提供了諸如change和Duration等保證一致行為的方法或類。
這是一個(gè)好的模式嗎？它理所當(dāng)然是方便的，但是如你剛才所見，你仍舊需要注意其中的一些不同之處。
總結(jié)
設(shè)計(jì)模式不是只有Java才需要的。Rails通過使用設(shè)計(jì)模式以提供用于JSON解析以及數(shù)據(jù)庫維護(hù)的統(tǒng)一接口。由于Ruby的靈活性，類似DateTime以及Time這樣的類可以被直接地修改而提供相似的接口。Rails的源碼就是一個(gè)可以讓你挖掘真實(shí)世界中不同設(shè)計(jì)模式實(shí)例的天堂。
在這次的實(shí)踐中，我們同時(shí)也發(fā)掘了一些有趣的代碼：

• hash[:foo] = hash.delete(:bar)是一個(gè)用于重命名哈希表中某一項(xiàng)的巧妙方法。
• 調(diào)用::ClassName會(huì)調(diào)用頂層的類。
• ActiveSupport為Time、Date以及其他的類添加了一個(gè)可選的代表格式的參數(shù)format。
• sprintf可以用于格式化數(shù)字。

想要探索更多的知識(shí)？回去看看MultiJson是如何處理以及解析格式的。仔細(xì)閱讀你在你的數(shù)據(jù)庫中所使用到的ActiveRecord的適配器的代碼。瀏覽ActiveSupport中用于xml適配器的XmlMini，它跟MultiJson中的JSON適配器是類似的。在這些里面還會(huì)有很多可以學(xué)習(xí)的。

最新評(píng)論