开发一个调试JSP的Eclipse插件

　　开发一个JSP编辑器

　　Eclipse 提供了 TextEditor，作为文本编辑器的父类。由于 Editor 的开发不是本文的重点，不做具体论述。我们可以利用 Eclipse 的 Plugin 项目向导，生成一个简单的 JSP 编辑器：

　　(1)点击 File 菜单，New -＞ Project -＞ Plug-in Project ；

　　(2)输入项目名称 JSP_DEBUG，下一步；

　　(3)输入 plugin ID ：com.jsp.debug
　　　　Plugin Class name ： com.jsp.debug.JSP_DebugPlugin

　　(4)选择用模板创建

　　使用 Plug-in with editor，输入

　　Java Package Name ：com.jsp.editors

　　Editor Class Name ：JSPEditor

　　File extension ：jsp

　　一个 jsp editor 就产生了。

　　运行这个Plugin，新建一个JAVA项目，新建一个 Hello.jsp 和 greeting.jsp，在 Navigator 视图双击 jsp，这个editor就打开了。

　　在JSP编辑器中设置断点

　　在编辑器中添加断点的操作方式有两种，一种是在编辑器左侧垂直标尺上双击，另一种是在左侧垂直标尺上点击鼠标右键，选择菜单"添加/删除断点"。

　　在 Eclipse 的实现中，添加断点实际上就是为 IFile 添加一个marker ，类型是IBreakpoint.BREAKPOINT_MARKER，然后将断点注册到 BreakpointManager。

　　BreakpointManager 将产生一个 BreakpointRequest，通知正在运行的JVM Target，如果此时还没有启动 JVM，会在 JVM 启动的时候，将所有断点一起通知 JVM Target。

　　添加断点使用一个 AbstractRulerActionDelegate，重载 createAction 方法，返回一个 IAction ManageBreakpointRulerAction动作：

public class ManageBreakpointRulerActionDelegate extends AbstractRulerActionDelegate{
 protected IAction createAction(ITextEditor editor, IVerticalRulerInfo rulerInfo) {
  return new ManageBreakpointRulerAction(rulerInfo, editor);
 }
}

　　为了将 ManageBreakpointRulerActionDelegate 添加到文本编辑器左侧标尺的鼠标右键菜单，并且能够处理左侧标尺的鼠标双击事件，在 plugin.xml 中加入定义。

　　处理双击事件：

＜extension  point="org.eclipse.ui.editorActions"＞
　＜editorContribution
      targetID="com.jiaoly.editors.JSPEditor"
      id="com.jiaoly.debug.ManageBreakpointRulerActionDelegate"＞
　　　＜action
         label="添加/删除断点"
         class="com.jiaoly.debug.ManageBreakpointRulerActionDelegate"
         actionID="RulerDoubleClick"
         id="com.jiaoly.debug.ManageBreakpointRulerActionDelegate"＞
　　　＜/action＞
　＜/editorContribution＞
＜/extension＞

　　添加右键菜单：

＜extension point="org.eclipse.ui.popupMenus"＞
 ＜viewerContribution
     targetID="#TextRulerContext"
     id="com.jiaoly.debug.ManageBreakpointRulerActionDelegate"＞
     ＜action
       label="添加/删除断点"
       class="com.jiaoly.debug.ManageBreakpointRulerActionDelegate"
       menubarPath="addition"
       id="com.jiaoly.debug.ManageBreakpointRulerActionDelegate"＞
    ＜/action＞
 ＜/viewerContribution＞
＜/extension＞

　　ManageBreakpointRulerAction 是实际添加断点的Action，实现了 IUpdate 接口，这个Action的工作，就是判断当前选中行是否存在断点类型的 Marker，如果不存在创建一个，如果存在，将它删除。

public class ManageBreakpointRulerAction extends Action implements IUpdate{ 

     private IVerticalRulerInfo rulerInfo;
     private ITextEditor textEditor; 

     private String BPmarkerType ;     //当点Marker的类型
     private List allMarkers;       //当前鼠标点击行所有的Marker
     private String addBP;   //Action 的显示名称

public ManageBreakpointRulerAction(IVerticalRulerInfo ruler, ITextEditor editor){
     this.rulerInfo = ruler;
     this.textEditor = editor;
     BPmarkerType = IBreakpoint.BREAKPOINT_MARKER;
     addBP = "添加/删除断点"; //$NON-NLS-1$
     setText(this.addBP);
}

public void update() {
  this.allMarkers = this.fetchBPMarkerList();
}

public void run(){
 if(this.allMarkers.isEmpty())
   this.addMarker();
 else
   this.removeMarkers(this.allMarkers);
}
}

　　update 方法会在点击时首先调用，这时就可以收集当前选中行是否有marker了（调用fetchBPMarkerList方法)，如果有，就保存在变量allMarkers 中。由于ManageBreakpointRulerAction每一次都产生一个新的实例，因此不会产生冲突。

　　下面是update的调用栈，可以看出，update方法是在鼠标点击事件中被调用的：

ManageBreakpointRulerAction.update() line: 55
ManageBreakpointRulerActionDelegate(AbstractRulerActionDelegate).update() line: 114
ManageBreakpointRulerActionDelegate(AbstractRulerActionDelegate).mouseDown(MouseEvent) line: 139

　　updae被调用后，会执行 run 方法，就可以根据 allMarkers.isEmpty() 确定要删除还是添加 marker 了。

　　添加断点的时候，首先利用 IVerticalRulerInfo，获取鼠标点击的行号，根据行号，从 Document 模型中取得该行的描述IRegion，得到开始字符位置和结束字符位置，创建一个 JSP 断点。

  protected void addMarker() {
  IEditorInput editorInput= this.getTextEditor().getEditorInput(); 

  IDocument document= this.getDocument();
  //the line number of the last mouse button activity
  int rulerLine= this.getRulerInfo().getLineOfLastMouseButtonActivity(); 

  try{
   int lineNum = rulerLine + 1;
   if(lineNum ＞ 0){
       //Returns a description of the specified line
    IRegion iregion = document.getLineInformation(lineNum - 1);
    int charStart = iregion.getOffset();
    int charEnd = (charStart + iregion.getLength()) - 1;
    JSPDebugUtility.createJspLineBreakpoint(this.getResource(), 
             lineNum, charStart, charEnd);
   }
  }catch(CoreException coreexception){
   coreexception.printStackTrace();
  }
  catch(BadLocationException badlocationexception){
   badlocationexception.printStackTrace();
  }
 }