我寫了個IDEA開源外掛，vo2dto 一鍵生成物件轉換

小傅哥發表於2021-12-23
Idea物件

讓人頭疼的物件轉換

頭炸，po2vo、vo2do、do2dto，一堆物件屬性，取出來塞進來。要不是為了 DDD 架構下的各個分層防腐，真想一竿子懟下去。

那上 BeanUtils.copyProperties 呀，其實物件轉換不只這個方法，還有同類的12種手段，但綜合來看還是 MapStruct 在編譯期生成x.set(y.get)程式碼的最終效果最好，整體壓測資料如下：

  • BeanUtils.copyProperties 是大家程式碼裡最常出現的工具類，但只要你不把它用錯成 Apache 包下的，而是使用 Spring 提供的，就基本還不會對效能造成多大影響。
  • 但如果說效能更好，可替代手動get、set的，還是 MapStruct 更好用，因為它本身就是在編譯期生成get、set程式碼，和我們寫get、set一樣。
  • 其他一些元件包主要基於 AOP、ASM、CGlib，的技術手段實現的，所以也會有相應的效能損耗。

咋辦？ 給每一個轉換物件屬性的操作都寫一個 MapStruct 嗎？也不合適呀，有些就是方法中很簡單的操作一下，寫寫程式碼就能搞定，問題就是懶的寫，一多了還容易寫錯。別提 BeanUtils.copyProperties 有時候確定有效能問題，從編碼上還看不出來屬性的新增和減少

所以 我要寫個 IDEA Plugin 解決這個問題，目的就一個，通過 IDEA 外掛開發能力，定義到我需要轉換屬性的2個物件，把2個物件的轉換程式碼自動生成出來，並織入到我的物件定位位置上。

設計一個外掛

我是這麼思考的：在 IDEA 開發工程程式碼中，在需要轉換的2個物件間，複製第一個物件和屬性，再把游標定位到轉換物件上，接下來我給它提供個按鈕或者快捷鍵，一點就把所有轉換程式碼生成出來，這樣不就解決了需要手寫的問題了嗎，效果如下：

1. 工程結構

vo2dto
├── .gradle
└── src
    ├── main
    │   └── java
    │       └── cn.bugstack.guide.idea.plugin 
    │           ├── action
    │           │    └── Vo2DtoGenerateAction.java     
    │           ├── application
    │           │    └── IGenerateVo2Dto.java      
    │           ├── domain
    │           │    ├── model
    │           │    │    ├── GenerateContext.java     
    │           │    │    ├── GetObjConfigDO.java      
    │           │    │    └── SetObjConfigDO.java       
    │           │    └── service   
    │           │         ├── impl     
    │           │         │    └── GenerateVo2DtoImpl.java    
    │           │         └── AbstractGenerateVo2Dto.java      
    │           └── infrastructure   
    │                └── Utils.java    
    ├── resources
    │   └── META-INF
    │       └── plugin.xml 
    ├── build.gradle  
    └── gradle.properties

原始碼獲取：https://github.com/fuzhengwei/vo2dto - 歡迎提交 issue、PR 共同維護

在此 IDEA 外掛工程中，主要分為4塊區域：

  • action：提供選單欄窗體，在外掛中我們把這個選單欄配置到 Generate 下，也就是通常你生成 get、set、constructor 方法的地方。
  • application：應用層定義介面，這裡定義了一個用於生成程式碼並織入到錨點的方法介面。
  • domian：領域層專門處理程式碼的生成和織入動作，這一層把程式碼的中錨點位置獲取、剪下板資訊複製、應用上下文、類中get、set的解析，以及最終把生成程式碼織入到錨點後的操作。
  • infrastructure：在基礎層提供了工具類，用於獲取剪下板資訊和錨點位置判斷等操作。

2. 織入程式碼介面

cn.bugstack.guide.idea.plugin.application.IGenerateVo2Dto

public interface IGenerateVo2Dto {

    void doGenerate(Project project, DataContext dataContext);

}
  • 定義介面其實非常重要的一步，因為這樣一步就把生成的標準定義下來了，所有的生成動作都要從這個介面發起。學習原始碼也一樣，你要找到一個核心的入口點，才能更好的開始學習

3. 定義模板方法

因為生成程式碼並織入錨點位置的操作，整個來看其實也是一套流程操作，因為在這個過程需要；獲取上下文資訊(也就是工程物件)、給當前錨點位置的類提取 set 方法集合、之後在給Ctrl+C剪下板上的資訊讀取出來提取 get 方法集合，第四步把set、get進行組合並織入程式碼到錨點位置。整體過程如下：

  • 那麼在使用模板方法後，就可以非常容易的把寫在一個類裡的成片的程式碼按照職責進行拆分。
  • 同時因為有了模板的定義，也就定義出了整個一套標準流程，在流程規範下執行程式碼，後續再補充邏輯迭代功能也會更加容易。

