代碼格式化插件jalopy Jalopy在Eclipse下的使用

surpass_li

Jalopy 是為Java編程語言提供的一個源代碼格式化/美化/漂亮的開源項目，它旨在提供一個功能完整的，而且是免費的可以取代著名的Jindent的產(chǎn)品。并為 Ant, Eclipse, IDEA, JBuilder, JDeveloper, jEdit, NetBeans提供了插件



Table of Contents

2. 使用
3. 配置
4. 配置方法

    4.1. 大括號
    4.2. 空格
    4.3. 縮進
    4.4. 每行的折疊
    4.5. 空白行
    4.6. 注釋
    4.7. import
    4.8. 環(huán)境變量
    4.9. javadoc
    4.10. 文件頭
    4.11. 文件尾
    4.12. 對成員排序
    4.13. 雜項

5. 代碼檢查功能
6. 顯示消息的級別
參考書目

Jalopy是一款代碼美化工具。它可以把胡亂無章的代碼重新排版，變的好看整潔。使用簡單。雖然目前停止了更新，推出了商業(yè)化的版本， 但Jalopy仍然是免費的。

Jalopy包含多種插件, Ant 的，Eclipse的，JBuilder的等等。本文介紹的只是Eclipse下的插件。您可以在 Jalopy主頁找到所有相關(guān)的資源。
1. 下載和安裝Eclipse plugin v 0.1-1.5rc1

截止到2008-03-06，可以在這里下載：

安裝很簡單，可以參考這篇文章： Eclipse基礎(chǔ)－－使用links方式安裝Eclipse插件。

運行Eclipse之后，打開任意一個java文件，右鍵菜單中如果出現(xiàn)"Format with Jalopy"選項，說明安裝成功。 如Figure 1, “安裝成功后編輯器中的右鍵菜單”所示。
安裝成功后編輯器中的右鍵菜單

Figure 1. 安裝成功后編輯器中的右鍵菜單
2. 使用3. 配置Figure 2, “Jalopy的屬性配置按鈕”所示。

可以格式化一個文件，一個文件夾，或者整個項目。

    *

      格式化一個文件：在任何打開的java文件中點右鍵，在彈出的菜單中，選擇"Format with Jalopy"。
    *

      格式化一個文件夾：在任何java文件夾(package)點右鍵，在彈出的菜單中，選擇"Format Folder"或"Format Package"。
    *

      格式化一個項目：在任何java項目點右鍵，在彈出的菜單中，選擇"Format Project"。

在Eclipse中進行Jalopy配置也很容易，先用左鍵點"package Explorer"或"Navigator"，然后點最上面那一行的"Window"->"Jalopy Preferences..." 如
Jalopy的屬性配置按鈕

Figure 2. Jalopy的屬性配置按鈕
Figure 3, “"rojects"的內(nèi)容”所示。圖中，自定義了一個新的項目："my_own"，并將它激活。
[Caution]         注意

一定要先點一下"Navigator"或者"ackage Explorer"，否則在java編輯器中，"Window"菜單中不會出現(xiàn)"Jalopy Preferences..."

在Jalopy中，每個配置文件都是以一個"project"來命名的。打開Jalopy控制面板后，在左邊選項列表中選擇"rojects"，就可以看到當(dāng)前 擁有的Project列表�？梢允褂�"Add..." , "Remove" 來增加或刪除項目。想使用哪個項目（也就是使用哪個配置），就選中它，然后點"Activate"按鈕。如
&quotrojects"的內(nèi)容

Figure 3. "rojects"的內(nèi)容
Figure 4, “"General"的內(nèi)容”所示。

然后進入到"General"窗口，修改您要為該項目起的名字和描述。這里的名字跟Project中的名字不同，它是可以變的。如
"General"的內(nèi)容

Figure 4. "General"的內(nèi)容
Figure 4, “"General"的內(nèi)容”中，有"import"和"export"兩個按鈕，前者是將已經(jīng)存在的配置導(dǎo)入進來，后者是將現(xiàn)在的這個配置導(dǎo)出成配置文件。 對于配置文件的切換與保存，都很方便。

完成上面兩步，就可以進行自己的配置了。 ：）

在

在導(dǎo)出成功后沒有提示。也許是個小瑕疵。
4. 配置方法4.1. 大括號

4.2. 空格
4.3. 縮進
4.4. 每行的折疊
4.5. 空白行
4.6. 注釋
4.7. import
4.8. 環(huán)境變量
4.9. javadoc
4.10. 文件頭
4.11. 文件尾
4.12. 對成員排序
4.13. 雜項

