OSGi 松耦合最佳实践

Question

我想知道什么是将应用程序代码与框架代码解耦的最佳实践或模式，特别是关于 OSGi。

我将使用 Felix SCR 页面中的示例

示例服务是一个 Comparator

package sample.service;
import java.util.Comparator;
public class SampleComparator implements Comparator
{
    public int compare( Object o1, Object o2 )
    {
        return o1.equals( o2 ) ? 0 : -1;
    }
}

上面的代码不包含框架管道，它集中且简洁。使用 OSGi 时，要使其可供应用程序使用，需要将其注册到服务注册表。正如链接的 Felix 页面上所述，一种方法是使用服务组件运行时。

// OSGI-INF/sample.xml
<?xml version="1.0" encoding="UTF-8"?>
<component name="sample.component" immediate="true">
  <implementation class="sample.service.SampleComparator" />
  <property name="service.description" value="Sample Comparator Service" />
  <property name="service.vendor" value="Apache Software Foundation" />
  <service>
    <provide interface="java.util.Comparator" />
  </service>
</component>

一切都

Service-Component: OSGI-INF/sample.xml

很好，我的服务实现与 OSGI 完全没有耦合。

现在我想使用该服务...

package sample.consumer;
import java.util.Comparator;
public class Consumer {
    public void doCompare(Object o1, Object o2) {
        Comparator c = ...;
    }
}

使用 SCR 查找策略，我需要添加仅框架方法：

protected void activate(ComponentContext context) {
    Comparator c = ( Comparator ) context.locateService( "sample.component" );
}

使用 SCR 事件策略，我还需要添加仅框架方法：

protected void bindComparator(Comparator c) {
    this.c = c;
}

protected void unbindComparator(Comparator c) {
    this.c = null;
}

两者都不是非常繁重，尽管我认为您可能会最终会在类中重复相当多的此类代码，这使得过滤时产生更多噪音。

我看到的一种可能的解决方案是使用 OSGi 特定类通过更传统的方式在消费者和框架之间进行调解。

package sample.internal;
public class OsgiDependencyInjector {
    private Consumer consumer;
    protected void bindComparator(Comparator c) {
        this.consumer.setComparator(c);
    }

    protected void unbindComparator(Comparator c) {
        this.consumer.setComparator(null);
    }
}

尽管我不确定您如何在 SCR 配置中进行安排。

还有 org.apache.felix.scr.annotations，但这意味着只有在使用 maven-scr-plugin 构建时它才有效。确实没那么糟糕，而且，AFAICT，它们不会对运行时产生影响。

那么，现在您已经阅读了所有内容，您建议使用 OSGi 提供的服务而不用框架代码“污染”应用程序代码的最佳方式是什么？

Answer 1

1）我不认为绑定方法会污染你的代码，它们只是bean设置器（你也可以将它们称为setXXX，更传统）。您还需要这些来进行单元测试。

2）如果你使用bnd（在maven、ant、bndtools、eclipse插件等中）那么你也可以使用bnd注释。然后 bnd 会自动为你创建（总是可怕的）xml。

package sample.service;
import java.util.Comparator;
import aQute.bnd.annotations.component.*;

@Component
public class SampleComparator implements Comparator {
    public int compare( Object o1, Object o2 ) {
        return o1.equals( o2 ) ? 0 : -1;
    }
}

@Component
class Consumer {
    Comparator comparator;

    public void doCompare( Object o1, Object o2 ) {
      if ( comparator.compare(o1,o2) ) 
        ....
    }

    @Reference
    protected setComparator( Comparator c ) {
       comparator = c;
    }
}

在您的清单中，只需添加：

Service-Component: *

这将由 bnd 拾取。因此您的域代码中没有 OSGi 代码。您可能会感到困惑，没有 unset 方法，但 bnd 的默认值是静态绑定。因此，在激活之前会调用 set 方法，并且在调用 unset 之前会先停用 set 方法。只要您的 Consumer 对象也是 µservice，您就是安全的。看看 bndtools，bnd 主页，以及我的博客，了解有关 µservices 的更多信息。

附言。您的示例是无效代码，因为如果 o1 != o2，o1 将回答大于和小于 o2，这是比较器合约不允许的，并且会使排序不稳定。

Answer 2

我会写信告诉你我们在我的项目中是如何做到这一点的。作为 OSGi 容器，我们使用 Fuse ESB，尽管可以在 Apache Karaf 中找到。为了不污染我们的代码，我们使用 Spring DM (http://www.springsource.org/osgi)，它极大地方便了与 OSGi 容器的交互。它“作为我们持续集成过程的一部分”（最新版本）针对 Equinox 3.2.x、Felix 1.0.3+ 和 Knopflerfish 2.1.x 进行了测试。

这种方法的优点：

• xml 文件中的所有“osgi”配置 - 代码不受污染
• 能够与 OSGi 容器的不同实现一起工作

它看起来怎么样？

• OSGi 注册表中的发布服务：

< osgi:服务 id="some-id"
ref =“bean-implementing-service-to-expose”接口=“interface-of-your-service”
>>

• 从 OSGi 注册表导入服务：

< osgi:reference id=“bean-id”接口=“interface-of-expose-service”/>

此外，为了创建有效的 OSGi 包，我们使用 maven-bundle-plugin。

Answer 3

与 aQute.bnd.annotations.component 中的注释相比，felix 注释的优点似乎是由 felix scr 插件自动创建绑定和取消绑定方法（您可以注释私有字段）。 felix 插件的缺点是它作用于 Java 源代码，因此不适用于用其他语言（例如 scala）创建的类文件。