首页>编程相关>JAVA源码
下载

高速公路|爪哇

客户端库在 Java 8 (Netty) 和 Android 上提供 WAMP，以及适用于 Android 的（安全）WebSocket。

Autobahn|Java 是 Autobahn 项目的子项目，提供开源客户端实现

  • WebSocket 协议
  • Web 应用程序消息传递协议 (WAMP)

运行在 Android 和 Netty/Java8/JVM 上。

WebSocket 层使用基于回调的用户 API，并且是专门为 Android 编写的。例如，它不在主（UI）线程上运行任何网络内容。

WAMP 层使用 Java 8 CompletableFuture进行 WAMP 操作（调用、注册、发布和订阅），并使用观察者模式进行 WAMP 会话、订阅和注册生命周期事件。

该库获得 MIT 许可，由 Crossbar.io 项目维护，使用 AutobahnTestsuite 进行测试，并作为 JAR 发布到 Maven，并作为 Docker 工具链映像发布到 Dockerhub。

下载

通过 Maven 抓取： 

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

摇篮： 

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

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

入门

演示客户端很容易运行，您只需要安装make和docker即可开始运行。 

 $ make crossbar # Starts crossbar in a docker container
$ make python # Starts a python based WAMP components that provides calls for the Java demo client

最后

 $ make java # Starts the java (Netty) based demo client that performs WAMP actions

显示一些代码

demo-gallery 中的代码包含一些有关如何使用 autobahn 库的示例，还包含使用的便捷方法。下面是一组基本的代码示例，显示了所有 4 个 WAMP 操作。

订阅主题

 public void demonstrateSubscribe ( Session session , SessionDetails details ) {
    // Subscribe to topic to receive its events.
    CompletableFuture < Subscription > subFuture = session . subscribe ( "com.myapp.hello" ,
            this :: onEvent );
    subFuture . whenComplete (( subscription , throwable ) -> {
        if ( throwable == null ) {
            // We have successfully subscribed.
            System . out . println ( "Subscribed to topic " + subscription . topic );
        } else {
            // Something went bad.
            throwable . printStackTrace ();
        }
    });
}

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

由于我们仅访问 onEvent() 中的args ，因此我们可以将其简化为： 

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

发布到主题

 public void demonstratePublish ( Session session , SessionDetails details ) {
    // Publish to a topic that takes a single arguments
    List < Object > args = Arrays . asList ( "Hello World!" , 900 , "UNIQUE" );
    CompletableFuture < Publication > pubFuture = session . publish ( "com.myapp.hello" , args );
    pubFuture . thenAccept ( publication -> System . out . println ( "Published successfully" ));
    // Shows we can separate out exception handling
    pubFuture . exceptionally ( throwable -> {
        throwable . printStackTrace ();
        return null ;
    });
}

一个更简单的调用如下所示： 

 public void demonstratePublish ( Session session , SessionDetails details ) {
    CompletableFuture < Publication > pubFuture = session . publish ( "com.myapp.hello" , "Hi!" );
    ...
}

注册一个程序

 public void demonstrateRegister ( Session session , SessionDetails details ) {
    // Register a procedure.
    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 , Map < String , Object > kwargs , InvocationDetails details ) {
    int res = ( int ) args . get ( 0 ) + ( int ) args . get ( 1 );
    List < Object > arr = new ArrayList <>();
    arr . add ( res );
    return CompletableFuture . completedFuture ( new InvocationResult ( arr ));
}

一个非常精确的add2可能看起来像： 

 private List < Object > add2 ( List < Integer > args , InvocationDetails details ) {
    int res = args . get ( 0 ) + args . get ( 1 );
    return Arrays . asList ( res , details . session . getID (), "Java" );
}

调用一个过程

 public void demonstrateCall ( Session session , SessionDetails details ) {
    // Call a remote procedure.
    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 ))));
}

使用可变数据类型参数调用过程

 public void demonstrateCall ( Session session , SessionDetails details ) {
    // Call a remote procedure.
    byte [] var1 = new byte [ 20 ];
    String var2 = "A sample text" ;
    int var3 = 99 ;
    List < Object > args = new ArrayList <>();
    args . add ( var1 );
    args . add ( var2 );
    args . add ( var3 );
    CompletableFuture < CallResult > callFuture = session . call ( "com.myapp.myproc" , args );
    callFuture . thenAccept ( callResult ->
            System . out . println ( String . format ( "Call result: %s" , callResult . results . get ( 0 ))));
}

