OSGI中的声明性服务

时间:2017-12-06 13:57:34

标签: maven annotations osgi apache-felix declarative-services

我创建了一个(非常)简单的测试来确定如何使用Apache Felix发送和接收事件。

这是我的发件人:

package be.pxl;

import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventAdmin;

import java.util.HashMap;

@Component(name = "be.pxl.Publisher", immediate = true)
public class Publisher {

    EventAdmin admin;

    @Activate
    public void run(Object object) {
        System.out.println("IN PUBLISHER");
        Event event = new Event("event", new HashMap<String, Object>());
        System.out.println("\tEVENT: " + event);
        admin.postEvent(event);
        System.out.println("\tADMIN: " + admin);
    }

    @Reference(name="be.pxl.admin", service = EventAdmin.class)
    protected void setEventAdmin(EventAdmin admin) {
        this.admin = admin;
    }

}

这是我的接收者:

package be.pxl;

import org.osgi.framework.BundleContext;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventConstants;
import org.osgi.service.event.EventHandler;
import java.util.Dictionary;
import java.util.Hashtable;

@Component(name = "be.pxl.Subscriber", immediate = true)
public class Subscriber implements EventHandler {

    private BundleContext context;

    @Activate
    public void run(Object object) {
        System.out.println("IN SUBSCRIBER");
        System.out.println("\tIN RUN METHOD");
        String[] topics = new String[]{"event"};
        Dictionary props = new Hashtable();
        props.put(EventConstants.EVENT_TOPIC, topics);
        System.out.println("\t\tCONTEXT: " + context);
        context.registerService(EventHandler.class.getName(), this, props);
        System.out.println("\t\tCONTEXT AFTER REGISTERSERVICE: " + context);
    }

    public void handleEvent(Event event) {
        System.out.println("IN SUBSCRIBER");
        String text = event.getProperty("text").toString();
        System.out.println("\tEVENT CALLED: " + text);
    }

    @Reference(name="be.pxl.context", service=BundleContext.class)
    protected void setBundleContex(BundleContext context) {
        this.context = context;
    }

}

这是我发件人的pom:

    <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>be.pxl</groupId>
    <artifactId>EventSender</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.service.event</artifactId>
            <version>1.3.1</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
            <version>6.0.0</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.service.component.annotations</artifactId>
            <version>1.3.0</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.eclipse.osgi</groupId>
            <artifactId>org.eclipse.osgi.services</artifactId>
            <version>3.2.100.v20100503</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <version>2.4.0</version>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <Bundle-Vendor>SmartCampus</Bundle-Vendor>
                        <Bundle-SymbolicName>${project.artifactId}</Bundle-SymbolicName>
                        <Export-Package>
                            be.pxl.*;version="1.0.0"
                        </Export-Package>
                        <Import-Package>
                            org.osgi.service.component.annotations
                            org.eclipse.osgi.service
                            org.osgi.core
                            org.osgi.service.event
                        </Import-Package>
                        <_dsannotations>*</_dsannotations>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

一切都很好。我使用mvn clean包创建它,然后我在我的apache felix容器中安装这个jar文件并启动它。然而,没有任何反应。什么都没有得到肯定。

提前致谢!

1 个答案:

答案 0 :(得分:0)

你似乎大部分都在那里!正如您所确定的,Event Admin使用白板模型来接收事件。重要的是你需要告诉白板你要听哪些主题。

%%%更新%%%

事件管理员主题名称使用由/个字符分隔的标记层次结构。将事件发布到特定主题时,例如foo/bar/baz。接收事件时,将调用EventHandler以查找与其注册兴趣相匹配的主题。这些兴趣可以针对特定主题,也可以以*结尾以表示通配符匹配。例如,foo/bar/*会收到发送到foo/bar/baz的事件和发送到foo/bar/fizzbuzz的事件。

%%%返回原来的%%%

但是您的代码存在一些问题:

首先:

@Reference(name="be.pxl.context", service=BundleContext.class)
protected void setBundleContex(BundleContext context) {
    this.context = context;
}

这不是您访问捆绑包的BundleContext的方式。如果确实需要BundleContext,则应将其作为参数注入@Activate带注释的方法中。永远不应该将BundleContext注册为服务(它代表您的bundle对OSGi框架的私有访问权限),并且在您的示例中发现此引用不满意并不会让我感到惊讶。您实际上并不需要BundleContext,因为......

其次:

@Activate
public void run(Object object) {
    System.out.println("IN SUBSCRIBER");
    System.out.println("\tIN RUN METHOD");
    String[] topics = new String[]{"event"};
    Dictionary props = new Hashtable();
    props.put(EventConstants.EVENT_TOPIC, topics);
    System.out.println("\t\tCONTEXT: " + context);
    context.registerService(EventHandler.class.getName(), this, props);
    System.out.println("\t\tCONTEXT AFTER REGISTERSERVICE: " + context);
}

这不是编写activate方法的正确方法(因此可能没有被调用),也不应该在此处将组件注册为服务。当您将班级设为@Component时,它将使用每个直接实现的界面自动注册为服务。这意味着:

@Component(name = "be.pxl.Subscriber", immediate = true)
public class Subscriber implements EventHandler {
    ...
}

已经是OSGi EventHandler服务了!

您可以使用@Component注释向组件添加服务属性,或使用组件属性注释从OSGi R7版本(几个月到期)添加服务属性。在这种情况下,您需要设置event.topics属性,如下所示:

@Component(property="event.topics=event")

如果你愿意,你可以完全摆脱激活方法。

最后:

事件管理员不是邮件队列,您的发布者是一次性发送。因此,如果您的发布者在处理程序完全注册之前发送事件,那么它将永远不会收到该事件。考虑让发布者发送定期事件,或者确定接收者在发布者之前启动,以便您看到该消息。

P.S。

这在技术上不是问题,但我发现你使用的是maven-bundle-plugin版本2.4。这是非常旧,当前发布的bnd版本是3.5.0。 Bnd团队也开始提供你自己想要查看的Maven插件(例如bnd-maven-plugin)。