代碼生成利器IDEA強大LiveTemplates

知識 08-17

Java 開發過程經常需要編寫有固定格式的代碼，例如說聲明一個私有變數， logger 或者 bean 等等。對於這種小範圍的代碼生成，我們可以利用 IDEA 提供的 Live Templates 功能。剛開始覺得它只是一個簡單的 Code Snippet ，後來發現它支持變數函數配置，可以支持很複雜的代碼生成。下面我來介紹一下 Live Templates 的用法。

基本使用

IDEA 自帶很多常用的動態模板，在 Java 代碼中輸入 fori ，回車就會出現

for (int i = 0; i

GIF/17K

按 Tab 可以在各個空白處跳轉，手動填值。

自定義 Template

官方自帶模板畢竟不能滿足我們個人編碼風格的需要， Live Templates 提供了變數函數的方式供我們自定義。

簡單用法

新增自定義模板，首先需要填寫觸發單詞（即 Abbreviation），描述是可選的，然後定義模板的上下文，點擊 define 選擇 Java ，這樣在編輯 Java 的時候就會觸發當前模板，定義完上下文之後，就可以填寫模板了。

下面列舉幾個我常用的簡單模板

========== ---------- System.out.println($END$) ==========

----------private final static String $varName$ = "$var$";` ==========

----------/** * $COMMENT$ */@Getter@Setterprivate $TYPE$ $NAME$; ========== ----------public static void main(String[] args) { $END$ } ==========

模板支持變數的定義，使用 $$ 包圍的字元表示一個變數。 $END$ 是一個特殊的預定義變數，表示游標最後跳轉的位置。每個變數的位置都可以跳轉過去。

高級用法

如果你用過 vim 的 Code Sinppet 插件，你會發現模板裡面是可以執行函數的，強大的 Live Templates 當然也支持，而且 IDEA 能夠感知代碼的語義，例如說當前編輯的函數的參數。但這一點就能夠讓我們玩出花來。我們從易到難來研究模板函數的功能。

前面我們提到的變數可以綁定函數，配置方式如上圖所示。

快速聲明變數

聲明變數是一個常用的操作，特別是需要聲明變數需要加註解，注釋的時候，這些代碼寫起來就很枯燥。下面是我定義的模板：

----------/** * $END$ */@OsgiReference@Setterprivate $TYPE$ $NAME$;

乍一看這個模板跟我上面定義的 privateField 差不多，唯一的不同在於我給這些變數綁定了函數。

clipboard() ：返回當前粘貼板的字元串

decapitalize() ：將輸入的字元串首字母變為小寫

下面我們演示一下，我們先拷貝當前類名，然後輸入 osgiRef

快速聲明 logger

聲明 logger 也是一個常用的操作，上面我們是利用了粘貼函數來快速聲明變數，現在我們來利用另一個函數 className() ，顧名思義，它的作用就是返回當前類名。

----------/** logger */private static final Logger LOGGER = LoggerFactory.getLogger($CLASS$.class);

最強大的 groovyScript()

如果說上面用到的函數提供的能力有限，不夠靈活，那麼 groovyScript() 提供了一切你想要的能力，它支持執行 Groovy 腳本處理輸入，然後輸出處理後的字元串。

下面我們來看一下它的實際應用。

快速 bean 配置

新增一個服務都要在 Spring 中註冊一個 bean，一般這個配置無非就是將指明 id 和 class ，由於我們是在 xml 中配置，所以不能利用 className() 函數，但是我們可以利用 clipboard() 函數獲取到類的全引用，在 IDEA 中我們直接右鍵類名，點擊 Copy Reference 就行。然後執行 groovy 腳本獲取類名。

----------

id 綁定 decapitalize(groovyScript("_1.tokenize('.')[-1]", clipboard())) ，首先取 clipboard() 的值得到類的全引用，然後執行 groovy 代碼 _1.tokenize('.')[-1] （按 . 分割為字元串數組，然後取最後一個即可得到類名，然後用 decapitalize() 將首字母小寫即可得到 id 。

GIF/110K