您當前位置：首頁 > 互聯網 > Google首席軟件工程師Joshua Bloch談如何設計一款優秀的API【附PPT】

Google首席軟件工程師Joshua Bloch談如何設計一款優秀的API【附PPT】

來源：程序員人生發布時間：2014-09-07 02:29:28 閱讀次數：2245次

【編者按】隨著近來軟件規模的日益龐大，API編程接口的設計變的越來越重要。良好的接口設計可以降低系統各部分之間的相互依賴，提高組成單元的內聚性，降低組成單元間的耦合度，從而提高系統的維護性和穩定性。

Joshua Bloch是美國著名程序式設計師。他為Java平臺設計并實現了許多的功能，是Google的首席Java架構師（Chief Java Architect）。他也是《Effective Java Programming Language Guide》一書的作者，就是人們常說的Effective Java。本文翻譯自Joshua Bloch所發表的一個PPT： How to Design a Good API and Why it Matters。

隨著大數據、公共平臺等互聯網技術的日益成熟，API接口的重要性日益凸顯，從公司的角度來看，API可以算作是公司一筆巨大的資產，公共API可以捕獲用戶、為公司做出許多貢獻。對于個人來說，只要你編程，你就是一個API設計者，因為好的代碼即是模塊――每個模塊便是一個API，而好的模塊會被多次使用。此外，編寫API還有利于開發者提高代碼質量，提高自身的編碼水平。

優秀API所具備的特征

簡單易學；
易于使用，即使沒有文檔；
很難誤用；
易于閱讀，代碼易于維護；
足夠強大，可以滿足需求；
易于擴展；
適合用戶。

了解了一款優秀API所具備的特征后，一起再來看看如何設計優秀的API，有哪些流程和規則可循，開發者在設計時需要注意哪些事項。

API設計流程中的注意事項

征集需求

在開始之前，你可能會收到一些解決方案，它們不一定會比現有的方案好，而你的任務是以用例的形式提取真實需求，并制定真正合適的解決方案，這樣構建出來的東西就會更加有價值。

從簡短的說明開始

這時，編寫簡短的說明最為合適，編寫時需要考慮的因素有：

靈活性要遠勝于完整性；
跳出規則：聽取意見并嚴陣以待；
精煉短小才易修改；
獲得信任之后將其具體化，在此之中，編程很重要。

盡早編寫API

對每一個實現進行保存，以防丟失；
在開始之前，列出一些合理的規定，保存所寫說明，以防丟失；
繼續編寫和充實API。

編寫SPI尤為重要

Service Provider Interface即服務提供商接口，插件服務支持多種實現，例如Java Cryptography Extension (JCE)；
發布之前編寫多個插件；
“三次原則”（“The Rule of Threes”）：指的是當某個功能第三次出現時，才進行"抽象化"。

維護切實可行的期望

大多數API設計都過于約束；
對可能會犯的錯誤進行預計，要用發展的思維來編寫API。

API設計原則

每個API接口應該只專注一件事，并做好：如果它很難命名，那么這或許是個不好的征兆，好的名稱可以驅動開發、并且只需拆分與合并模塊即可

API應盡可能地輕小：滿足需求、對有疑問的地方可以暫時不使用（函數、類、方法、參數等，你可以不添加，但千萬不要刪除）、概念性的東西比體積重要、尋找一個良好的動力體積比；
實現不要影響API：關注實現細節（不要迷惑用戶、不要隨便改變實現方式）、意識到具體的實現細節（不要有越權的方法行為，例如不要制訂哈希函數、所有的調優參數都是可疑的）；
不要讓實現細節“泄露”到API（例如on-disk和on-the-wire格式等異常情況）；
最小化可訪問：設計人員應盡量把類及成員設為私有，公共類不應該有公共字段（包括異常實例），最大限度地提高信息隱藏，允許模塊可以被使用、理解、構建、測試和獨立調試；
命名問題：應該見名知意，避免含糊的縮寫、對同一樣東西的命名應該有個一致性的前綴（遍及整個平臺API）、講究對稱、代碼應該易讀。如下所示：

if (car.speed() > 2 * SPEED_LIMIT)
 generateAlert("Watch out for cops!");

重視文檔

開發API時要意識到文檔的重要性。組件重用不是紙上談兵的東西，既需要好的設計，也需要優秀的文檔，這二者缺一不可，即使我們看到了良好的設計而未見文檔，那么組件重用也是不妥的。

――摘自 D. L. Parnas 在1994年第16屆國際軟件開發大會上的演講內容

文檔應包含每個類、接口、方法、構造函數、參數和異常，此外，還要小心對待文檔的狀態空間。

API設計決策對性能的影響

API設計決策對性能的影響是真實永久的；
不好的決策會限制性能（類型易變、構造函數替代靜態工廠、實現類型替代接口）；
不得打包API來提升性能（潛在的性能問題可能會得到修復，但救的了一時，救不了一世）；
良好的設計通常與好的性能是一致的。

API與平臺和平共處

養成良好的習慣：遵守標準的命名約定、避免陳舊的參數和返回類型、核心API和語言的模仿模式；
利用API的友好功能：泛型、可變參數、枚舉、默認參數；
了解和避免API陷阱和缺陷：Finalizers、公共靜態Final數組。

API中類的設計

最小化可變性

最好不要隨便改變類，除非有一個非常合理的理由；
如果是可變類，最好保持很小的狀態空間、定義良好的結構，因時制宜地去調用方法。

子類只存在有意義的地方

子類具備可替代性（Liskov）；
公共類不應該繼承其它公共類。

用于繼承的設計和文檔或者直接禁止繼承（Design and Document for Inheritance or Else Prohibit it）

繼承破壞封裝
如果你允許子類和文檔自用，那么要考慮彼此該如何互相調用方法
保守策略：把所有類都設置成Final

API中的方法設計

模塊能做到的，客戶端就不要做

減少模板代碼的使用：

import org.w3c.dom.*;
 import java.io.*;
 import javax.xml.transform.*;
 import javax.xml.transform.dom.*;
 import javax.xml.transform.stream.*;
 // DOM code to write an XML document to a specified output stream.
 private static final void writeDoc(Document doc, OutputStream out)throws IOException{
 try {
 Transformer t = TransformerFactory.newInstance().newTransformer();
 t.setOutputProperty(OutputKeys.DOCTYPE_SYSTEM, doc.getDoctype().getSystemId());
 t.transform(new DOMSource(doc), new StreamResult(out));
 } catch(TransformerException e) {
 throw new AssertionError(e); // Can’t happen!
 }
 }

遵守最小驚訝原則

用戶API只需根據需求來設計即可，不必讓客戶感到驚訝，小心弄巧成拙：

public class Thread implements Runnable {
 // Tests whether current thread has been interrupted.
 // Clears the interrupted status of current thread.
 public static boolean interrupted();
 }

日本搞逼视频_黄色一级片免费在线观看_色99久久_性明星video另类hd_欧美77_综合在线视频

Google首席軟件工程師Joshua Bloch談如何設計一款優秀的API【附PPT】