Autobahn|Java 技术文档

1. 安装指南

Autobahn|Java 可以通过 Maven 或 Gradle 进行安装。

Maven 安装

在 Maven 的 pom.xml 文件中添加以下依赖项：

<dependency>
    <groupId>io.crossbar.autobahn</groupId>
    <artifactId>autobahn-android</artifactId>
    <version>21.7.1</version>
</dependency>

Gradle 安装

在 Gradle 的 build.gradle 文件中添加以下依赖项：

dependencies {
    implementation 'io.crossbar.autobahn:autobahn-android:21.7.1'
}

对于非 Android 系统，使用 artifactID autobahn-java 或直接下载最新的 JAR 文件。

2. 项目的使用说明

Autobahn|Java 项目是一个提供 WAMP（Web Application Messaging Protocol）和 WebSocket 协议的开源客户端实现。以下是如何使用该项目的简要说明。

运行示例客户端

要运行示例客户端，需要安装 make 和 docker。按照以下步骤操作：

$ make crossbar # 在 docker 容器中启动 crossbar
$ make python # 启动基于 python 的 WAMP 组件，为 Java 示例客户端提供服务
$ make java # 启动基于 Java (Netty) 的示例客户端执行 WAMP 操作

示例代码

在 demo-gallery 目录中，包含了一些如何使用 Autobahn 库的示例代码，包括四个基本的 WAMP 操作：订阅、发布、注册和调用。

3. 项目 API 使用文档

以下是一些基本的 API 使用示例：

订阅主题

public void demonstrateSubscribe(Session session, SessionDetails details) {
    CompletableFuture<Subscription> subFuture = session.subscribe("com.myapp.hello", this::onEvent);
    subFuture.whenComplete((subscription, throwable) -> {
        if (throwable == null) {
            System.out.println("Subscribed to topic " + subscription.topic);
        } else {
            throwable.printStackTrace();
        }
    });
}

private void onEvent(List<Object> args) {
    System.out.println(String.format("Got event: %s", args.get(0)));
}

发布到主题

public void demonstratePublish(Session session, SessionDetails details) {
    CompletableFuture<Publication> pubFuture = session.publish("com.myapp.hello", "Hi!");
    pubFuture.thenAccept(publication -> System.out.println("Published successfully"));
}

注册一个过程

public void demonstrateRegister(Session session, SessionDetails details) {
    CompletableFuture<Registration> regFuture = session.register("com.myapp.add2", this::add2);
    regFuture.thenAccept(registration -> System.out.println("Successfully registered procedure: " + registration.procedure));
}

private CompletableFuture<InvocationResult> add2(List<Object> args) {
    int res = (int) args.get(0) + (int) args.get(1);
    List<Object> arr = new ArrayList<>();
    arr.add(res);
    return CompletableFuture.completedFuture(new InvocationResult(arr));
}

调用一个过程

public void demonstrateCall(Session session, SessionDetails details) {
    CompletableFuture<CallResult> callFuture = session.call("com.myapp.add2", 10, 20);
    callFuture.thenAccept(callResult -> System.out.println(String.format("Call result: %s", callResult.results.get(0))));
}

4. 项目安装方式

Autobahn|Java 可以通过以下方式进行安装：

• Maven：在 Maven 的 pom.xml 文件中添加依赖项。
• Gradle：在 Gradle 的 build.gradle 文件中添加依赖项。
• 手动下载：直接从 Maven 仓库下载最新的 JAR 文件。

通过上述方式，用户可以轻松地将 Autobahn|Java 集成到他们的项目中。