IDEA工程右鍵菜單，自動(dòng)生成 ORM碼
本文轉(zhuǎn)載自微信公眾號(hào)「bugstack蟲(chóng)洞棧」，作者小傅哥。轉(zhuǎn)載本文請(qǐng)聯(lián)系bugstack蟲(chóng)洞棧公眾號(hào)。
一、前言
都能用，都能湊活用!
一個(gè)東西好幾套，為了晉升都來(lái)搞。拿了成績(jī)就要跑，后面兄弟再重造!
幾年前，大家并不是這樣，那時(shí)候還有很多東西可以創(chuàng)新，亂世出英雄總能在一個(gè)方向深耕并做出一款款好用的產(chǎn)品功能、框架服務(wù)、技術(shù)組件等。但后來(lái)好像這樣的情況開(kāi)始減少了，取而代之的是重復(fù)、復(fù)刻、照搬，換個(gè)新的皮膚、換個(gè)新的樣式、換個(gè)新的名字，就是取巧的新東西了。
有時(shí)候公司或者組織也像家，但家里的東西一般是破了補(bǔ)補(bǔ)、壞了修修，實(shí)在不行就換個(gè)，但沒(méi)有誰(shuí)的家里衛(wèi)生間一個(gè)馬桶、廚房一個(gè)馬桶、客廳一個(gè)馬桶、臥室一個(gè)馬桶的，雖然你的新馬桶可以自動(dòng)噴水。
所以，在建設(shè)一個(gè)好的產(chǎn)品功能時(shí)，盡可能要學(xué)學(xué)那些已經(jīng)非常的優(yōu)秀的產(chǎn)品，IDEA、GitHub、Mysql等等，在IDEA提供了滿(mǎn)足用戶(hù)擴(kuò)展功能的插件開(kāi)發(fā)，而不是你說(shuō)一個(gè)東西我沒(méi)有，你就自己造。共建會(huì)讓這個(gè)東西變得更加優(yōu)秀!
二、需求目的
在上一章節(jié)中我們通過(guò)擴(kuò)展創(chuàng)建工程向?qū)В砑游覀冃枰獎(jiǎng)?chuàng)建DDD工程腳手架的步驟，最終提供一個(gè)DDD開(kāi)發(fā)框架。那么在這個(gè)DDD工程開(kāi)發(fā)框架中，還缺少一部分基于數(shù)據(jù)庫(kù)表信息自動(dòng)生成對(duì)應(yīng)PO、DAO、Mapper文件的功能。
那么本章節(jié)我們就來(lái)在工程中擴(kuò)展這部分內(nèi)容，實(shí)際操作的效果就是我們可以在工程上通過(guò)鼠標(biāo)右鍵的方式，喚出添加ORM代碼塊的窗體，通過(guò)選擇庫(kù)表的方式，使用 freemarker 自動(dòng)生成代碼。
在生成的代碼塊中需要完成對(duì)所需要包的引入，同時(shí)會(huì)使用到 lombok 注解的方式替代PO對(duì)象中的get、set方法，以減少代碼量邏輯的創(chuàng)建。
三、案例開(kāi)發(fā)
1. 工程結(jié)構(gòu)
- guide-idea-plugin-orm
- ├── .gradle
- └── src
- ├── main
- │ └── java
- │ └── cn.bugstack.guide.idea.plugin
- │ ├── action
- │ │ └── CodeGenerateAction.java
- │ ├── domain
- │ │ ├── model.vo
- │ │ │ ├── CodeGenContextVO.java
- │ │ │ └── ORMConfigVO.java
- │ │ └── service
- │ │ ├── impl
- │ │ │ └── ProjectGeneratorImpl.java
- │ │ ├── AbstractProjectGenerator.java
- │ │ ├── GeneratorConfig.java
- │ │ └── IProjectGenerator.java
- │ ├── infrastructure
- │ │ ├── data
- │ │ │ ├── DataSetting.java
- │ │ │ └── DataState.java
- │ │ ├── po
- │ │ │ ├── Base.java
- │ │ │ ├── Column.java
- │ │ │ ├── Dao.java
- │ │ │ ├── Field.java
- │ │ │ ├── Model.java
- │ │ │ └── Table.java
- │ │ └── utils
- │ │ ├── DBHelper.java
- │ │ └── JavaType.java
- │ ├── module
- │ │ └── FileChooserComponent.java
- │ └── ui
- │ ├── ORMSettingsUI.java
- │ └── ORMSettingsUI.form
- ├── resources
- │ ├── META-INF
- │ │ └── plugin.xml
- │ └── template
- │ ├── dao.ftl
- │ ├── mapper.ftl
- │ └── model.ftl
- ├── build.gradle
- └── gradle.properties
在此 IDEA 插件工程中，主要分為5塊區(qū)域：
- action：用于提供菜單欄，這個(gè)菜單的位置在 plugin.xml 中配置，我們把它配置到工程鼠標(biāo)右鍵出現(xiàn)的列表上。這樣可以更加方便的讓我們選取工程，以及在這個(gè)工程下添加生成的代碼片段
- domain：領(lǐng)域服務(wù)層，其實(shí)你直接寫(xiě)一個(gè)Service包也是可以的，只不過(guò)最近作者小傅哥更喜歡使用DDD的思想和結(jié)構(gòu)來(lái)創(chuàng)建代碼實(shí)現(xiàn)功能邏輯。
- infrastructure：基礎(chǔ)層，提供數(shù)據(jù)在工程下的存放，每一個(gè)工程右鍵都有自己的配置存儲(chǔ)默認(rèn)信息，方便下次打開(kāi)的時(shí)候可以讀取到這部分內(nèi)容。同時(shí)這一層還提供了用于處理數(shù)據(jù)庫(kù)操作的類(lèi)，因?yàn)槲覀冃枰獜臄?shù)據(jù)庫(kù)中讀取出表的信息、字段、注釋?zhuān)糜趧?chuàng)建PO、DAO、Mapper使用。
- module：模塊層，這里提供了一個(gè)用于選擇文件路徑的組件，可以讓我們?cè)诠こ躺鲜髽?biāo)右鍵后出來(lái)的窗體中，點(diǎn)擊模塊選擇對(duì)應(yīng)的要生成代碼的位置路徑。
- ui：提供配置面板，也就是我們?cè)诖a工程上鼠標(biāo)右鍵彈出來(lái)的面板，這個(gè)面板配置后用于生成ORM代碼。
2. 拖拽Swing面板
ORMSettingsUI：咱們先把用于創(chuàng)建代碼配置的面板創(chuàng)建出來(lái)，有了畫(huà)面，就好進(jìn)入了。
- 面板包括生成 PO、DAO、XML 的代碼路徑，以及配置數(shù)據(jù)庫(kù)和選擇表的內(nèi)容。
- 操作過(guò)程就是在你配置好了這些基本信息后，就可以選擇查詢(xún)表名，并選擇好你要給哪幾個(gè)表生成對(duì)應(yīng)的ORM代碼了。
3. 配置鼠標(biāo)右鍵彈窗
首先我們需要?jiǎng)?chuàng)建一個(gè) Action 實(shí)現(xiàn)類(lèi)，通過(guò) New -> Plugin DevKit -> Action
cn.bugstack.guide.idea.plugin.action.CodeGenerateAction
- /**
- * @author: 小傅哥，微信：fustack
- * @github: https://github.com/fuzhengwei
- * @Copyright: 公眾號(hào)：bugstack蟲(chóng)洞棧 | 博客：https://bugstack.cn - 沉淀、分享、成長(zhǎng)，讓自己和他人都能有所收獲！
- */
- public class CodeGenerateAction extends AnAction {
- private IProjectGenerator projectGenerator = new ProjectGeneratorImpl();
- @Override
- public void actionPerformed(AnActionEvent e) {
- Project project = e.getRequiredData(CommonDataKeys.PROJECT);
- ShowSettingsUtil.getInstance().editConfigurable(project, new ORMSettingsUI(project, projectGenerator));
- }
- }
- 這是一個(gè)右鍵菜單的入口，通過(guò)這個(gè)入口才能去打開(kāi)我們自己的UI窗體，這個(gè)UI窗體就是我們上面拖拽出來(lái)的配置面板，ORMSettingsUI
- 接下來(lái)我們還需要把這個(gè) Action 配置到 plugin.xml 文件中，才能被右鍵菜單創(chuàng)建出來(lái)。開(kāi)發(fā)代碼的時(shí)候也是這樣一個(gè)流程，你總要從一個(gè)點(diǎn)開(kāi)始，有了抓手才好抓下去
plugin.xml 配置
- <actions>
- <!-- Add your actions here -->
- <action id="CodeGenerateAction" class="cn.bugstack.guide.idea.plugin.action.CodeGenerateAction"
- text="ORMCodeGenerate - 小傅哥" description="Code Generate ORM" icon="/icons/logo.png">
- <add-to-group group-id="ProjectViewPopupMenu" anchor="last"/>
- </action>
- </actions>
- ea-plugin>
- 把我們的 Action 實(shí)現(xiàn)類(lèi)配置到 xml 中，同時(shí)你還要配置它應(yīng)該出現(xiàn)的位置，比如你需要把這個(gè)菜單添加到工程創(chuàng)建中 ProjectViewPopupMenu 以及位置信息 anchor="last"
- 另外為了讓插件看上去更加高大上還美觀(guān)適合吹牛，那么還需要配置 icon，這個(gè)位置配置一個(gè)16*16的圖片，圖片可以從 iconfont 進(jìn)行下載。
4. 給窗體添加功能
這一步其實(shí)干的就是注入靈魂的事情，讓窗體活起來(lái)。給輸入框添加內(nèi)容、給按鈕添加事件、給確認(rèn)按鈕增加上生成創(chuàng)建ORM代碼塊的上下文。文章的描述盡可能會(huì)偏向于核心代碼的講解，詳情可以參考源碼
接下來(lái)這部分內(nèi)容會(huì)在 ORMSettingsUI 類(lèi)中反復(fù)摩擦，直到補(bǔ)全所有功能。
4.1 選擇框事件
- // 選擇PO生成目錄
- this.poButton.addActionListener(e -> {
- FileChooserComponent component = FileChooserComponent.getInstance(project);
- VirtualFile baseDir = project.getBaseDir();
- VirtualFile virtualFile = component.showFolderSelectionDialog("選擇PO生成目錄", baseDir, baseDir);
- if (null != virtualFile) {
- ORMSettingsUI.this.poPath.setText(virtualFile.getPath());
- }
- });
還記得我們提到的拖拽Swing面板嗎，那么這個(gè)添加事件的步驟就是給你的 PO 目錄添加一個(gè)事件，允許我們可以自己選擇出要把對(duì)應(yīng)PO的代碼生成到哪個(gè)目錄結(jié)構(gòu)下。
關(guān)于dao、xml都是類(lèi)似操作，這里就不在演示了。
4.2 數(shù)據(jù)表事件
- this.selectButton.addActionListener(e -> {
- try {
- DBHelper dbHelper = new DBHelper(this.host.getText(), Integer.parseInt(this.port.getText()), this.user.getText(), this.password.getText(), this.database.getText());
- List<String> tableList = dbHelper.getAllTableName(this.database.getText());
- String[] title = {"", "表名"};
- Object[][] data = new Object[tableList.size()][2];
- for (int i = 0; i < tableList.size(); i++) {
- data[i][1] = tableList.get(i);
- }
- table1.setModel(new DefaultTableModel(data, title));
- TableColumn tc = table1.getColumnModel().getColumn(0);
- tc.setCellEditor(new DefaultCellEditor(new JCheckBox()));
- tc.setCellEditor(table1.getDefaultEditor(Boolean.class));
- tc.setCellRenderer(table1.getDefaultRenderer(Boolean.class));
- tc.setMaxWidth(100);
- } catch (Exception exception) {
- Messages.showWarningDialog(project, "數(shù)據(jù)庫(kù)連接錯(cuò)誤,請(qǐng)檢查配置.", "Warning");
- }
- });
- 這一步操作核心流程就在于把你需要生成ORM的代碼的表給拉出來(lái)，只要把表選擇上，才能根據(jù)表生成PO、DAO、Mapper，其實(shí)你用的其他一些自動(dòng)生成代碼框架也是這么干的。
- 另外你的建表最好規(guī)范，比如有表注釋、有字段注釋、字段的設(shè)計(jì)遵守下劃線(xiàn)和小寫(xiě)字母，這樣會(huì)更加容易創(chuàng)建出好看的代碼。
4.3 組裝生成代碼上下文
當(dāng)我們點(diǎn)擊配置窗體的 OK 按鈕時(shí)候，要干啥，對(duì)嘍，我們要?jiǎng)?chuàng)建出代碼片段了，那么這個(gè)時(shí)候需要在重寫(xiě)的 apply 中完成此項(xiàng)操作。
- public void apply() {
- // 鏈接DB
- DBHelper dbHelper = new DBHelper(config.getHost(), Integer.parseInt(config.getPort()), config.getUser(), config.getPassword(), config.getDatabase());
- // 組裝代碼生產(chǎn)上下文
- CodeGenContextVO codeGenContext = new CodeGenContextVO();
- codeGenContext.setModelPackage(config.getPoPath() + "/po/");
- codeGenContext.setDaoPackage(config.getDaoPath() + "/dao/");
- codeGenContext.setMapperDir(config.getXmlPath() + "/mapper/");
- List<Table> tables = new ArrayList<>();
- Set<String> tableNames = config.getTableNames();
- for (String tableName : tableNames) {
- tables.add(dbHelper.getTable(tableName));
- }
- codeGenContext.setTables(tables);
- // 生成代碼
- projectGenerator.generation(project, codeGenContext);
- }
- 在 apply 中的核心代碼主要就是使用 DBHelper 數(shù)據(jù)操作工具獲取到對(duì)應(yīng)的庫(kù)下鏈接信息，同時(shí)把選擇的號(hào)的表創(chuàng)建出用于生成代碼類(lèi)的參數(shù)，比如;類(lèi)的名稱(chēng)、字段名稱(chēng)、注釋名稱(chēng)等。
- 最后就是調(diào)用生成代碼的服務(wù)了，projectGenerator.generation(project, codeGenContext); 這一部分就是在我們領(lǐng)域服務(wù) domain 中實(shí)現(xiàn)的。
5. 代碼生成領(lǐng)域服務(wù)
用于創(chuàng)建PO、DAO、Mapper的代碼塊的代碼主要是這里實(shí)現(xiàn)的，核心在于提供了一個(gè)抽象類(lèi)以及對(duì)應(yīng)的實(shí)現(xiàn)類(lèi)，因?yàn)樘幚泶a生成需要使用到 freemarker 所以就在抽象類(lèi)里包裝了下，這樣可以免去實(shí)現(xiàn)類(lèi)中還需要關(guān)心這部分邏輯。
ProjectGeneratorImpl 生成代碼
- @Override
- protected void generateORM(Project project, CodeGenContextVO codeGenContext) {
- List<Table> tables = codeGenContext.getTables();
- for (Table table : tables) {
- List<Column> columns = table.getColumns();
- List<Field> fields = new ArrayList<>();
- for (Column column : columns) {
- Field field = new Field(column.getComment(), JavaType.convertType(column.getType()), column.getName());
- field.setId(column.isId());
- fields.add(field);
- }
- // 生成PO
- Model model = new Model(table.getComment(), codeGenContext.getModelPackage() + CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.UPPER_CAMEL, table.getName()), table.getName(), fields);
- writeFile(project, codeGenContext.getModelPackage(), model.getSimpleName() + ".java", "domain/orm/model.ftl", model);
- // 生成DAO
- Dao dao = new Dao(table.getComment(), codeGenContext.getDaoPackage() + "I" + CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.UPPER_CAMEL, table.getName()) + "Dao", model);
- writeFile(project, codeGenContext.getDaoPackage(), dao.getSimpleName() + ".java", "domain/orm/dao.ftl", dao);
- // 生成Mapper
- writeFile(project, codeGenContext.getMapperDir(), dao.getModel().getSimpleName() + "Mapper.xml", "domain/orm/mapper.ftl", dao);
- }
- }
- 創(chuàng)建代碼的過(guò)程就比較簡(jiǎn)單了，通過(guò)循環(huán)提取出來(lái)的表信息，映射成對(duì)應(yīng)的類(lèi)和屬性以及注釋?zhuān)偈褂?resources 下的 ftl 文件創(chuàng)建出對(duì)應(yīng)的類(lèi)和xml配置文件就可以了。
- 如果你還需要生成起來(lái)代碼片段或者創(chuàng)建調(diào)用一些常用的組件，也是可以通過(guò)這樣的方式進(jìn)行實(shí)現(xiàn)的。
四、測(cè)試驗(yàn)證
點(diǎn)擊 Plugin 啟動(dòng) IDEA 插件，之后在工程右鍵如下：
1. 鼠標(biāo)右鍵，選擇菜單
2. 配置頁(yè)面，配置信息
3. 自動(dòng)創(chuàng)建，生成代碼
好了，選擇代碼塊就這么嗖的創(chuàng)建了出來(lái)，是不是非常方便，而且可以滿(mǎn)足你在任何時(shí)候的把新的庫(kù)表代碼補(bǔ)充進(jìn)來(lái)，減少了手敲CRUD操作。
五、總結(jié)
本章節(jié)小傅哥帶著你又在 IDEA DDD 插件生成工程的結(jié)構(gòu)下，又完善了一步生成ORM代碼，當(dāng)然你也可以在創(chuàng)建工程向?qū)е刑砑由蒓RM代碼的步驟。而在工程下創(chuàng)建ORM的方式可以當(dāng)做是對(duì)腳手架工程的補(bǔ)充，滿(mǎn)足不同場(chǎng)景下的需求。
此外在 IDEA 插件開(kāi)發(fā)的系列內(nèi)容中我們是不斷的嘗試使用新的方式完善不同的功能點(diǎn)，如果你需要開(kāi)發(fā)一個(gè)完整的插件那么可以結(jié)合這些功能一起來(lái)開(kāi)發(fā)你的需求。
插件開(kāi)發(fā)中還是有很多的內(nèi)容需要了解和學(xué)習(xí)的，同時(shí)也要注意一些代碼實(shí)現(xiàn)細(xì)節(jié)，例如我們本章節(jié)中的數(shù)據(jù)保存是在一個(gè)什么維度，是IDEA開(kāi)發(fā)工具維度，還是在IDEA中的工程維度，這些是有區(qū)別。比如你的不同工程，是不需要保存同一份配置的
