摘要：我將描述我發(fā)現(xiàn)塑造成功框架的一些哲學(xué)。根據(jù)我的框架開發(fā)經(jīng)驗(yàn)，我特此冷凝和總結(jié)我認(rèn)為任何成功的框架最重要的哲學(xué)?，F(xiàn)代框架往往是松散耦合的體系結(jié)構(gòu)。全棧框架例如已經(jīng)演變成由松散耦合的組件可以多帶帶使用或與第三方交換的框架。

來源：Philosophies that Shaped Successful Frameworks

在過去的十年里我們看到了許多軟件框架的出現(xiàn)，像 Spring 和 Ruby on Rails 已經(jīng)是非常成功的框架了，掌握它們就意味著打開多扇就業(yè)機(jī)會(huì)的大門了。然而，對(duì)于每一個(gè)框架的成功，背后的大多數(shù)開發(fā)人員都不被人關(guān)注。2008年1月1日維基百科 列出了67個(gè) Web 框架。然而今天，超過三分之二的消失在列表中或在三年內(nèi)沒有更新。作為 Yii 框架的創(chuàng)造者，我花了很多時(shí)間調(diào)查各種框架和理解為什么有些成功，有些失敗了。我將描述我發(fā)現(xiàn)塑造成功框架的一些哲學(xué)。

建立一個(gè)成功的框架，重要的是要了解什么是框架，開發(fā)人員為什么需要它們。

Douglas C. Schmidt 等人 認(rèn)為框架作為一個(gè)集成的軟件構(gòu)件(如類、對(duì)象和組件)集合，為相關(guān)應(yīng)用程序提供一個(gè)可重用的體系結(jié)構(gòu)。根據(jù)這一定義，
框架應(yīng)該是一個(gè)已完工的應(yīng)用骨架組成可重用和可定制的組件。開發(fā)人員將擴(kuò)展并定制一個(gè)框架通過提供他們的應(yīng)用程序和領(lǐng)域特定邏輯來形成一個(gè)完整的應(yīng)用程序。

一個(gè)框架典型的特征就是所謂的控制反轉(zhuǎn)（inversion of control）?？蚣芡ǔ０缪葜M織主程序的角色和調(diào)用應(yīng)用程序代碼。這里是反過來的控制流——它調(diào)用我而不是我調(diào)用框架。下圖說明了框架之間的關(guān)系，函數(shù)庫(kù)，和應(yīng)用程序。注意框架通常提供現(xiàn)成的功能的庫(kù)，以幫助開發(fā)人員構(gòu)建應(yīng)用程序更快。

開發(fā)人員使用框架最重要的原因是框架如何提高生產(chǎn)力和幫助提高代碼質(zhì)量。例如，現(xiàn)代的框架(例如，django)，經(jīng)常提供代碼生成工具或樣板幫助立即啟動(dòng)新項(xiàng)目。此外，精心設(shè)計(jì)的框架內(nèi)嵌安全保護(hù)措施，幫助預(yù)防開發(fā)人員犯典型的安全漏洞。

企業(yè)使用框架，還有一個(gè)額外的好處是，它可以應(yīng)用在整個(gè)企業(yè)，幫助執(zhí)行標(biāo)準(zhǔn)?？蚣芴峁┝擞涗浤Ｊ?，詳細(xì)的設(shè)計(jì)和實(shí)現(xiàn)的工具用于在所有應(yīng)用程序之間提供一個(gè)一致的結(jié)構(gòu)。例如，在 Capital One (譯者注：薛強(qiáng)所在的公司) 我們開發(fā)一個(gè) 「Chassis」的框架作為一個(gè)集成的基礎(chǔ)，統(tǒng)一了許多廠商和顧客公司內(nèi)部開發(fā)應(yīng)用程序的 API。

當(dāng)然，并不是所有的開發(fā)人員喜歡使用框架。一些一致的抱怨包括陡峭的學(xué)習(xí)曲線，框架耦合性比較高，性能較低，等等。今天，在這篇文章中我將為你解釋現(xiàn)代框架如何的解決這些問題，讓大多數(shù)的這些抱怨不再適用。