這些配置都在Jalopy配置窗口中左側(cè)的"rinter"下面。
4.1. 大括號Figure 5, “大括號的雜項的配置圖解”所示。

也就是"{"和"}"。在"Braces"的General中，選擇"Sun Java style"就可以了。

對于"Misc"的說明， 如
大括號的雜項的配置圖解

Figure 5. 大括號的雜項的配置圖解
4.2. 空格Figure 6, “空格的配置圖解”所示。

本節(jié)的具體配置如 如
空格的配置圖解

Figure 6. 空格的配置圖解
4.3. 縮進Figure 7, “縮進的主要配置圖解”所示。

分成主要配置和雜項兩種。

主要配置 如
縮進的主要配置圖解

Figure 7. 縮進的主要配置圖解
Figure 8, “縮進的雜項配置圖解”所示。

雜項配置 如
縮進的雜項配置圖解

Figure 8. 縮進的雜項配置圖解
4.4. 每行的折疊Figure 9, “每行的折疊配置圖解”所示。

這里使用默認的就可以了。由于內(nèi)容過于羅嗦，有需要的朋友去看英文文檔吧。 如
每行的折疊配置圖解

Figure 9. 每行的折疊配置圖解
4.5. 空白行Figure 10, “空白行的主要配置圖解”所示。

主要配置使用默認的就可以了。由于內(nèi)容過于羅嗦，有需要的朋友去看英文文檔吧。基本每個不同的元素都空一行。 如
空白行的主要配置圖解

Figure 10. 空白行的主要配置圖解
Figure 11, “空白行的雜項配置圖解”所示。

雜項配置這里使用默認的就可以了。 如
空白行的雜項配置圖解

Figure 11. 空白行的雜項配置圖解
Figure 12, “空白行的注釋相關(guān)配置圖解”所示。

對于注釋相關(guān)的配置這里使用默認的就可以了。 如
空白行的注釋相關(guān)配置圖解

Figure 12. 空白行的注釋相關(guān)配置圖解
Figure 12, “空白行的注釋相關(guān)配置圖解”的窗口高度拉大一些，還能看到窗口下面的 "Fill Character"，可以按照你的喜好來選擇，是使用"-","=", "*", "/" 等不同的填充符號。

如果開啟了"Add separator comments"，那么你的代碼會被格式化成這樣：

//~ Static fields ------------------------------------------------------------
public static final String HELLO ="hello";
//~ Instance fields ----------------------------------------------------------
private int someVariable;
//~ Methods ------------------------------------------------------------------
public String getMethod(){
......
}
                       

如果把

如同我們在很多開源項目中看到的這樣。但是在國內(nèi)用起來是否合適還不得而知。默認是不格式化。
4.6. 注釋Figure 13, “注釋的配置圖解”所示。

可以刪掉（增加注釋在。。。）或格式化特定的注釋。建議不要使用。如
注釋的配置圖解

Figure 13. 注釋的配置圖解
4.7. importFigure 14, “imports的配置圖解”所示。

可以對import進行排序，組合成*號的風(fēng)格，或者拆分成獨立的多個import風(fēng)格。 其中排序時的深度可以指定。如
imports的配置圖解

Figure 14. imports的配置圖解
4.8. 環(huán)境變量Figure 15, “定義環(huán)境變量”所示。

排序深度指的是，package從左到右第幾個"."前的名字。如深度是1的排序:

import java.awt.Color;
import java.awt.Component;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.List;               
               

深度是2的排序：

import java.awt.Color;
import java.awt.Component;
import java.awt.event.ActionListener;

import java.util.ArrayList;
import java.util.List;                               
                       

深度是3的排序：

import java.awt.Color;
import java.awt.Component;

import java.awt.event.ActionListener;

import java.util.ArrayList;
import java.util.List;               
                       

可以增加Jalopy能識別的環(huán)境變量，然后在"format"的時候?qū)⑺�賦值。，如
定義環(huán)境變量

Figure 15. 定義環(huán)境變量
Table 1, “Jalopy的內(nèi)置變量列表”所示。

該作用用處不太大。建議使用Eclipse，我一般在它的代碼模板定義變量。

"System"標簽中的變量是系統(tǒng)變量，改不了。

另外，Jalopy也有內(nèi)置變量，它們是在程序運行時自動獲得， 如

Table 1. Jalopy的內(nèi)置變量列表

名稱
       

說明
       

例子

file
       

文件的完整文件名
       

/usr/projects/test/MyFile.java

fileName
       

文件名
       

MyFile.java

fileFormat
       

文件的內(nèi)容格式，跟操作系統(tǒng)相關(guān)
       

UNIX 或DOS

package
       

文件的package名
       

com.foo.package

convention
       

