如何为Eclipse插件添加文本编辑器的上下文菜单入口

核心思路 #

Eclipse的菜单体系完全由扩展点机制驱动，根本不需要在Activator启动阶段手动编写菜单注入逻辑——平台会在工作台、编辑器相关组件全部初始化完成、匹配到对应菜单锚点的时机，自动加载你配置的菜单项，从根源上避免你之前遇到的“Activator启动时workspace未初始化”的时序问题。

具体落地步骤 #

• 在插件清单plugin.xml中声明org.eclipse.ui.menus扩展项
  这个扩展点是Eclipse官方提供的全局菜单挂载入口，平台会自动管控所有配置的加载时机，不会出现早于工作台初始化的执行问题。
• 锚定所有文本编辑器通用的右键菜单挂载点
  直接使用官方预留的文本编辑器上下文菜单URI：menu:org.eclipse.ui.texteditor.EditorContextMenu?after=additions。这个锚点对所有继承自TextEditor的组件生效，包括通用文本编辑器、Java编辑器、XML编辑器等各类常见文本编辑场景，不需要单独为每类编辑器重复配置。
  注意不要错用视图组件的菜单锚点ID，否则菜单项只会出现在视图的右键菜单里，不会出现在编辑器界面。
• 按需配置菜单项的显示规则
  可以通过visibleWhen表达式细化菜单项的出现条件：
  • 基础规则：判断当前活跃部件属于ITextEditor类型，避免菜单项误显示在非编辑类的视图、表单界面上
  • 进阶规则：可以结合当前选中文本状态、文件类型进一步控制显示逻辑，所有判断逻辑都由平台在菜单渲染前执行，无需手动监听编辑器的状态变化
• 绑定自定义操作的处理器
  通过command节点将菜单项和你的业务逻辑处理器关联。处理器的初始化时机是用户实际点击菜单项的瞬间，你不需要在插件启动阶段提前获取工作台、workspace实例，直接在处理器的执行方法中，通过HandlerUtil.getActiveEditor(event)拿到当前激活的编辑器对象，再执行自定义逻辑即可。

为什么之前的Activator手动注入方案行不通 #

尝试在Activator的start方法中获取IWorkbench实例、监听编辑器打开事件、手动往菜单管理器中注入菜单项的方式，存在两个无法规避的缺陷：

1. 时序错位：Activator的加载节点早于工作台UI组件的初始化流程，此时拿不到可用的工作台实例和workspace会话，代码根本无法正常执行
2. 维护成本不可控：手动注入的菜单项不会跟着编辑器的生命周期自动回收，还会漏接后续动态打开的编辑器实例，极易出现菜单重复渲染、内存泄漏的问题

落地注意事项 #

• Eclipse对org.eclipse.ui.menus扩展默认采用懒加载策略，只有用户第一次触发对应上下文菜单时才会解析配置，几乎不会带来额外的启动性能开销
• 如果需要根据当前编辑内容动态调整菜单项的可点击状态，可以通过属性测试器、activeWhen表达式实现，不需要手动绑定编辑器的选择监听器
• 该配置方式对Eclipse 3.x及之后的所有4.x版本完全兼容，不需要做版本适配修改

内容的提问来源于stack exchange，提问作者user4892346