What’s API?

API的全稱是application programming interface。

而很多時候，程序開發(fā)者僅僅把函數(shù)、類的接口做為API的一部分，而忽略了其他重要的編程接口。

事實上，在前端Javscript編程中常見的API包括：

• 函數(shù)、類接口，包括參數(shù)，返回值，函數(shù)對外部對象（常常是DOM）的具體操作等
• 網(wǎng)絡(luò)接口協(xié)議，如和后端交互的JSON、XML數(shù)據(jù)格式，或者script回調(diào)中的函數(shù)名
• 樣式以及HTML接口
• 外部依賴（對瀏覽器具體特性的依賴）
• 一些無意泄露的內(nèi)部實現(xiàn)

越往后的API，越隱晦，越不容易受到重視，但是一旦這些API發(fā)生變化，可能會導致調(diào)用方出現(xiàn)不符合預(yù)期甚至程序直接報錯的情況。

Why API cannot be changed?

API是程序協(xié)同開發(fā)的重要保證，API的用戶希望API的提供方提供的是一段功能明確、接口明了的程序。更重要的是，用戶更期望在程序升級以后，他們能夠“不經(jīng)思考”地升級這些第三方代碼。

一旦上述提到的5個API中的任何一個發(fā)生變化，可能會給他們帶來巨大的代價，用戶需要排查所有調(diào)用的代碼，需要更改一些協(xié)議，需要調(diào)整所有與之相關(guān)的部分，這些工作對他們來說都是額外的，在預(yù)期之外的。如果辛辛苦苦完成這些以后，還在測試過程中發(fā)現(xiàn)了相關(guān)的bug，那對用戶的打擊就更大了。

如果API經(jīng)常發(fā)生變化，用戶就會失去對這段程序的信任，他們會更傾向自己獲得源代碼以后，按照自己的需求進行修改，自行維護一個內(nèi)部的API比調(diào)用一個不斷發(fā)生變化的外部API要容易接受的多，雖然這樣做和我們協(xié)同開發(fā)、模塊化開發(fā)的初衷是完全相悖的。

最后，我們?yōu)槭裁匆薷腁PI呢？為了API看起來更加漂亮？為了提供更多有趣的功能？還是僅僅我們覺得到了改變了時候了？對于用戶來說，他們更愿意使用一個穩(wěn)定但是看起來不那么時髦的API，而不是使用一個很時髦，但是會經(jīng)常變動的API。在這個問題上，項目開發(fā)者是實用派。但這并不意味著我們不再改進API了，在后面，我會具體介紹如何能讓API保持穩(wěn)定的同時，讓API持續(xù)改進。

Quality of API

在正式說兼容性之前，首先要明確一下，什么是好的API，因為導致API的不兼容的根源總是來自一個想法：“期望通過這次改變把API變得更好”。

容易理解
如果一個API不能讓大多數(shù)使用者快速學會，這一定不是一個好的API。 比如iOS的滑動解鎖，老人和小孩都能都能一次解鎖，而Nokia的經(jīng)典兩鍵解鎖，你懂的。

一致性
一致性能大大降低用戶的學習和使用成本，用戶過去的努力學習，能持續(xù)的收效。

容易查找和學習
API必須要有文檔，并且介紹清晰，提供盡可能多的示例和可copy－paste的代碼，降低用戶的使用門檻。

提供簡單的方案
API要能解決復雜的問題，提供很多可配置項，但是對于那些最常見的case，如果有一個簡單的方案供給用戶使用，這樣能大大提高API的可用性

保護用戶在API上的已有工作
用戶過去在調(diào)用API、基于API開發(fā)所做的工作，這樣才能給用戶帶來價值的同時，不破壞他們過去的勞動成果。

如何保證API的兼容

采用良好的設(shè)計思路

在設(shè)計過程中，如果能按照下面的方式來進行設(shè)計，會讓這個API生命更長久

• 面向用例的設(shè)計，收集用戶建議，把自己模擬成用戶，保證API設(shè)計的易用和合理
• 保證后續(xù)的需求可以通過擴展的形式完成
• 第一版做盡量少的內(nèi)容，由畫冊設(shè)計公司于新需求可以通過擴展的形式完成，因此盡量少做事情是抑制API設(shè)計錯誤的一個有效方案
• 對外提供清晰的API和文檔規(guī)范，避免用戶錯誤的使用API，尤其是避免API（見第一節(jié)）靠后級別的API被用戶知曉與誤用

除此之外，下面還列出了一些具體的設(shè)計方法：