连接点

 public void main () {
    // Create a session object
    Session session = new Session ();
    // Add all onJoin listeners
    session . addOnJoinListener ( this :: demonstrateSubscribe );
    session . addOnJoinListener ( this :: demonstratePublish );
    session . addOnJoinListener ( this :: demonstrateCall );
    session . addOnJoinListener ( this :: demonstrateRegister );

    // finally, provide everything to a Client and connect
    Client client = new Client ( session , url , realm );
    CompletableFuture < ExitInfo > exitInfoCompletableFuture = client . connect ();
}

验证

身份验证很简单，我们只需创建所需身份验证器的对象并将其传递给客户端

票证验证

 public void main () {
    ...
    IAuthenticator authenticator = new TicketAuth ( authid , ticket );
    Client client = new Client ( session , url , realm , authenticator );
    CompletableFuture < ExitInfo > exitInfoCompletableFuture = client . connect ();
}

挑战 响应 验证

 public void main () {
    ...
    IAuthenticator authenticator = new ChallengeResponseAuth ( authid , secret );
    Client client = new Client ( session , url , realm , authenticator );
    CompletableFuture < ExitInfo > exitInfoCompletableFuture = client . connect ();
}

加密签名验证

 public void main () {
    ...
    IAuthenticator authenticator = new CryptosignAuth ( authid , privkey , pubkey );
    Client client = new Client ( session , url , realm , authenticator );
    CompletableFuture < ExitInfo > exitInfoCompletableFuture = client . connect ();
}

您还可以提供身份验证器列表

 public void main () {
    ...
    List < IAuthenticator > authenticators = new ArrayList <>();
    authenticators . add ( new TicketAuth ( authid , ticket ));
    authenticators . add ( new CryptosignAuth ( authid , privkey , pubkey ));
    Client client = new Client ( session , url , realm , authenticators );
    CompletableFuture < ExitInfo > exitInfoCompletableFuture = client . connect ();
}

Autobahn 还支持 POJO

以下是如何调用返回 Person POJO 列表的远程过程

 // Call a remote procedure that returns a Person with id 1
CompletableFuture < Person > callFuture = mSession . call ( "com.example.get_person" , 1 );
callFuture . whenCompleteAsync (( person , throwable ) -> {
    if ( throwable != null ) {
        // handle error
    } else {
        // success!
        // do something with person
    }
}, mExecutor );
 // call a remote procedure that returns a List<Person>
CompletableFuture < List < Person >> callFuture = mSession . call (
        // remote procedure to call
        "com.example.get_persons_by_department" ,

        // positional call arguments
        new ArrayList < Object >() { List . of ( "department-7" )},

        // call return type
        new TypeReference < List < Person >>() {}
);

callFuture . whenCompleteAsync (( persons , throwable ) -> {
    if ( throwable != null ) {
        // handle error
    } else {
        // success!
        for ( Person person : persons ) {
            // do something with person
        }
    }
}, mExecutor );

还注册一个返回 Person 的过程

 private Person get_person () {
    return new Person ( "john" , "doe" , "hr" );
}

private void main () {
    CompletableFuture < Registration > regFuture = session . register (
            "io.crossbar.example.get_person" , this :: get_person );
    regFuture . whenComplete (( registration , throwable ) -> {
        System . out . println ( String . format (
                "Registered procedure %s" , registration . procedure ));
    });
}

Android 上的 WebSocket

回声示例

 WebSocketConnection connection = new WebSocketConnection ();
connection . connect ( "wss://echo.websocket.org" , new WebSocketConnectionHandler () {
    @ Override
    public void onConnect ( ConnectionResponse response ) {
        System . out . println ( "Connected to server" );
    }

    @ Override
    public void onOpen () {
        connection . sendMessage ( "Echo with Autobahn" );
    }

    @ Override
    public void onClose ( int code , String reason ) {
        System . out . println ( "Connection closed" );
    }

    @ Override
    public void onMessage ( String payload ) {
        System . out . println ( "Received message: " + payload );
        connection . sendMessage ( payload );
    }
});

从源头构建

建造高速公路非常简单

安卓构建

对于 Android，我们建议使用 Android Studio。只需在 Android Studio 中导入项目，它会告诉您是否缺少任何依赖项，安装它们，然后只需从Build > Rebuild Project构建项目，您将在autobahn/build/outputs/aar/中获得 aar 工件

Netty构建

要为非 Android 系统生成构建，请确保安装了 docker 并 make，然后只需在项目的根目录下使用运行以下命令

make build_autobahn

这将在autobahn/build/libs/中输出 jar 文件。

联系我们

通过加入我们的论坛来取得联系。

版本1

该库的版本 1 仍在此处的存储库中，但不再维护。

版本 1 仅支持 Android 上的非安全 WebSocket，并且仅支持 WAMP v1。

这两个问题都已在 Autobahn|Java 的（当前）版本中得到修复。

展开
附加信息
相关应用
为您推荐
相关资讯 全部