深入Workbench框架

深入Workbench框架（结合UIPersistent）
1.整体架构E-R图

工作台（Workbench）包含一个或多个WorkbenchWindow，每个WorkbenchWindow又包含0~n个WorkbenchPage，不过一般情况下就一个WorkbenchPage页面。
WorkbenchPage中包含了Editor、View、Perspective等信息，其中Editor和View是在界面上用户可见的，透视图Perspective虽然可以通过透视图Bar进行切换，但它并不是UI组件，它只是View和Editor的集合，其中有Layout布局管理器可以控制View和Editor在Page也中的呈现。
我们要实现一个View或Editor，首先是要扩展org.eclipse.ui.views或org.eclipse.ui.editors扩展点，然后需要指定一个实现了ViewPart或EditorPart的实现类通重写createPartControl这个方法实现自定义的View或Editor的界面。
然而，在WorkbenchPage中为了有效利用系统资源是通过懒加载的形式加载ViewPart或EditorPart这些UI组件的。具体实现就是通过ViewFactory和EditorManger分别维护着Page中的View和Editor的引用，
称为ViewReference和EditorReference。只有当View和Editor需要显示时才通过这些Reference创建Part。
 
Part创建的时序图：

下面以创建一个view part的过程进行说明：
可以任意实现一个View，然后在createPartControl方法里打上行断点，debug模式启动该插件，可以通过Debug视图的状态栈信息，追踪View的整个创建过程:
把viewID传给当前的WorkbenchPage

IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
page.showView(id);

然后调用busyShowView方法，源码如下:

 protected IViewPart busyShowView(String viewID, String secondaryID, int mode)
            throws PartInitException {
        Perspective persp = getActivePerspective();//先得到当前的透视图
        //首先，会通过透视图查找是否存在对应id的Reference
        IViewReference ref = persp.findView(viewID, secondaryID);
        IViewPart view = null;
        if (ref != null) {
			view = ref.getView(true);//很关键，下面会说
		}
        if (view != null) {
            busyShowView(view, mode);
            return view;
        }

        // 如果没有view的reference，就通过透视图的showView方法，下文会继续说
        view = persp.showView(viewID, secondaryID);
        if (view != null) {
            busyShowView(view, mode);
          .....
        }
        return view;
　　}

　　其实Perspective的showView操作就两步:
　　1.通过ViewFactory创建ViewReference；2.调用ref.getPart方法创建View
 

* Shows the view with the given id and secondary id.
     */
    public IViewPart showView(String viewId, String secondaryId)
            throws PartInitException {
        ViewFactory factory = getViewFactory();
        IViewReference ref = factory.createView(viewId, secondaryId);
　　        IViewPart part = (IViewPart) ref.getPart(true);
　　  ... ..
　　}

　　既然创建View的实际动作是通过ViewReference.getPart()方法完成的，下面看一下其具体实现：
　　getPart方法是ViewReference的抽象父类WorkbenchPartReference的方法，采用了模板方法的模式调用了抽象方法  protected abstract IWorkbenchPart createPart()，而这个方法在ViewReference中实现。最终在createPartHelper方法中调用到了cratePart方法，创建了ViewPart：

