OSGI Component描述符详解

 描述符文件中的元素（component.xml）：

 

1、Component元素（可以存在多个Component元素）

 

包括5个子元素：

<implementation> -- 必须

<property>            -- 可以出现任意次
<properties>         -- 可以出现任意次
<service>              -- 出现零次或一次，最多一次

<reference>          -- 可以出现任意次

上面元素的顺序可以是随意的。

 

 

Component元素包括以下几个属性：

（1）name

在整个bundle内Component的名称必须唯一。框架中如果使用了Configuration Admin service，Component名称将作为一个PID（相当于身份证），Configuration Admin service通过PID检索Component的属性（相当于通过身份证号查找某人的年龄、籍贯等）。

 

这个属性是可选的，默认值是<implementation>元素的属性class的值。但是，如果XML存在多个Component元素，这样做会导致name的值冲突，所以，一般情况下应该为每一个Component元素指定name的值。

 

（2）enabled

当bundle启动时，是否允许Component启动。默认值是true。如果值是false，那么这个Component将无法启动和使用，直到有程序调用ComponentContext类的enableComponent方法。

 

设置为false大多数是因为需要先做一些初始化工作，待Component所有条件具备之后，再启动。例如，bundle启动的时候，可以先用一个Immediate Component执行一些必需的初始化工作，待所有条件具备后，最后再由这个Immediate Component调用ComponentContext类的enableComponent方法启动其他Component。

 

 （3）factory

可选属性。如果这个属性被赋予了一个非空值，就表明这个Component的类型是一个Factory Component。SCR必须为这个Component注册一个Component Factory service。

 

（4）immediate

可选属性。这个属性控制是否立即激活Component configuration。

先简单认识一下Component configuration（不仅仅是配置的意思，其实它表示一个Component上下文对象，包含Component的配置信息、与其他Component的联系等等）。当Component configuration的所有条件满足时（依赖的Component正常运行、XML中配置正确、其他初始化配置也具备等），是否要立即激活Component configuration（激活后Component configuration将产生一个实现类的实例，返回这个Component提供的服务）。

 

其值的确定分为两种情况：

当factory属性或者<service>元素被指定时，它的默认值是false。其他情况下都是true。

如果是true，表明这个Component是一个Immediate Component，否则它就是Delayed Component或者Factory Component。

 

（5）configuration-policy

Component configuration要被激活，必须先满足一定的条件。这个选项即控制Component configuration的满足条件。即是否要依赖Configuration Admin service中相应的Configuration对象（Configuration是一个类，产生与Component configuration对象的Configuration对象，这个对象的PID是对应的Component的name值）。

上面有点乱，别弄混了。

 

这个属性有三个值：

 

① optional

（默认值）如果存在相应的Configuration对象，就使用这个对象作为评判条件。但是如果不存在，也不作为Component configuration是否满足的评判条件。

 

② equire

Component configuration必须具备相应的Configuration对象，否则条件不完整，无法激活。

 

③ ignore

不管Configuration对象存不存在，Configuration对象不作为Component configuration 满足的评判条件。

 

（6）activate

可选属性。这里配置的是方法名，当Component configuration被激活时，将调用这个方法。默认值是activate方法。

 

（7）deactivate

可选属性。这里配置的是方法名，当Component configuration被注销时，将调用这个方法。默认值是deactivate方法。

 

（8）modified

可选属性。这里配置的是方法名，指定了之后，当Component configuration的配置属性使用了Configuration对象，对Configuration对象的任何修改不会导致Component configuration条件的不满足。否则，将会出现错误。

 

 

2、Implementation元素

这个元素是必须的，它定义了Component 实现类的名称，只有一个属性class。

class -- 实现类的全限定类名（包括包名，如org.zqc.pigimpl）。

 

实现类可以通过Component所属bundle的loadClass()方法得到。实现类必须是公共的，有一个无参构造函数。

如果Component提供了服务，实现类必须实现服务提供的所有接口。

 

 

3、Property和Properties元素

这两种元素都可以为Component定义一系列property（为防止混淆，此处用英文表示，就是属性的意思），它们之间的区别如下：

Property -- 定义单个property。

Properties -- 从一个资源文件中读取property。

 

Property和Properties元素可以出现任意次，它们之间的顺序也是不固定的，可以交叉书写。解析时从头到尾按顺序解析，如果出现同名的，后面的将覆盖前面的。也可以由Configuration对象覆写。

 

其中，Property 有以下几个属性：

① name -- property的名称

② value -- property的值。解析值时要根据type属性来解析，如果指定了这个属性，元素body中的值将会被忽略。

③ type   -- property的类型。定义了如何去解析值。它有以下几种类型：

• String (default)
• Long
• Double
• Float
• Integer
• Byte
• Character
• Boolean
• Short

element body：如果没有指定value属性，Property 元素的body部分应该要有值才行。最终body中的内容将会被转换成一个数组，例如，如果type的值是Integer，那么最终结果将会一个int[]型的数组。

 

