為什麼使用 Java 的 API 文檔

首先要先知道 Java 的 API 文檔是什麼？對於 API 文檔來說， 主要是為了讓開發者可以方便的查閱 Java 相關的應用程序接口。根據提供的接口進行開發編程。說白了就是解脫我們暫時記不住知識點的初級開發者。當你熟悉之後還會使用 API 文檔的內容， 但是方式會有很多差別。

本系列教程主要是基於 Java 17 的版本， JDK 17 對應的文檔地址就是， 對於 Java 的 API 文檔， 一般默認說的是Java SE。

官方文檔地址：
https://docs.oracle.com/en/java/javase/17/

官方 API 地址：
https://docs.oracle.com/en/java/javase/17/docs/api/index.html

這個是在線的文檔地址。 除了在線瀏覽的途徑， 還可以支持下載到本地。 使用離線文檔， 這樣的話， 對於我們開發和學習比較友好。 畢竟外網總會有那麼一點慢慢的，卡卡的。

離線下載地址為：
https://www.oracle.com/java/technologies/javase-jdk17-doc-downloads.html

點擊 Download

進行下載離線版本。

解壓之後， 可以看到文檔詳細內容。 進入到 docs 目錄。 index.html 就是文檔主頁。 直接用瀏覽器打開就好了。

打開之後的效果， 和上面在線的 API 文檔是一致的。推薦使用該方式進行查看 API。用於開發和調試。

我們學習的時候， 不可能是從 API 文檔的最頂部往下學習。 這樣學習的效率太低。 就相當於你要背單詞從 abandon 開始。然後再也走不出去。

從 JDK 9 開始，JDK 都是模塊化的工程。 所以 Java 開發者就根據功能而已進行了模塊化的劃分。

學習任何一個技術， 首先就是要看技術的相關介紹， 並且是大局觀的介紹。 只有這樣你才能知道這個技術是什麼， 能做什麼， 能做成什麼樣。 看文檔也是。

我們簡單的翻譯一下文檔：

一開始說了本文檔主要包含兩部分的內容。

一部分是 Java SE，另一個部分是：JDK

Java SE

Java 平台標準版 (Java SE) API 定義了用於通用計算的核心 Java 平台。 這些 API 位於名稱以 java 開頭的模塊中。

Java SE 主要包含以下模塊：

JDK

Java 開發工具包 (JDK) API 特定於 JDK，需要注意的是該模塊不一定在 Java SE 平台的所有實現中都可用。也就是說不同版本的 JDK 針對這些模塊接口實現是不一致的。使用的時候需要注意。 這些 API 位於名稱以 jdk 開頭的模塊中。

JDK 主要包含以下模塊：

除了這兩部分， 還有一部分是只有一個內容就是和智能卡相關的。

需要注意的是：當前描述適用於 JDK 11+ 的版本。 主要以 JDK 17 的版本進行講解描述。

上面說了這麼多， 都是以大局觀的方面講的。 因為還沒有接觸很多知識點。 所以在後期會在講解到某個具體的知識點的時候， 進行詳細說明。

在沒有模塊化之前， JDK 下面緊跟着的就是 package。有了模塊化以後，目錄結構就是先是 module， 接着是 package。 然後才是 package 下的某個具體的類。具體如何使用模塊化， 後續會有具體的章節進行講解。 這裡先不再展開。一鍵… 咳咳咳。繼續， 繼續。

幾種檢索方式：

index: 這裡可以查看指定字符開頭的類和接口。

如果想看所有的。 可以使用 All Classes and Interfaces 。

打開之後的頁面為：

這個時候， 可以通過右側的 search 進行搜索。 如果只記得某個類的開頭， 或者其中一部分。 可以使用這個快速的定位到你需要的內容上。

我們看一下之前錯誤的提示異常類。 NoClassDefFoundError

從這可以看到他是在 java.lang 的下面。 並且 java.lang 是在 java.base 的模塊下， 一次記不住沒關係， 多看多練幾次就熟能生巧了。

裏面有詳細的說明信息， 因為一個新技術出現肯定是自己官方的語言。 所以中文版的，就要等等了。 或者你也來參與一下？ 翻譯一下這些知識的中文版本。 也算是一個技術輸出了吧？英文不好也可能使用翻譯工具進行查閱。 看多了， 雖然不會讀， 也能看懂了。

可以看到這個類從 1.0 版本就存在了。

並且有對應的詳細說明：

如果 Java 虛擬機或 ClassLoader 實例嘗試加載類的定義（作為正常方法調用的一部分或作為使用 new 表達式創建新實例的一部分）並且找不到類的定義，則拋出該異常。 編譯當前正在執行的類時，搜索到的類定義存在，但無法找到該定義也會拋出該異常。 這就是初學者未使用 IDE 之前經常會出現的一個問題。

文檔的使用就暫時搞一段落。後續具體的知識點在進行學習查看。 關注我。 後續更多全棧的內容。