autobahn javaダウンロード - autobahn javaソースコードのダウンロード

アウトバーン|ジャワ

Java 8 (Netty) および Android 上の WAMP に加えて、Android 用の (安全な) WebSocket を提供するクライアントライブラリ。

Autobahn|Java は Autobahn プロジェクトのサブプロジェクトであり、オープンソースのクライアント実装を提供します。

WebSocket プロトコル
Web アプリケーションメッセージングプロトコル (WAMP)

Android および Netty/Java8/JVM 上で実行されます。

WebSocket レイヤーはコールバックベースのユーザー API を使用しており、特に Android 向けに作成されています。たとえば、メイン (UI) スレッドではネットワーク関連のものは実行されません。

WAMP レイヤーは、WAMP アクション (呼び出し、登録、パブリッシュ、サブスクライブ) に Java 8 CompletableFutureを使用し、WAMP セッション、サブスクリプション、登録ライフサイクルイベントにはオブザーバーパターンを使用します。

このライブラリは MIT ライセンスを受けており、Crossbar.io プロジェクトによって保守され、AutobahnTestsuite を使用してテストされ、Maven には JAR として、Dockerhub には Docker ツールチェーンイメージとして公開されます。

ダウンロード

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

コードを見せてください

デモギャラリーのコードには、アウトバーンライブラリの使用方法の例がいくつか含まれており、便利なメソッドも含まれています。以下は、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 ();
}

アウトバーンはPOJOもサポートしています

パーソン 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 );

人を返すプロシージャも登録します

 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 の場合は、Android Studio の使用をお勧めします。 Android Studio にプロジェクトをインポートするだけで、不足している依存関係があるかどうかが表示されます。依存関係をインストールして、 Build > Rebuild Projectからプロジェクトをビルドするだけです。autobahn autobahn/build/outputs/aar/に aar アーティファクトが保存されます。