作者:肖漢松
來源:https://blog.xiaohansong.com/codemaker.html
前言
Java 開發過程中經常會遇到編寫重複代碼的事情,例如說:編寫領域類和持久類的時候,大部分時候它們的變量名稱,類型是一樣的,在編寫領域類的時候常常要重複寫類似的代碼。類似的問題太多,卻沒找到可以支持自定義代碼模板的插件,只能自己動手,豐衣足食,開發了一個 IDEA 的代碼生成插件,通過 Velocity 支持自定義代碼模板來生成代碼。
項目地址:
https://github.com/x-hansong/CodeMaker
主要功能
- 支持增加自定義代碼模板(Velocity)
- 支持選擇多個類作為代碼模板的上下文
安裝
下載插件:
https://github.com/x-hansong/CodeMaker/releases/download/1.0/CodeMaker.zip
- 打開設置,選擇“Plugin”
- 在右邊的框中點擊“Install plugin from disk”
- 選擇上面下載的“CodeMaker.zip”
- 點擊“Apply”,然後重啟 IDEA。
使用
在 Java 類編輯界面右鍵“Generate”,選擇對應模板即可自動生成代碼到當前類的包,大部分情況下生成的代碼已經解決了百分之八十的問題,只需稍作修改,移動到合適的包中,就能快速完成代碼編寫。
如果代碼模板需要除了當前類之外的類作為上下文,可以通過類選擇框進行選擇。
目前自帶的兩個模板:
- Model:根據當前類生成一個與其擁有類似屬性的類,用於自動生成持久類對應的領域類
- Converter:該模板需要兩個類作為輸入的上下文,用於自動生成領域類與持久類的轉化類。
上面兩個模板是我自己工作中常用的模板,大家可以參考其寫法,自己定義新的代碼模板。
模板配置
增加模板:點擊“Add Template”後,填寫相關配置(都不能為空),點擊保存後重啟 IDEA 才能生效。
刪除模板:點擊“Delete Template”就能將該模板刪除,同樣需要重啟才能生效。
- Template Name:在生成菜單中顯示的名稱,英文命名
- Class Number:該模板需要的輸入上下文類的數量,例如:如果為 1,,將當前的類作為輸入:$class0;如果為 2,需要用戶再選擇一個類作為輸入:$class0, $class1。
- Class Name:生成的類的名稱,支持通過 Velocity 進行配置,上下文為跟代碼模板的相同。
閱讀更多 程序員聖經 的文章