當(dāng)前使用的代碼風(fēng)格，在General中定義的。
       

my_own

tabSize
       

tab鍵的長度
       

4

objectType
       

類或接口的名稱，只能在javadoc中使用。
       

MyClass

paramType
       

參數(shù)的名稱，只能在javadoc中使用。
       

somePara

exceptionType
       

異常的名稱，只能在javadoc中使用。
       

NullPointerException
4.9. javadocFigure 16, “javadoc主要配置圖解”所示。只定義了對所有public型的類，方法等生成javadoc, 并且將javadoc和注釋中的特殊符號轉(zhuǎn)換成HTML脫離符。

包括概要配置，模板配置和自定義標簽配置。

概要配置，如
javadoc主要配置圖解

Figure 16. javadoc主要配置圖解
Figure 17, “javadoc模板配置圖解”所示。

模板配置可以對class, interface, method等內(nèi)容進行設(shè)置。其中$paramType$ 和 $exceptionType$ 是Jalopy內(nèi)置變量，不要改動。改"DOCUMENT ME!"那里就可以。，如
javadoc模板配置圖解

Figure 17. javadoc模板配置圖解
4.10. 文件頭Figure 18, “header主要配置圖解”所示。

自定義標簽配置基本沒必要用。

可以對文件頭（header）進行格式化，并且根據(jù)需要決定是否增加文件頭。，如
header主要配置圖解

Figure 18. header主要配置圖解
4.11. 文件尾Section 4.10, “文件頭”完全一樣。

在"Text"頁簽中，可以加入Header的具體內(nèi)容，也可以使用各種變量。

用法跟

沒見過使用文件尾的項目。-_-! 貌似沒意義。。。
4.12. 對成員排序Figure 19, “按聲明排序的配置圖解”所示。

可以對類的成員進行排序，根據(jù)聲明或關(guān)鍵字。兩者都很相似，下面以按聲明來排序為例子，，如
按聲明排序的配置圖解

Figure 19. 按聲明排序的配置圖解
4.13. 雜項Figure 20, “雜項的配置圖解”所示。

在"Modifier"頁簽中，與"Declarations"的使用方法一樣。

是否需要排序見人見智，請根據(jù)需要來使用。

都是比較雜的選項，，如
雜項的配置圖解

Figure 20. 雜項的配置圖解
5. 代碼檢查功能Figure 21, “不建議使用的功能”所示。

"Insert expression parenthesises" : 為稍微復(fù)雜的表達式增加圓括號。看情況用吧。因為有的公司約定不要使用必要的大括號，會被checkstyle檢查出來。 建議程序員自己控制。

"Insert serial verstion UID" : 繼承了java.io.Serializable的類，都需要聲明個uid, 可以這樣自動生成。我一般使用Eclipse來生成。

"Insert logging conditional" : 為log的輸出增加條件。這一點很有用。專業(yè)的log前面都需要加個條件，如：if(logger.isDebugEnabled()){ ... } 這樣可以提高效率，尤其是當(dāng)log中輸出的對象.toString()方法比較耗資源的時候。

在控制面板的"Code Inspector"中可以進行配置。其中在Tip 一欄中有19個提示，分別對應(yīng)官方文檔中引用《Effective Java》的19條建議。 如
不建議使用的功能

Figure 21. 不建議使用的功能
6. 顯示消息的級別參考書目
[Caution]         不建議使用

原因有：

   1.

      它只能檢查代碼，而不能修改。

      沒有實現(xiàn)重構(gòu)的功能，也沒有checkstyle的檢查那么好。 它的檢查結(jié)果只是在"roblems"窗口中以"Warning"的形式顯示出來。容易被忽視。
   2.

      貌似不起作用。當(dāng)我啟用代碼檢查功能時（在Code Inspector窗口中的"Enable Code Inspector"前面打勾），卻無法檢查出對應(yīng)的錯誤。包括：命名不合規(guī)則。另外19個Tips給出的錯誤與官方文檔的不符。（如16跟17好象弄混了？而且官方的資料中這里應(yīng)該有20個提示的選項……）
   3.

      有了eclipse的自動重構(gòu)功能和checkstyle的檢查功能，沒必要用它。

      重構(gòu)時修改函數(shù)名，變量名，需要一步一步的來，用代碼格式化工具來實現(xiàn)重構(gòu)，不太合適。雖然想法很好。



在配置面板的"Messages"中可以進行配置。

使用默認的就好了。不要修改它。建議都是WARN。

完整 的 說明文檔在附件
jalopy_html.rar (1.14 MB, 下載次數(shù): 296)

2010-07-14 08:44 上傳

點擊文件名下載附件