SharpDevelop代码分析 (一、序+基本概念)
2024-07-21 02:21:21
供稿：网友
序
最近开始学习.net，遇到了一个比较不错的开源的ide sharpdevelop。这个开发工具是使用c#开发的，比较吸引我的一点就是它是采用了和eclipse类似的插件技术来实现整个系统的。而这个插件系统是我最感兴趣的地方，因此开始了一段代码的研究。在本篇之后，我会陆续把我研究的心得写下来。由于是在网吧上网，有诸多不便，因此可能会拖比较长的时间。
一、基本概念
首先，我们先来对 sharpdevelop 有一个比较感性的认识。你可以从这里下载到它的可执行程序和代码包 http://www.icsharpcode.com/ ，安装的废话就不说了，先运行一下看看。感觉跟vs很像吧？不过目前的版本是1.0.0.1550，还有很多地方需要完善。关于代码和系统结构，sharpdevelop的三个作者写了一本书，各位看官可以参考一下，不过我看过之后还是有很多地方不太理解。
然后，让我来解释一下什么叫插件以及为什么要使用插件系统。我们以往的系统，开发人员编译发布之后，系统就不允许进行更改和扩充了，如果要进行某个功能的扩充，则必须要修改代码重新编译发布。这就给我们带来了比较大的不方便。解决的方法有很多，例如提供配置等等方法。在解决方案之中，插件是一个比较好的解决方法。大家一定知道photoshop、winamp吧，他们都有“插件”的概念，允许其他开发人员根据系统预定的接口编写扩展功能（例如photoshop中各种各样的滤镜）。所谓的插件就是系统的扩展功能模块，这个模块是以一个独立文件的形式出现的，与系统是相对独立。在系统设计期间并不知道插件的具体功能，仅仅是在系统中为插件留下预定的接口，系统启动的时候根据插件的配置寻找插件，根据预定的接口把插件挂接到系统中。
这样的方式带来什么样的优点呢？首先是系统的扩展性大大的增强了，如果我们在系统发布后需要对系统进行扩充，不必重新编译，只需要修改插件就可以了。其次有利与团队开发，各个功能模块由于是以插件的形式表现在系统中，系统的每日构造就很简单了，不会因为某个模块的错误而导致整个系统的build失败。失败的仅仅是一个插件而已。
photoshop和winamp的插件系统是比较简单的，他们首先实现了一个基本的系统，然后在这个系统的基础上挂接其他扩展的功能插件。而sharpdevelop的插件系统更加强大，它的整个系统的基础就仅仅是一个插件管理系统，而你看到的所有的界面、功能统统都是以插件的形式挂入的。在这样的一个插件系统下，我们可以不修改基本系统，仅仅使用插件就构造出各种各样不同的系统。
现在让我们来看看它的插件系统。进入到sharpdevelop的安装目录中，在bin目录下的sharpdevelop.exe 和 sharpdevelop.core.dll是这个系统的基本的插件系统。在addins目录下有两个后缀是addin的文件，其中一个 sharpdevelopcore.addin 就是它的核心插件的定义（配置）文件，里面定义的各个功能模块存在于bin/sharpdevelop.base.dll 文件中，另外还有很多其他的插件定义在addins目录下的addin文件中。
分析sharpdevelop的代码，首先要弄清楚几个基本的概念，这些概念和我以前的预想有一些区别，我深入了代码之后才发现我的困惑所在。
1、addintree 插件树
sharpdevelop 中的插件被组织成一棵插件树结构，树的结构是通过 extension（扩展点）中定义的path(路径)来定义的，类似一个文件系统的目录结构。系统中的每一个插件都在配置文件中指定了 extension，通过extension中指定的 path 挂到这棵插件树上。在系统中可以通过 addtreesingleton对象来访问各个插件，以实现插件之间的互动。
2、 addin 插件
在 sharpdevelop 的概念中，插件是包含多个功能模块的集合（而不是我过去认为的一个功能模块）。在文件的表现形式上是一个addin配置文件，在系统中对应 addin 类。
3、extension 扩展点
sharpdevelop中的每一个插件都会被挂到 addintree（插件树） 中，而具体挂接到这个插件树的哪个位置，则是由插件的 extension 对象中的 path 指定的。在addin 配置文件中，对应于 <extension> 。例如下面这个功能模块的配置
<extension path = "/sharpdevelop/workbench/ambiences">
<class id = ".net" class = "icsharpcode.sharpdevelop.services.netambience"/>
</extension>
指定了扩展点路径为 /sharpdevelop/workbench/ambiences ，也就是在插件树中的位置。
4、codon
这个是一个比较不好理解的东西，在 sharpdevelop 的三个作者写的书的中译版中被翻译为代码子，真是个糟糕的翻译，可以跟handle(句柄)有一拼了。词典中还有一个翻译叫“基码”，我觉得这个也不算好，不过还稍微有那么一点意思。
根据我对代码的理解，codon 描述(包装)一个功能模块，一个功能模块对应一个实现了具体功能的 command 类。为了方便访问各个插件中的功能模块， codon 给各种功能定义了基本的属性，分别是 id (功能模块的标识)，name (功能模块的类型。别误会，这个name 是addin文件定义中codon的xml结点的名称，id才是真正的名称)，其中name可能是class(类)、menuitem(菜单项)、pad(面板)等等。根据具体的功能模块，可以继承codon定义其他的一些属性，sharpdevelop中就定义了 classcodon、menucodon、padcodon等等。
在addin定义文件中，codon对应于 <extension> 标签下的内容。 例如下面这个定义
<extension path = "/sharpdevelop/workbench/ambiences">
<class id = ".net" class = "icsharpcode.sharpdevelop.services.netambience"/>
</extension>
<extension ...> 内部定义了一个codon，<class ...> 表示该codon是一个 class(类)，接着定义了该codon的 id和具体实现该codon的类名icsharpcode.sharpdevelop.services.netambience。运行期间将通过反射来找到对应的类并创建出来，这一点也是我们无法在以前的语言中实现的。
再例如这一个定义
<extension path = "/sharpdevelop/views/projectbrowser/contextmenu/combinebrowsernode">
<menuitem id = "compile"
label = "${res:xml.mainmenu.runmenu.compile}"
class = "icsharpcode.sharpdevelop.commands.compile"/>
<menuitem id = "compileall"
label = "${res:xml.mainmenu.runmenu.compileall}"
class = "icsharpcode.sharpdevelop.commands.compileall"/>
<menuitem id = "combinebuildgroupseparator" label = "-" />
....
</extension>
这个扩展点中定义了三个菜单项，以及各个菜单项的名字、标签和实现的类名。这里的codon就对应于系统中的menucodon对象。
5、command 命令
正如前文所述，codon描述了一个功能模块，而每个功能模块都是一个 icommand 的实现。最基本的 command 是 abstractcommand，根据codon的不同对应了不同的 command。例如 menucodon 对应 menucommand 等等。
6、service 服务
插件系统中，有一些功能是整个系统都要使用的，例如文件访问、资源、消息等等。这些功能都作为插件系统的一个基本功能为整个系统提供服务，我们就叫“服务”好了。为了便于访问，这些服务都统一通过 servicemanager 来管理。其实服务也是一种类型的插件，它们的扩展点路径在目录树中的 /services 中。
理解了这几个基本的概念之后，就可以看看 sharpdevelop 的代码了。从 src/main/startup.cs 看起吧，之后是addin.cs、addintree.cs 等等。
写了两个小时了，休息一下。且听下回分解吧。
