GroovyHelp簡介

GroovyHelp前世今生
  GroovyHelp的雛形最早設計并開發于2007年年初，記得那時的我還在eBay實習，工作比較舒心，就利用閑暇時間開發了GroovyHelp的第一個版本，該版本相對比較初級，因為它只能將API信息抽取出來，而無法分門別類（比如類、接口、方法、構造方法等）。在2007年到2010年，期間斷斷續續開發了幾個版本，也增加了不少功能，并增強了原有功能（比如支持對API信息進行分類），可惜這些版本的性能和易用性方面都不太好。終于在2011年年初決定將其完全重寫，GroovyHelp3就此誕生了，它包含了這些年開發GroovyHelp時汲取的經驗和教訓，猶如神鳥鳳凰般浴火重生。無論是在性能、易用性、健壯性方面，還是功能多樣性方面都有了長足的進步。更新此文時，GroovyHelp的最新版本是GroovyHelp 3.3.0 GA。

GroovyHelp主要特性

GroovyHelp的安裝和使用
  1，從GroovyHelp項目主頁上下載最新穩定版本到本地（壓縮包的命名規則是：groovyhelp-版本號-(ea|rc|ga)_構建日期編號.zip）
  2，解壓groovyhelp-X.X.X-XX_yyyyMMddXX.zip，注意：解壓路徑中不要有中文和空格。


  3，設置GROOVYHELP_JAVA_HOME環境變量，將其值賦為Oracle JDK/JRE 1.6.0u10+所在路徑（比如：D:\_DEV\Java\jdk1.6.0）。如果在機器上沒有相關JDK/JRE，可以到GroovyHelp下載頁面下載相應的JDK/JRE。注：如果不設置GROOVYHELP_JAVA_HOME環境變量，那么將使用系統默認的JRE，可能不是GroovyHelp所需要，會導致GroovyHelp無法正常使用。


  4，雙擊執行groovyhelp.exe（用于Windows）或groovyhelp（用于Linux和Mac OS，執行之前需通過“chmod 555 groovyhelp”修改其訪問權限），啟動后界面如下所示：


  5，添加API文檔（本地的或在線的均可）
    5.1，點擊菜單Docs -> Manage Docs，顯示如下界面：


    5.2，點擊上述界面中的“Add”，顯示如下界面：


    5.3，在上述界面中輸入“Doc Name”（文檔名稱）、“Doc Home”（API文檔所在路徑(壓縮包或文件夾均可)，或在線文檔的index.html頁面的url，比如http://jexcelapi.sourceforge.net/resources/javadocs/2_6_10/docs/index.html。如果http://jexcelapi.sourceforge.net/resources/javadocs/2_6_10/docs/可跳轉至index.html頁面，則輸入http://jexcelapi.sourceforge.net/resources/javadocs/2_6_10/docs/亦可）、而“Src Home”（源碼路徑(壓縮包或文件夾均可)）是可選的。最后點擊“Finish”按鈕對AIP文檔創建索引（如果是在線文檔則還會有下載文檔這一過程）。注：如果對在線文件創建索引，則會遇到某些大頁面（1M~2M）下載速度比較慢現象，請耐心等待，等待時間長短決定于頁面文件大小及帶寬。而創建索引時CPU使用率保持在95%~100%屬正?，F象，該過程比較耗資源。
      a，為本地文檔創建索引：


      b，為在線文檔創建索引（下圖所示的是下載過程）：


    5.4，索引創建完畢之后，顯示如下界面（順便提一下，通過點擊以下界面中的“Enabled”一列中的復選框可“啟用”或“停用”API文檔，這是出于性能方面的考慮，建議不要同時啟用超過5份API文檔）。


  6，點擊上述界面中“Close”按鈕，關閉該對話框顯示以下界面，開始使用API文檔：


    6.1，“單擊”文檔樹中的API信息節點查看相關內容：


    6.2，如果設置了“Src Home”，則還可以通過點擊瀏覽器中的“J”圖標按鈕查看相關源碼：


    6.3，如果對API信息之外的內容感興趣，可以點擊“Resource” TAB頁，查看其他資源信息：


    6.4，如果需要根據關鍵字搜索API信息，則可以點擊“Index” TAB頁，輸入API關鍵字（比如write），支持模糊搜索（?表示單個字符，*表示多個字符），雙擊某個搜索結果項，顯示相關信息。如果與雙擊的搜索結果與多個API信息匹配，那么將顯示分類頁面。點擊分類頁面中的其中一項即可查看相關內容。（注：可以通過選中或取消“Scope”中的分類復選框以限定搜索范圍）


    6.5，點擊上述分類頁面中的某個鏈接，查看相關API信息：


    6.6，如果需要進行更寬泛的搜索（不僅限于API信息），則可以點擊“Search” TAB頁面，輸入關鍵字，回車或點擊搜索按鈕進行搜索，支持模糊搜索（?表示單個字符，*表示多個字符），雙擊搜索結果項查看相關信息（頁面中高亮部分便是關鍵字指定內容）：


    6.7，有時對某些Java API的用法不太熟悉，可以點擊“Examples” TAB頁，雙擊某個包，點擊相關鏈接查看相應用法實例：


    6.8，如果需要比較兩個版本API文檔的差異，可以通過點擊“Tools” -> “Compare Docs”，顯示如下對話框。選擇比較的兩個文檔以及比較范圍，點擊“Compare”按鈕進行比較，點擊各個API信息節點(+)查看變化內容：
      a，設置API文檔比較對象及范圍

      b，點擊各個節點查看變化內容


    6.9，如果覺得頁面字體比較小，可以通過主界面右下角的調節器進行調整（雙擊可復位默認值100%），該功能自3.2.7 GA版本開始移至“Tools”：