像任何一個(gè)產(chǎn)品一樣，一個(gè)框架的成功取決于許多因素，包括其背后的思想，代碼質(zhì)量、文檔，周圍社區(qū)，營(yíng)銷，支持，等等。在我看來，特別重要的一項(xiàng)是考慮當(dāng)一個(gè)框架被設(shè)計(jì)和開發(fā)的哲學(xué)。

好久以前 Python 開發(fā)者 Tim Peters 開發(fā) Python 時(shí)發(fā)表了被稱為 Python 之禪 的二十格言設(shè)計(jì)原則。『優(yōu)美勝于丑陋，明了勝于晦澀，簡(jiǎn)潔勝于復(fù)雜……』他們鼓舞了許多類似的編程語(yǔ)言之禪（similar programming language zens），我發(fā)現(xiàn)這些格言是適用于框架設(shè)計(jì)的。根據(jù)我的框架開發(fā)經(jīng)驗(yàn)，我特此冷凝和總結(jié)我認(rèn)為任何成功的框架最重要的哲學(xué)。

越簡(jiǎn)單越好

整體設(shè)計(jì)是最糟糕的

一致性

明了勝于晦澀

約定大于配置

讓開發(fā)人員轉(zhuǎn)換一個(gè)新的框架從來都不是一件容易的事。然而，當(dāng)開發(fā)人員選用框架，會(huì)作為重點(diǎn)依靠它來投資當(dāng)前和未來的項(xiàng)目。此外，不想使用類庫(kù) - 開發(fā)人員可以學(xué)習(xí)一個(gè) API 實(shí)現(xiàn)它 - 學(xué)習(xí)框架要求開發(fā)人員在投入實(shí)際使用之前要充分理解框架規(guī)則。因此，重要的是要確保簡(jiǎn)單的設(shè)計(jì)一個(gè)框架，使它更容易、有趣，而且容易去學(xué)習(xí)，接受和利用。

為了實(shí)現(xiàn)簡(jiǎn)單，一個(gè)框架應(yīng)該強(qiáng)制執(zhí)行一定數(shù)量的限制規(guī)則；同時(shí)，這些規(guī)則應(yīng)以統(tǒng)一的方式設(shè)計(jì)和有良好的文檔記錄?？蚣軋?zhí)行更多的規(guī)則，陡峭的學(xué)習(xí)曲線，讓開發(fā)人員很難接受。當(dāng)規(guī)則是一致的，開發(fā)人員可以更快學(xué)習(xí)它們。沒有文檔，一個(gè)框架是無用的。因?yàn)闆]有人會(huì)花時(shí)間反向工程其規(guī)則。

Express.js framework 框架路由語(yǔ)法規(guī)則的設(shè)計(jì)是一個(gè)很好的例子，一個(gè)非常受歡迎的 web 應(yīng)用服務(wù)器框架。而路由在 web 應(yīng)用程序中是一個(gè)重要的概念，是確定應(yīng)用程序如何響應(yīng)客戶端請(qǐng)求一個(gè)特定的端點(diǎn)（一個(gè)HTTP方法和一個(gè)URI）。Express.js 介紹一個(gè)簡(jiǎn)單的規(guī)則來定義一個(gè)路線，app.METHOD(PATH, HANDLER)，METHOD 是一個(gè) HTTP 請(qǐng)求方法(例如 GET、POST)，PATH 是服務(wù)器上的一個(gè) URI 路徑，HANDLER 是回調(diào)函數(shù)路線相匹配時(shí)要執(zhí)行的。下面的代碼片段顯示了 Express.js 路由代碼的樣子。

var express = require("express");
var app = express();

// accept homepage request 
app.get("/", function (req, res) {
  res.send("Hello World!");
});

// accept POST request at /user 
app.post("/user", function (req, res) {
  res.send("Got a PUT request at /user");
});

// accept DELETE request at /user 
app.delete("/user", function (req, res) {
  res.send("Got a DELETE request at /user");
});

上面的代碼是不言自明的，因?yàn)樗袷侨绾稳タ匆粋€(gè) HTTP 請(qǐng)求。因此,開發(fā)人員只需要很少的努力去學(xué)習(xí)就記住這個(gè)路由語(yǔ)法并且把它的實(shí)用性應(yīng)用到自己的項(xiàng)目中。