body中的值必须是每行一个，空行将会被忽略，去掉首尾空格后，将调用type指定类型的parse方法解析body。

例：

<property name="pig">

    big pig

    small pig

</property>

这将会生成一个property，其值是String[] {"small pig", "big pig"}。

 

Properties文件引用一个符合标准的Java资源文件，它有一个entry属性，指定资源文件的位置。

例如，有一个pig.properties文件在OSGI-INF目录，那么将用到下面的定义：

<properties entry="OSGI-INF/pig.properties" />

 

 

4、Service元素

这个元素是可选的。它描述了Component实现的接口，这些接口也是对外提供服务接口。

 

它有下面1个属性，1个元素

① servicefactory属性

    默认值是false。如果值是true，那么当不同的bundle请求服务时，不同的Component configuration将会被创建、

    激活，并且将它的Component实例作为服务返回，但是这些Component configuration属性配置是相同的。否则，

    对于所有的bundle，只有一个Component configuration并且只有一个服务提供给这些bundle。不管是false还是

    true，最终体现的是性能和开销上的差别。

 

    但是，如果Component的类型是Immediate Component或者Factory Component时，它的值不能是true，否则

    XML会出现语法错误。个人以为之所以这样是因为Immediate Component

 

② provide元素

    这个元素可以有一个或多个，它有一个属性：

    interface -- 实现的接口的名称，必须是类的全称，如org.zqc.pig。大多数情况下，它的值应该是一个接口，但也可以

    是一个具体的类。

   

    如果存在多个provide元素提供多个接口，Component实现类必须实现所有接口。

    如，一个Component实现Event Handler service：

    <service>
        <provide interface="org.osgi.service.eventadmin.EventHandler"/>
    </service>

 

 

5、Reference元素

这个元素描述了Component的依赖项，通常是其他Component提供的服务。如果依赖项不具备，Component configuration将无法满足激活条件。

 

Reference元素有以下几个属性：
（1）name

Reference元素的名称，可选属性，名称必须是唯一的，默认值是Reference元素另外一个属性interface的值。ComponentContext的locateService方法会使用这个名称查找Component引用的服务。如果存在多个Reference元素，而且interface属性的值都是相同的，这会导致Reference元素名称的冲突，这种情况下应该为每个Reference元素指定一个名称。

 

（2）interface

完整类名（包括包名）。Component通过它访问依赖的服务。

 

（3）cardinality

指定引用的服务是否是可选的，以及需要几个这样的服务。它的值有4种：

0..1 – Optional and unary.
1..1 – Mandatory and unary (Default) .
0..n – Optional and multiple.
1..n – Mandatory and multiple.

 

例如，如果系统中存在多个Log Service，那么我们只需引用一个Log Service实现打印日志就可以了，那么cardinality的值就可以是0..1。

又如，如果系统中存在多个监听服务，那么某个事件分发服务就需要引用所有的监听服务，以便把事件分发给他们，cardinality值就可以是0..n。

当我们使用Log Service时，如果Log Service不存在或不可用，那么就无法注册资源或者Servlet，所以cardinality的值必须为1..1或1..n，如果条件不满足，这个Component就不会工作。

但是，如果指定了cardinality为0..1或1..1，系统中又存在多个这样的服务，如有多个Log Service，怎么办呢，这时候系统会从中挑选一个service.ranking值最小的那个，如果service.ranking值也一样，就再去比较他们的service.id值，即他们的start level，取最靠前的那个。

 

 

（4）policy

一旦Component引用的所有服务都OK了，就可以激活这个Component。但是，可能会出现这种情况，就是激活Component后，它引用的某个服务被重新注册、修改、删除了，那么出现这种情况该如何处理呢？这时候就可以指定policy属性，它的值有2种：static和dynamic。

 

①static

如果某个引用的服务A不可用了，Component configuration也会变得不可用。当服务A可用后，Component configuration必须再次激活才能够使用。

如果某个Component引用的服务频繁地注册和注销，或者激活Component configuration的开销很大，又或者cardinality属性指定了multiple，那么static policy是不合适的。

 

②dynamic

这个要复杂点。如果某个引用的服务A不可用了，Component configuration仍然可用。如果使用event strategy访问服务，那么可以在bind和unbind方法中处理这些变化。

 

（5）target

通过指定target属性，开发人员可以过滤掉一些不需要引用的服务。target属性也可以在Property和Properties元素中指定。

 

（6）bind

在Component实现类中定义一个方法，这个方法用于通知此Component，bound service已经绑定到Component configuration。对于static引用，这个方法在activate方法之前被调用。对于dynamic引用，这个方法也可以在component configuration被激活时再调用。

 

（7）unbind

在Component实现类中定义一个方法，这个方法用于通知此Component，绑定到Component configuration。对于static引用已经被注销，这个方法在deactivate方法之后被调用。对于dynamic引用，这个方法也可以在component configuration被注销时再调用。