4. 程式碼織入錨點

關於程式碼織入錨點前，我們在模板類中定義的方法，需要實現介面進行處理，重點包括：

  1. 通過 CommonDataKeys.EDITOR.getData(dataContext)、CommonDataKeys.PSI_ELEMENT.getData(dataContext) 封裝 GenerateContext 物件上下文資訊，也就是一些類、錨點位置、文件編輯的物件。
  2. 通過 PsiClass 獲取游標位置對應的 Class 類資訊，在通過 psiClass.getMethods() 讀取物件方法，把 set 方法過濾出來，封裝到集合中。
  3. 通過 Toolkit.getDefaultToolkit().getSystemClipboard() 獲取剪下板資訊，也就是你在錨點位置給物件生成 x.set(y.get) 時，複製的 Y y 物件，並開始提取 get 方法，同樣封裝到集合中。
  4. 那麼最後就是程式碼的組裝和織入動作了，這部分我們的程式碼如下；

cn.bugstack.guide.idea.plugin.domain.service.impl.GenerateVo2DtoImpl

@Override
protected void weavingSetGetCode(GenerateContext generateContext, SetObjConfigDO setObjConfigDO, GetObjConfigDO getObjConfigDO) {
    Application application = ApplicationManager.getApplication();
    // 獲取空格位置長度
    int distance = Utils.getWordStartOffset(generateContext.getEditorText(), generateContext.getOffset()) - generateContext.getStartOffset();
    application.runWriteAction(() -> {
        StringBuilder blankSpace = new StringBuilder();
        for (int i = 0; i < distance; i++) {
            blankSpace.append(" ");
        }
        int lineNumberCurrent = generateContext.getDocument().getLineNumber(generateContext.getOffset()) + 1;
        List<String> setMtdList = setObjConfigDO.getParamList();
        for (String param : setMtdList) {
            int lineStartOffset = generateContext.getDocument().getLineStartOffset(lineNumberCurrent++);
            
            WriteCommandAction.runWriteCommandAction(generateContext.getProject(), () -> {
                generateContext.getDocument().insertString(lineStartOffset, blankSpace + setObjConfigDO.getClazzParamName() + "." + setObjConfigDO.getParamMtdMap().get(param) + "(" + (null == getObjConfigDO.getParamMtdMap().get(param) ? "" : getObjConfigDO.getClazzParam() + "." + getObjConfigDO.getParamMtdMap().get(param) + "()") + ");\n");
                generateContext.getEditor().getCaretModel().moveToOffset(lineStartOffset + 2);
                generateContext.getEditor().getScrollingModel().scrollToCaret(ScrollType.MAKE_VISIBLE);
            });
        }
    });
}
  • 織入程式碼的流程動作，主要是對set方法集合進行遍歷，把對應的x.set(y.get)通過 document.insertString 到具體的位置和程式碼。
  • 最終所有生成的程式碼方法織入完成，即完成了整個 x.set(y.get) 的過程。

5. 配置選單入口

plugin.xml

<actions>
    <!-- Add your actions here -->
    <action id="Vo2DtoGenerateAction" class="cn.bugstack.guide.idea.plugin.action.Vo2DtoGenerateAction"
            text="Vo2Dto - 小傅哥" description="Vo2Dto generate util" icon="/icons/logo.png">
        <add-to-group group-id="GenerateGroup" anchor="last"/>
        <keyboard-shortcut keymap="$default" first-keystroke="ctrl shift K"/>
    </action>
</actions>
  • 這次我們給生成 x.set(y.get) 程式碼的操作加個快捷鍵，可以讓我們更加方便的進行操作。

安裝使用驗證

接下來你就可以 So Easy 的轉換物件了，操作如下：

  1. 複製你需要被轉換的物件，因為複製以後就可以被外掛獲取到剪下板資訊了，也就能提取到get方法集合。
  2. 把滑鼠定義到需要轉換設定值的物件，之後滑鼠右鍵，選擇 Generate -> Vo2Dto - 小傅哥

1. 複製物件

2. 生成物件

3. 最終效果

  • 最終你就可以看到已經把你全部的物件轉換，自動生成出來程式碼了，是不是很香。
  • 如果你直接使用快捷鍵 Ctrl + Shift + K 也是可以自動生成的。

拿去用用吧，最好再給提一些建議，提交issue、提交PR，都非常的歡迎！

相關文章