這里的術(shù)語(yǔ)「整體」指的是以一個(gè)以緊密耦合的代碼庫(kù)為基礎(chǔ)構(gòu)建的框架。web 框架剛開始流行時(shí)，他們往往是一個(gè)整體，因?yàn)樗麄兊闹饕繕?biāo)是提供全方位的快速的 web 應(yīng)用程序開發(fā)。漸漸地，人們意識(shí)到整體框架有很多問題。例如，
即使改變是框架完全無關(guān)的一小部分需要重新測(cè)試和釋放整個(gè)，從而導(dǎo)致應(yīng)用程序的框架要重建。實(shí)際上，整體框架的中代碼耦合使得它非常難以保持不同版本的向后兼容性。比如專業(yè)緩存、日志、數(shù)據(jù)庫(kù)，人們變得不那么愿意被綁定到一個(gè)單一的整體框架。

現(xiàn)代框架往往是松散耦合的體系結(jié)構(gòu)。全?？蚣埽ɡ?Spring ）已經(jīng)演變成由松散耦合的組件可以多帶帶使用或與第三方交換的框架。專門的框架是有明確的契約，以支持更好的互操作性，這使得應(yīng)用程序不依賴于特定的框架。例如，一個(gè)非常受歡迎的 web 路由框架的特點(diǎn)是所謂『Sinatra-type 框架』，如 Sinatra，Express.js 和 Martini。這些框架使用以下中間件管道架構(gòu)支持請(qǐng)求路由和處理web應(yīng)用程序。框架本身是非常小的,但開放式體系結(jié)構(gòu)允許他們無限豐富的各種中間件組件。

一致性意味著一個(gè)框架，堅(jiān)持使用統(tǒng)一的設(shè)計(jì)，命名約定，代碼風(fēng)格，代碼組織等等。一個(gè)一致性的框架將降低門檻，因?yàn)橛脩艨梢詫W(xué)習(xí)框架一個(gè)方面，并且應(yīng)用相同的模式，去快速學(xué)習(xí)其他的結(jié)構(gòu)。一致還可以幫助用戶減少框架特征錯(cuò)別字或誤用的可能性。

例如，當(dāng)設(shè)計(jì) Yii 框架的 query builder ，我們把一致性作為一個(gè)指導(dǎo)標(biāo)準(zhǔn)。查詢構(gòu)建器（query builder）允許您以編程方式創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)無關(guān)的 SQL 語(yǔ)句，避免 SQL 注入攻擊。為了幫助用戶更容易地記住它的 API ,我們介紹了鏈?zhǔn)浇涌诤兔笙鄳?yīng)的 SQL 關(guān)鍵字的方法。下面的代碼片段顯示了如何使用 SQL 語(yǔ)句查詢構(gòu)建器設(shè)計(jì)。

(new Query())
    ->select("id, email")
    ->from("user")
    ->orderBy("last_name, first_name")
    ->limit(10)
    ->all();

上面的代碼將生成和執(zhí)行 MySQL 聲明如下:

SELECT `id`, `email`FROM `user`ORDER BY `last_name`, `first_name`LIMIT 10

正如您可以看到的，代碼讀取非常類似于你編寫 SQL 語(yǔ)句。查詢構(gòu)建器之間的一致性和 SQL 語(yǔ)法很容易學(xué)習(xí)查詢生成器。

關(guān)于編寫自己的代碼顯式大于隱式，避免過多的使用 “自動(dòng)魔法”，有兩個(gè)原因堅(jiān)持這種哲學(xué)。首先，顯示的代碼更容易理解和維護(hù)。由于代碼是自解釋的，維護(hù)人員可能不是代碼的原作者，不需要來回跳轉(zhuǎn)找到實(shí)際上執(zhí)行的代碼。其次，顯示的代碼不容易出錯(cuò)。雖然顯示的可能需要編寫更多的代碼行，它減少了看似簡(jiǎn)單含蓄確籠罩著重要的代碼的情況。

看看下面的兩個(gè) ORM (對(duì)象關(guān)系映射) 在 PHP 的代碼。他們都希望實(shí)現(xiàn)『訂單』數(shù)據(jù)庫(kù)記錄和『客戶』DB 記錄之間建立外鍵引用約束的相同的目標(biāo)。

$order->link("customer", $customer);

與

