安利一款 IDEA 中強大的程式碼生成利器

  • 2020 年 2 月 21 日
  • 筆記

閱讀本文大概需要 4 分鐘。

作者 | Sharehub

鏈接 | blog.xiaohansong.com/idea-live-templates.html

前言

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

下面我來介紹一下Live Templates的用法。

基本使用

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

for (int i = 0; i < ; i++) {    }

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

自定義 Template

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

簡單用法

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

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

==========  <out>  ----------  System.out.println($END$)  ==========  <pfs>  ----------  private final static String $varName$ = "$var$";`  ==========  <privateField>  ----------  /**   * $COMMENT$   */  @Getter  @Setter  private $TYPE$ $NAME$;  ==========  <main>  ----------  public static void main(String[] args) {       $END$  }  ==========

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

高級用法

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

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

快速聲明變數

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

<osgiRef>  ----------  /**   * $END$   */  @OsgiReference  @Setter  private $TYPE$ $NAME$;

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

  • clipboard()：返回當前粘貼板的字元串
  • decapitalize()：將輸入的字元串首字母變為小寫

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

快速聲明 logger

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

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

最強大的 groovyScript()

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

groovyScript("code", ...)    | code |   一段Groovy程式碼或者Groovy腳本程式碼絕對路徑 |  |  ... | 可選入參，這些參數會綁定到`_1, _2, _3, ..._n`, 在 Groovy 程式碼中使用。|

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

快速 bean 配置

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

<bean>  ----------  <bean id="$id$" class="$REF$" />

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

快速列印當前上下文資訊

列印錯誤日誌的時候需要列印當前上下文資訊的，例如說入參，有時候入參很多的時候，寫起來很痛苦，好在有模板函數methodParameters()，返回當前函數參數的列表，當然這個列表我們不能直接使用，需要結合groovyScript對它進行轉化。

<printContext>  ---------------  LogUtil.$TYPE$(LOGGER, "$MSG$ " + $params$);

將params綁定到groovyScript("'"' + _1.collect { it + ' = [" + ' + it + ' + "]'}.join(', ') + '"'", methodParameters())，就能夠自動將當前函數的參數格式化後輸出。

總結

上面我們簡單介紹了常用的模板函數，其實 IDEA 還有很多其它模板函數，具體參考Creating and Editing Template Variables。

https://www.jetbrains.com/help/idea/2016.3/creating-and-editing-template-variables.html

IDEA 是一個很強大的工具，善用工具能夠極大的提高工作效率，將精力投入到關鍵的事情上，而不是將時間浪費在編寫重複程式碼上面。一些更高級的用法還有待大家去發掘。最後推廣一波我寫的程式碼生成插件CodeMaker，好好利用也能節省很多重複編寫程式碼的時間。

VirMach 便宜 VPS

QNews

QNews