• 方法優(yōu)于屬性
• 工廠方法優(yōu)于構(gòu)造函數(shù)
• 避免過多繼承
• 避免由于優(yōu)化或者復用代碼影響API
• 面向接口編程
• 擴展參數(shù)應(yīng)當是便利的
• 對組件進行合理定位，確定暴露多少接口
• 提供擴展點

有效的API評審

API設(shè)計完成以后，需要經(jīng)過周密的設(shè)計評審，評審的重點如下：

• 用例驅(qū)動，評審前必須提供完善的使用用例，確保用例的合理性和完備性。
• 一致性，是否與系統(tǒng)中其他模塊的接口風格一致，是否與對稱接口的設(shè)計一致。
• 簡單明了，API應(yīng)該簡單好理解，容易學習和使用的API才不容易被誤用，給我們帶來更多的麻煩。
• API盡可能少，如果一個API可以暴露也可以不暴露，那么就不要暴露他，等到用戶真正有需求的時候再將它成為一個公開接口也不遲。
• 支持持續(xù)改進，API是否能夠方便地通過擴展的方式增加功能和優(yōu)化。

把握API的生命周期

每一個API都是有生命周期的，我們需要讓API的生命周期更長，并且在API的生命周期結(jié)束時能讓其平滑的消亡。

• 告訴用戶我們是如何設(shè)計的畫冊設(shè)計公司，避免誤用，提供指導，錯誤的使用往往是縮短API壽命的一大殺手
• 提供試用期，API不可能一開始就是穩(wěn)定，經(jīng)過試用的API才能有更強的生命力
• 為API分級：內(nèi)部使用；二次開發(fā)使用；開發(fā)或試用中；穩(wěn)定；棄用API。避免API被濫用的同時，我們可以通過調(diào)整API的級別，來擴大其影響力，也能更優(yōu)雅的結(jié)束一個API的生命周期。

保持API的逐步改善

過去我們總希望能將現(xiàn)有的“不合理”的設(shè)計完全推翻，然后按照現(xiàn)在“美好”的思路，重新設(shè)計這個API，但是在一段時間以后，又會碰到一樣的狀況，需要再推翻一次。 如果我們沒有有效的逐步改善的辦法，依靠推翻現(xiàn)有設(shè)計，重新設(shè)計API只能讓我們回到起點，然后重現(xiàn)之前的過程。 要有一套行之有效的持續(xù)改善的辦法來在API兼容的同時，改善API使之更好。

提高API的可測試性

API需要是可測試的，測試不應(yīng)依賴實現(xiàn)，測試充分的API，尤其是經(jīng)過了嚴格的“兼容性整合測試”（見下文）的API，更能保證在升級的過程中不出現(xiàn)兼容性問題。

兼容性整合測試，是指一組測試用例集合，這組測試用例會站在使用者的立場上使用API。在API升級以后，再檢測這組測試用例是否能完全符合預(yù)期的通過測試，盡可能的發(fā)現(xiàn)兼容性問題。

避免極端的意見

在設(shè)計API的時候，一定要避免任何極端的意見，尤其是以下幾點：

• 必須漂亮（API一定要漂亮嗎？前文已經(jīng)說過了）
• API必須被正確地使用（用戶很難理解如何正確的使用API，API的設(shè)計者要充分考慮API被誤用的情況：如果一個API可能會被誤用，那么它一定會被誤用）
• 必須簡單（我們總會面臨復雜的需求，能兩者兼顧的API是更好的API）
• 必須高性能（性能可以通過其他手段優(yōu)化，不應(yīng)該影響API的設(shè)計）
• 必須絕對兼容（盡管本文一直提到如何保證兼容，但是我們?nèi)匀灰庾R到，一些極少情況下會遇到的不兼容是可以容忍的）

一些具體的實施方案

在一個API不可避免要消亡或者改變的時候，畫冊設(shè)計公司我們應(yīng)該接受并且面對這個事實，下面列舉了幾種保證兼容性的前提下，對API進行調(diào)整的辦法：

• 將API標記為棄用，重新建立一個新的API。如果一個API不可避免要被消亡，這是唯一的辦法。
• 為其添加額外的參數(shù)或者參數(shù)選項來實現(xiàn)功能添加
• 將現(xiàn)有API拆成兩部分，提供一個精簡的核心API，過去的API通過封裝核心API上實現(xiàn)。這通常用于解決用戶需要一個代碼精簡的版本時。
• 在現(xiàn)有的API基礎(chǔ)上進行封裝，