OSGi规范的C#实现开源

Posted 2020-08-20

这是大约在3-4年前完成的一个C#实现的OSGi框架，实现的过程参照了OSGi规范与与一些实现思路(感谢当时的那些资料与项目)，此框架虽然仅在几个小型项目有过实际的应用，但OSGi的规范实现还是相对比较完整的，包涵了一些基本的要素，由于个人的项目重心已经转移，现在打算把它公开出来，供大家参考：

OSGi.NET框架是一个参照了OSGi规范的模块化管理框架。框架为应用程序扩展（组件（bundle））提供了一个标准环境。整个框架可以划分为一些层次：

• 1.运行环境
• 2.模块（Bundle）
• 3.生命周期管理
• 4.服务注册
• 5.扩展点支持

目前OSGi.NET具有如下特色：

• 1.组件的可插拔性：组件可根据业务需要在运行时进行装载、卸载操作
• 2.组件的动态更新：组件在运行时可更新替换当前版本
• 3.组件的版本隔离：不同组件引用相同产品的不同版本程序集可以版本隔离
• 4.组件完整的生命周期：包括已安装、已装载、已激活、启动中、停止中、已卸载
• 5.组件的加载顺序：组件加载根据业务要求可设置加载级别来控制加载次序
• 6.组件的通信支持：组件间通过面向服务的编程模型来达到组件间通信、调用的目的
• 7.组件的扩展支持：组件提供了扩展点及其扩展来满足某个组件的扩展性支持

启动一个OSGi.NET应用程序仅需要如下代码

using System;

using OSGi.NET.Core.Root;

namespace ConsoleDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            //创建框架工厂
            var frameworkFactory = new FrameworkFactory();
            //创建框架内核
            var framework = frameworkFactory.CreateFramework();
            //初始化框架
            framework.Init();
            //启动框架
            framework.Start();

            Console.ReadLine();
        }
    }
}

创建一个OSGi.NET项目需要：
1.引用框架内核程序集OSGi.NET.dll
2.添加框架内核配置文件OSGi.NET.properties
3.如需要日志支持，添加log4net.config文件及log4net.dll程序集引用

OSGi.NET项目的默认文件目录结构如下
/程序目录
/程序目录/Bundles/
/程序目录/Bundles/模块A/
/程序目录/Bundles/模块A/Manifest.xml
/程序目录/Bundles/模块A/模块A.dll
/程序目录/Bundles/模块A/Libs/
/程序目录/Bundles/模块A/Libs/* .dll
/程序目录/Bundles/模块B/
/程序目录/Bundles/模块C/
/程序目录/Libs/(可选)
/程序目录/OSGi.NET.properties

注：
程序目录中的Libs文件夹存放个Bundles的共享程序集(也可通过在配置文件中配置共享清单)，如接口契约、公共第三方类库等。
模块A中的Libs文件夹存放其私有程序集。
Manifest.xml作为程序清单文件对模块进行自描述。
OSGi.NET.properties为框架内核配置文件

关于加载次序：
由于业务需求，各模块存在依赖关系的可能，所以模块加载也会有加载顺序的要求，此时可以通过清单文件中Manifest.xml，Bundle节点的StartLevel属性对其加载次序进行设置。数值越小，加载越前。 

关于Bundle引用程序集搜索原则：
1.根据加载的Bundle引用程序集，依据程序集名称+版本号匹配原则，优先从[/程序目录/Libs/]目录或共享清单中搜索。
2.如第一步无匹配，则根据程序集名称从[/程序目录/Bundles/模块A/Libs/*.dll]目录搜索，并将搜索到的程序集对应版本关联Bundle。
3.各Bundle下Libs目录程序集在加载中做了Bundle间的隔离，确保不同的Bundle引用的程序集间不会造成影响。即：如存在共享程序集请放置[/程序目录/Libs/]目录或在共享清单配置。

Intro: http://www.diginfo.me/osgi-net-implement

源代码 https://github.com/FreezeSoul/OSGi.NET

说明文档 https://github.com/FreezeSoul/OSGi.NET/blob/master/OSGi.NET%20Client/Help/Help/Documentation.chm?raw=true