Eclipse 插件開發實戰：文本操作、菜單分組與快捷鍵綁定完整指南

場景：選中文本轉換插件

需求：在編輯器中選中代碼片段，點擊菜單/工具欄/快捷鍵，自動轉換（如大小寫、格式化、加密）並替換原文本，保持選中狀態。

核心 API 流程

// 1. 獲取當前活動編輯器
IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
IEditorPart editor = window.getActivePage().getActiveEditor();
if (!(editor instanceof ITextEditor)) return;

// 2. 獲取選中文本區域
ITextSelection selection = (ITextSelection) editor.getEditorSite()
        .getSelectionProvider().getSelection();
int offset = selection.getOffset();
int length = selection.getLength();
String selectedText = selection.getText();

// 3. 業務轉換邏輯
String converted = transform(selectedText); // 你的轉換算法

// 4. 替換文檔內容
IDocumentProvider provider = ((ITextEditor) editor).getDocumentProvider();
IDocument document = provider.getDocument(editor.getEditorInput());
document.replace(offset, length, converted);

// 5. 重新選中轉換後文本（可選）
ITextSelection newSelection = new TextSelection(document, offset, converted.length());
editor.getEditorSite().getSelectionProvider().setSelection(newSelection);

plugin.xml 擴展點配置

菜單分組與分隔線

<extension point="org.eclipse.ui.menus">
  <menuContribution locationURI="menu:org.eclipse.ui.main.menu">
    <menu id="com.example.tools.menu" label="MyTools (&T)">
      <separator name="group.text" visible="true"/>
      <separator name="group.sql" visible="true"/>
      <separator name="group.code" visible="true"/>
      <separator name="group.refactor" visible="true"/>
    </menu>
  </menuContribution>
</extension>

Action 綁定：圖標、菜單路徑、工具欄、快捷鍵

<extension point="org.eclipse.ui.commands">
  <command id="com.example.tools.toLowerCase" name="To Lower Case" />
</extension>

<extension point="org.eclipse.ui.handlers">
  <handler commandId="com.example.tools.toLowerCase" 
           class="com.example.tools.actions.ToLowerCaseHandler" />
</extension>

<extension point="org.eclipse.ui.menus">
  <menuContribution locationURI="menu:com.example.tools.menu/group.text">
    <command commandId="com.example.tools.toLowerCase" 
             label="To Lower Case (&L)" 
             icon="icons/lower.gif"
             style="push" />
  </menuContribution>
  
  <!-- 工具欄 -->
  <menuContribution locationURI="toolbar:com.example.tools.toolbar">
    <command commandId="com.example.tools.toLowerCase" 
             icon="icons/lower.gif"
             tooltip="To Lower Case" />
  </menuContribution>
</extension>

<!-- 快捷鍵綁定 -->
<extension point="org.eclipse.ui.bindings">
  <key commandId="com.example.tools.toLowerCase" 
       schemeId="org.eclipse.ui.defaultAcceleratorConfiguration"
       sequence="M1+M2+L" 
       contextId="org.eclipse.ui.textEditorScope" />
</extension>

關鍵類結構

最佳實踐 Tips

• 啟用條件：用 <visibleWhen> / <enabledWhen> 限定僅在文本編輯器、有選中文本時顯示/啟用。
• 撤銷支援：document.replace 自動納入編輯器撤銷棧，無需額外代碼。
• 非 UI 執行緒：耗時轉換用 Job 或 WorkspaceModifyOperation 避免凍結 UI。
• 圖標規範：16x16 PNG，放 icons/ 目錄，plugin.xml 相對路徑引用。
• 上下文綁定：contextId="org.eclipse.ui.textEditorScope" 確保快捷鍵僅在編輯器生效。

從舊 API 遷移到 Commands Framework

Eclipse 3.5+ 推薦Commands + Handlers + Menus 三位一體模型，優勢：

1. 關注點分離：命令定義「做什麼」，處理器定義「怎麼做」，菜單定義「在哪顯示」。
2. 動態啟用/可見：透過 IEvaluationService 靈活控制。
3. 鍵位衝突解決：BindingService 統一管理。
4. 無需實現 IEditorActionDelegate，減少樣板代碼。

總結

掌握 IDocument 文本替換核心流程、plugin.xml 菜單/工具欄/快捷鍵聲明式配置、Command/Handler 架構，即可高效開發高質量 Eclipse 文本處理插件。