private IWorkbenchPart createPartHelper() throws PartInitException {
		IWorkbenchPart result = null;
		IMemento stateMem = null;
		if (memento != null) {//获取View状态的持久化信息
			stateMem = memento.getChild(IWorkbenchConstants.TAG_VIEW_STATE);
		}
		IViewDescriptor desc = factory.viewReg.find(getId());
		// Create the part pane
		PartPane pane = getPane();//pane,就是表示一个窗口，负责View的窗体展现
		// Create the pane's top-level control
		pane.createControl(factory.page.getClientComposite());
		......
		try {
			IViewPart view = null;
			try {
				UIStats.start(UIStats.CREATE_PART, label);
				view = desc.createView();//创建ViewPart
			} finally {
				UIStats.end(UIStats.CREATE_PART, view, label);
			}

			if (view instanceof IWorkbenchPart3) {
				createPartProperties((IWorkbenchPart3)view);
			}
			// Create site
			site = new ViewSite(this, view, factory.page, desc);
			actionBars = new ViewActionBars(factory.page.getActionBars(), site,
					(ViewPane) pane);
			site.setActionBars(actionBars);
               .....
			int style = SWT.NONE;
			// Create the top-level composite
			{
				Composite parent = (Composite) pane.getControl();
				ViewDescriptor descriptor = (ViewDescriptor) 
                                   this.factory.viewReg.find(getId());
				if (descriptor != null && descriptor.getPluginId() != null) {
					parent.setData(new ContributionInfo(descriptor.getPluginId(),
							ContributionInfoMessages.ContributionInfo_View, null));
				}
				content = new Composite(parent, style);
				content.setLayout(new FillLayout());
				try {
					UIStats.start(UIStats.CREATE_PART_CONTROL, label);
					view.createPartControl(content);//调用重写的方法，完成view内容的填充
					parent.layout(true);
				} finally {
					UIStats.end(UIStats.CREATE_PART_CONTROL, view, label);
				}
			}

这里还要说明的是ViewFactory中维护了一个ViewReference的集合ReferenceCounter，其内部是一个“ViewID：引用次数对象”为键值对的HashMap，调用createView时会先从counter中获取该view所对应的Reference信息，如果不为空就调用addRef把引用次数加1，否则会创建一个新的reference并添加到counter中。

IViewReference ref = (IViewReference) counter.get(key);
        if (ref == null) {
            IMemento memento = (IMemento) mementoTable.get(key);
            ref = new ViewReference(this, id, secondaryId, memento);
            mementoTable.remove(key);
            counter.put(key, ref);
            getWorkbenchPage().partAdded((ViewReference)ref);
        } else {
            counter.addRef(key);
        }

每个View的reference的次数可以是0~n次，当为0时会通知下一次releaseview时把ViewPart从page中移除。

 public void releaseView(IViewReference viewRef) {
        String key = getKey(viewRef);
        IViewReference ref = (IViewReference) counter.get(key);
        if (ref == null) {
			return;
		}
        int count = counter.removeRef(key);
        if (count <= 0) {
            getWorkbenchPage().partRemoved((ViewReference)ref);
        }
　　}

　　2.看一下Reference和Part的内部E-R图示
　　
　　其中PartSite抽象类的子类有：EditorSite和ViewSite
　　重其构造参数中就能大概猜出PartSite类的主要作用是什么了吧：

public PartSite(IWorkbenchPartReference ref, IWorkbenchPart part,IWorkbenchPage page) 

一个Site的主要任务就是管理part的内容（包括part本身，part的pane，contributions，selection provider等），实现了客户代码和reference、消息服务（Message serverse）之间的通信。
一个reference中包含了part的具体实现（ViewPart，EditorPart等）。
PartPane实现了LayoutPart控制part在Workbench中的布局。
WorkbenchPartReferences 使得SWT resources的懒加载成为了可能

private void disposePart(WorkbenchPartReference ref) {
        if (isDeferred()) {//ref被引用的次数是否大于0
            pendingDisposals.add(ref);//如果在被引用，就先放到一个临时性集合中不进行dispose
        } else {
       //如果没有引用了，则进行ref.dispose操作，会dispose掉它所持有的全部资源（part，pane等）
            partList.removePart(ref);
            ref.dispose();
        }
    }

　　IWorkbenchPartReference 的生命周期图示：

　　3.Workbench Layout
　　
　　一个LayoutPart管理着一个矩形区域内的widgets集合，同时可以包含或排列其他的layout parts，控制着相关区域的拖放功能（如常见的Editor区域的拖动，分成同时可编辑的区域等）、提供缩放的功能等布局相关的控制功能。
其中的PartPane就是控制着views或editors在workbench中的呈现。
　　
　　4.Action Bars
　   （在上一篇的Action中有提到，此篇不再介绍）　　
　　
　　参考资料：
　　http://www.eclipse.org/articles/Article-UI-Workbench/workbench.html#mozTocId917303