GroovyHelp的版本升級
  1，訪問GroovyHelp項目首頁下載最新版本的GroovyHelp。
  2，刪除老版本GroovyHelp所在目錄下除“idx文件夾”以及“用戶自己的文件或文件夾（比如一些放置在GroovyHelp所在目錄下的docs文件）”外的所有文件和文件夾。
  3，將新版本GroovyHelp壓縮包解壓到老版本所在目錄。
  4，升級完畢
注：升級后第一次啟動會比較緩慢，請耐心等待。

GroovyHelp使用技巧
  1，使用快捷鍵關閉或切換TAB頁。ctrl+w關閉當前TAB頁，ctrl+q關閉所有TAB頁，ctrl+e關閉除當前TAB頁外的其他TAB頁，ctrl+Tab切換TAB頁。
  2，如果GroovyHelp需要在多處使用，比如想通過移動硬盤在多臺電腦里使用GroovyHelp，但又不想一遍又一遍為API文檔創建索引，那么可以在GroovyHelp的解壓目錄下新建docs目錄，并將文檔放置其中。以后即使GroovyHelp整個解壓文件夾被移動，也不會影響對API文檔的使用。
  3，如果發現索引文件越來越大，可以通過點擊選中“Tools” -> “Optimize Index Before Exit”菜單項，在退出應用前，對索引文件進行壓縮優化，使其大小大幅減小。注：該優化操作可能需要幾分鐘才能完成，所以不建議頻繁優化。
  4，在Windows系統下，定期做一下磁盤整理。

GroovyHelp常見問題 
  1，對于在Windows 7(x64)下使用64位JVM無法正常運行GroovyHelp的朋友，建議使用32位JVM，這是由于GroovyHelp所依賴的個別組件對64位JVM支持得不太好 
  2，在Mac OS X下，時常出現打開頁面或關閉頁面時JVM崩潰的情況，這是因為GroovyHelp所依賴的個別組件對Mac OS X支持得很不好，所以建議通過設置GROOVYHELP_JAVAFX_HOME環境變量以啟用JFX瀏覽器，而自JDK1.7.0u04開始，Oracle官方JDK開始支持Mac OS X，并自帶了JavaFX SDK，則無需設置該環境變量。在Mac OS X 下，推薦使用Oracle官方JDK1.7.0u4+ （比如JDK1.7.0u05）

結束語
  相信目前GroovyHelp的這些功能足以應對API信息的各類查閱需求，如果發現什么BUG或有些什么好的建議可以通過GroovyHelp的Issues頁面或博客留言反饋。如果您使用的是GroovyHelp 3.2.0 GA以前版本，可以參考《JAVA程序員幫助文檔查看利器：GroovyHelp》。