$order->customer = $customer;

第一個(gè)版本是正常的方法調(diào)用。第二個(gè)版本看起來更酷，因?yàn)閺?fù)雜的數(shù)據(jù)庫(kù)連接操作可以通過一個(gè)看似簡(jiǎn)單的任務(wù)來完成。然而，這是一種錯(cuò)覺，第二個(gè)版本的簡(jiǎn)單性是由其他地方的的復(fù)雜性隱藏掩蓋。例如，用戶不得不通過某種形式的文檔來學(xué)習(xí)這種特殊的賦值語(yǔ)法，以便在實(shí)踐中使用它。因?yàn)殒溄硬僮骺雌饋硐褚粋€(gè)正常分配時(shí)，用戶可能會(huì)忘記處理由它引起的潛在的異常，從而導(dǎo)致整個(gè)程序發(fā)生故障。

事實(shí)上，Yii 的發(fā)展過程中，關(guān)于兩個(gè)版本我們討論了很多，并最終選定了第一個(gè)版本，它已收到投訴很少。

約定大于配置的概念已經(jīng)存在好多年了。這個(gè)想法是一個(gè)框架應(yīng)該采取堅(jiān)持的公約，遵守約定同時(shí)仍然允許通過配置提高擴(kuò)展性。決策的目標(biāo)是減少開發(fā)人員需要做的數(shù)目，從而實(shí)現(xiàn)哲學(xué)# 1——簡(jiǎn)單性。

約定大于配置最早在 Ruby on Rails 框架中開始流行。Rails 提供一個(gè) ActiveRecord 庫(kù)，用類和數(shù)據(jù)庫(kù)中的表之間的映射處理。按照慣例，表名是類名的多元化形式。因此，該類賬戶將有一個(gè)表稱為帳戶。如果該表不命名這種方式，用戶將必須顯式配置類名和表名稱之間的映射關(guān)系。

許多 MVC 框架使用約定大于配置請(qǐng)求路由到特定的代碼片斷。如下圖所示,Sails.js framework 框架使用的約定，其中的 /we/say/hi URL請(qǐng)求將被路由到controllers/we目錄下 SayController 控制器類的hi 動(dòng)作。按照本約定，開發(fā)人員不再需要對(duì)控制器的行為定義路由規(guī)則。但是，如果開發(fā)人員想要使用一個(gè)不同的路由規(guī)則，他們?nèi)匀豢梢酝ㄟ^顯式綁定一個(gè)路由到一個(gè)控制器動(dòng)作。

約定優(yōu)于配置有助于減少需要編寫的代碼量。然而，它會(huì)給開發(fā)人員需要遵守規(guī)則引入了額外的成本。同時(shí)，也往往與前面討論的『顯示大于隱式』的哲學(xué)相沖突。事實(shí)上，雖然早期版本的 Spring 框架使用了似的 Sails.js 路由約定，Spring 現(xiàn)在要求開發(fā)者通過注釋明確指定映射。因此，當(dāng)決定是否引入新的規(guī)則以支持約定大于配置，應(yīng)采取明智的判斷。

建設(shè)一個(gè)成功的框架是所有關(guān)于功能和簡(jiǎn)潔性之間的平衡。整個(gè)構(gòu)建框架的過程中，取舍經(jīng)常需要以堅(jiān)守，并舉例說明，上述哲學(xué)加以考慮。

有時(shí)候，你可能會(huì)遇到其中一個(gè)理念是與另一個(gè)直接沖突的情況。一致性是比簡(jiǎn)單更重要？在約定比顯性更重要？在這種情況下，請(qǐng)記住，一個(gè)框架的最終目標(biāo)是簡(jiǎn)化開發(fā)人員的工作，并簡(jiǎn)化代碼的編寫進(jìn)程。因此，保持它的簡(jiǎn)單和直接。如果他們有明確性沖突，因?yàn)榍罢邥?huì)帶來隱藏的復(fù)雜性可以犧牲約定。同樣，如果堅(jiān)持一致性可以稍微違反嚴(yán)格會(huì)造成額外的并發(fā)癥。

Posted Dec 15, 2015 by...

Qiang Xue

軟件工程師LEAD、技術(shù)人員

首發(fā)地址：http://blog.forecho.com/successful-frame...